| package org.apache.maven.plugin.ear; |
| |
| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| |
| import java.io.File; |
| import java.util.ArrayList; |
| import java.util.List; |
| import java.util.Set; |
| |
| import org.apache.maven.artifact.Artifact; |
| import org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter; |
| import org.apache.maven.plugin.AbstractMojo; |
| import org.apache.maven.plugin.MojoExecutionException; |
| import org.apache.maven.plugin.MojoFailureException; |
| import org.apache.maven.plugin.ear.util.ArtifactTypeMappingService; |
| import org.apache.maven.plugin.ear.util.JavaEEVersion; |
| import org.apache.maven.plugins.annotations.Parameter; |
| import org.apache.maven.project.MavenProject; |
| import org.codehaus.plexus.configuration.PlexusConfiguration; |
| import org.codehaus.plexus.configuration.PlexusConfigurationException; |
| |
| /** |
| * A base class for EAR-processing related tasks. |
| * |
| * @author <a href="snicoll@apache.org">Stephane Nicoll</a> |
| * @version $Id$ |
| */ |
| public abstract class AbstractEarMojo |
| extends AbstractMojo |
| { |
| public static final String APPLICATION_XML_URI = "META-INF/application.xml"; |
| |
| public static final String META_INF = "META-INF"; |
| |
| public static final String UTF_8 = "UTF-8"; |
| |
| /** |
| * The version of the application.xml to generate. Valid values are 1.3, 1.4, 5, 6 and 7. |
| */ |
| @Parameter( defaultValue = "1.3" ) |
| protected String version; |
| |
| /** |
| * Character encoding for the auto-generated deployment file(s). |
| */ |
| @Parameter( defaultValue = "UTF-8" ) |
| protected String encoding; |
| |
| /** |
| * Directory where the deployment descriptor file(s) will be auto-generated. |
| */ |
| @Parameter( defaultValue = "${project.build.directory}" ) |
| protected String generatedDescriptorLocation; |
| |
| /** |
| * The maven project. |
| */ |
| @Parameter( defaultValue = "${project}", readonly = true, required = true ) |
| protected MavenProject project; |
| |
| /** |
| * The ear modules configuration. |
| */ |
| @Parameter |
| private EarModule[] modules; |
| |
| /** |
| * The artifact type mappings. |
| */ |
| @Parameter |
| protected PlexusConfiguration artifactTypeMappings; |
| |
| /** |
| * The default bundle dir for libraries. |
| */ |
| @Parameter( alias = "defaultJavaBundleDir" ) |
| protected String defaultLibBundleDir; |
| |
| /** |
| * Should libraries be added in application.xml |
| */ |
| @Parameter( defaultValue = "false" ) |
| private Boolean includeLibInApplicationXml = Boolean.FALSE; |
| |
| /** |
| * The file name mapping to use for all dependencies included in the EAR file. |
| */ |
| @Parameter |
| private String fileNameMapping; |
| |
| /** |
| * When using a {@link #fileNameMapping} with versions, either use the {@code baseVersion} or the {@code version}. |
| * When the artifact is a SNAPSHOT, {@code version} will always return a value with a {@code -SNAPSHOT} postfix |
| * instead of the possible timestamped value. |
| * |
| * @since 2.9 |
| */ |
| @Parameter |
| private Boolean useBaseVersion; |
| |
| /** |
| * Directory that resources are copied to during the build. |
| */ |
| @Parameter( defaultValue = "${project.build.directory}/${project.build.finalName}", required = true ) |
| private File workDirectory; |
| |
| /** |
| * The JBoss specific configuration. |
| * |
| * @parameter |
| */ |
| @Parameter |
| private PlexusConfiguration jboss; |
| |
| /** |
| * The id to use to define the main artifact (e.g. the artifact without a classifier) when there is multiple |
| * candidates. |
| * |
| * @parameter |
| */ |
| @Parameter |
| private String mainArtifactId = "none"; |
| |
| private List<EarModule> earModules; |
| |
| private List<EarModule> allModules; |
| |
| private JbossConfiguration jbossConfiguration; |
| |
| @SuppressWarnings( "unchecked" ) |
| public void execute() |
| throws MojoExecutionException, MojoFailureException |
| { |
| final JavaEEVersion javaEEVersion = JavaEEVersion.getJavaEEVersion( version ); |
| getLog().debug( "Resolving artifact type mappings ..." ); |
| ArtifactTypeMappingService typeMappingService; |
| try |
| { |
| typeMappingService = new ArtifactTypeMappingService(); |
| typeMappingService.configure( artifactTypeMappings ); |
| } |
| catch ( EarPluginException e ) |
| { |
| throw new MojoExecutionException( "Failed to initialize artifact type mappings", e ); |
| } |
| catch ( PlexusConfigurationException e ) |
| { |
| throw new MojoExecutionException( "Invalid artifact type mappings configuration", e ); |
| } |
| |
| getLog().debug( "Initializing JBoss configuration if necessary ..." ); |
| try |
| { |
| initializeJbossConfiguration(); |
| } |
| catch ( EarPluginException e ) |
| { |
| throw new MojoExecutionException( "Failed to initialize JBoss configuration", e ); |
| } |
| |
| getLog().debug( "Initializing ear execution context" ); |
| EarExecutionContext earExecutionContext = |
| new EarExecutionContext( project, mainArtifactId, defaultLibBundleDir, jbossConfiguration, fileNameMapping, |
| typeMappingService ); |
| |
| if ( useBaseVersion != null ) |
| { |
| earExecutionContext.getFileNameMapping().setUseBaseVersion( useBaseVersion ); |
| } |
| |
| getLog().debug( "Resolving ear modules ..." ); |
| allModules = new ArrayList<EarModule>(); |
| try |
| { |
| if ( modules != null && modules.length > 0 ) |
| { |
| // Let's validate user-defined modules |
| EarModule module; |
| |
| for ( EarModule module1 : modules ) |
| { |
| module = module1; |
| getLog().debug( "Resolving ear module[" + module + "]" ); |
| module.setEarExecutionContext( earExecutionContext ); |
| module.resolveArtifact( project.getArtifacts() ); |
| allModules.add( module ); |
| } |
| } |
| |
| // Let's add other modules |
| Set<Artifact> artifacts = project.getArtifacts(); |
| for ( Artifact artifact : artifacts ) |
| { |
| // If the artifact's type is POM, ignore and continue |
| // since it's used for transitive deps only. |
| if ( "pom".equals( artifact.getType() ) ) |
| { |
| continue; |
| } |
| |
| // Artifact is not yet registered and it has neither test, nor a |
| // provided scope, not is it optional |
| ScopeArtifactFilter filter = new ScopeArtifactFilter( Artifact.SCOPE_RUNTIME ); |
| if ( !isArtifactRegistered( artifact, allModules ) && !artifact.isOptional() |
| && filter.include( artifact ) ) |
| { |
| EarModule module = |
| EarModuleFactory.newEarModule( artifact, javaEEVersion, defaultLibBundleDir, |
| includeLibInApplicationXml, typeMappingService ); |
| module.setEarExecutionContext( earExecutionContext ); |
| allModules.add( module ); |
| } |
| } |
| } |
| catch ( EarPluginException e ) |
| { |
| throw new MojoExecutionException( "Failed to initialize ear modules", e ); |
| } |
| |
| // Now we have everything let's built modules which have not been excluded |
| earModules = new ArrayList<EarModule>(); |
| for ( EarModule earModule : allModules ) |
| { |
| if ( earModule.isExcluded() ) |
| { |
| getLog().debug( "Skipping ear module[" + earModule + "]" ); |
| } |
| else |
| { |
| earModules.add( earModule ); |
| } |
| } |
| |
| } |
| |
| protected List<EarModule> getModules() |
| { |
| if ( earModules == null ) |
| { |
| throw new IllegalStateException( "Ear modules have not been initialized" ); |
| } |
| return earModules; |
| } |
| |
| protected MavenProject getProject() |
| { |
| return project; |
| } |
| |
| protected File getWorkDirectory() |
| { |
| return workDirectory; |
| } |
| |
| protected JbossConfiguration getJbossConfiguration() |
| { |
| return jbossConfiguration; |
| } |
| |
| private static boolean isArtifactRegistered( Artifact a, List<EarModule> currentList ) |
| { |
| for ( EarModule em : currentList ) |
| { |
| if ( em.getArtifact().equals( a ) ) |
| { |
| return true; |
| } |
| } |
| return false; |
| } |
| |
| /** |
| * Initializes the JBoss configuration. |
| * |
| * @throws EarPluginException if the configuration is invalid |
| */ |
| private void initializeJbossConfiguration() |
| throws EarPluginException |
| { |
| if ( jboss == null ) |
| { |
| jbossConfiguration = null; |
| } |
| else |
| { |
| try |
| { |
| String version = jboss.getChild( JbossConfiguration.VERSION ).getValue(); |
| if ( version == null ) |
| { |
| getLog().info( "JBoss version not set, using JBoss 4 by default" ); |
| version = JbossConfiguration.VERSION_4; |
| } |
| final String securityDomain = jboss.getChild( JbossConfiguration.SECURITY_DOMAIN ).getValue(); |
| final String unauthenticatedPrincipal = |
| jboss.getChild( JbossConfiguration.UNAUHTHENTICTED_PRINCIPAL ).getValue(); |
| |
| final PlexusConfiguration loaderRepositoryEl = jboss.getChild( JbossConfiguration.LOADER_REPOSITORY ); |
| final String loaderRepository = loaderRepositoryEl.getValue(); |
| final String loaderRepositoryClass = |
| loaderRepositoryEl.getAttribute( JbossConfiguration.LOADER_REPOSITORY_CLASS_ATTRIBUTE ); |
| final PlexusConfiguration loaderRepositoryConfigEl = |
| jboss.getChild( JbossConfiguration.LOADER_REPOSITORY_CONFIG ); |
| final String loaderRepositoryConfig = loaderRepositoryConfigEl.getValue(); |
| final String configParserClass = |
| loaderRepositoryConfigEl.getAttribute( JbossConfiguration.CONFIG_PARSER_CLASS_ATTRIBUTE ); |
| |
| final String jmxName = jboss.getChild( JbossConfiguration.JMX_NAME ).getValue(); |
| final String moduleOrder = jboss.getChild( JbossConfiguration.MODULE_ORDER ).getValue(); |
| |
| final List<String> dataSources = new ArrayList<String>(); |
| final PlexusConfiguration dataSourcesEl = jboss.getChild( JbossConfiguration.DATASOURCES ); |
| if ( dataSourcesEl != null ) |
| { |
| |
| final PlexusConfiguration[] dataSourcesConfig = |
| dataSourcesEl.getChildren( JbossConfiguration.DATASOURCE ); |
| for ( PlexusConfiguration dataSourceConfig : dataSourcesConfig ) |
| { |
| dataSources.add( dataSourceConfig.getValue() ); |
| |
| } |
| } |
| final String libraryDirectory = jboss.getChild( JbossConfiguration.LIBRARY_DIRECTORY ).getValue(); |
| jbossConfiguration = |
| new JbossConfiguration( version, securityDomain, unauthenticatedPrincipal, jmxName, |
| loaderRepository, moduleOrder, dataSources, libraryDirectory, |
| loaderRepositoryConfig, loaderRepositoryClass, configParserClass ); |
| } |
| catch ( PlexusConfigurationException e ) |
| { |
| throw new EarPluginException( "Invalid JBoss configuration", e ); |
| } |
| } |
| } |
| } |