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 org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.ear.util.JavaEEVersion;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.codehaus.plexus.configuration.PlexusConfiguration;
import org.codehaus.plexus.configuration.PlexusConfigurationException;
import org.codehaus.plexus.util.FileUtils;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
/**
* Generates the EAR deployment descriptor file(s).
*
* @author <a href="snicoll@apache.org">Stephane Nicoll</a>
* @version $Id: GenerateApplicationXmlMojo.java 1377814 2012-08-27 20:08:01Z snicoll $
*/
@Mojo( name = "generate-application-xml", defaultPhase = LifecyclePhase.GENERATE_RESOURCES, threadSafe = true,
requiresDependencyResolution = ResolutionScope.TEST )
public class GenerateApplicationXmlMojo
extends AbstractEarMojo
{
public static final String DEFAULT = "DEFAULT";
public static final String EMPTY = "EMPTY";
public static final String NONE = "NONE";
/**
* Whether the application.xml should be generated or not.
*/
@Parameter( defaultValue = "true" )
private Boolean generateApplicationXml = Boolean.TRUE;
/**
* Whether a module ID should be generated if none is specified.
*/
@Parameter( defaultValue = "false" )
private Boolean generateModuleId = Boolean.FALSE;
/**
* Application name of the application to be used when the application.xml
* file is auto-generated. Since JavaEE6.
*/
@Parameter
private String applicationName;
/**
* Display name of the application to be used when the application.xml
* file is auto-generated.
*/
@Parameter( defaultValue = "${project.artifactId}" )
private String displayName;
/**
* Description of the application to be used when the application.xml
* file is auto-generated.
*/
@Parameter( defaultValue = "${project.description}" )
private String description;
/**
* Defines how the <tt>library-directory</tt> element should be written in the application.xml file.
* <p/>
* Three special values can be set:
* <ul>
* <li><code>DEFAULT</code> (default) generates a <tt>library-directory</tt> element with
* the value of the <tt>defaultLibBundleDir</tt> parameter</li>
* <li><code>EMPTY</code> generates an empty <tt>library-directory</tt> element. Per spec, this disables
* the scanning of jar files in the <tt>lib</tt> directory of the ear file</li>
* <li><code>NONE</code> does not write the library-directory element at all. A corner case that can
* be used in Oracle Weblogic to delegate the classloading to the container</li>
* </ul>
* <p/>
* Since JavaEE5.
*/
@Parameter( defaultValue = DEFAULT )
private String libraryDirectoryMode;
/**
* Defines the value of the initialize in order element to be used when
* the application.xml file is auto-generated. When set to true, modules
* must be initialized in the order they're listed in this deployment descriptor,
* with the exception of application client modules, which can be
* initialized in any order. If initialize-in-order is not set or set to
* false, the order of initialization is unspecified and may be
* product-dependent. Since JavaEE6.
*/
@Parameter
private Boolean initializeInOrder;
/**
* The security-roles to be added to the auto-generated
* application.xml file.
*/
@Parameter
private PlexusConfiguration security;
/**
* The env-entries to be added to the auto-generated
* application.xml file. Since JavaEE6.
*/
@Parameter( alias = "env-entries" )
private PlexusConfiguration envEntries;
public void execute()
throws MojoExecutionException, MojoFailureException
{
// Initializes ear modules
super.execute();
// Handle application.xml
if ( !generateApplicationXml.booleanValue() )
{
getLog().debug( "Generation of application.xml is disabled" );
}
else
{
final JavaEEVersion javaEEVersion = JavaEEVersion.getJavaEEVersion( version );
// Generate deployment descriptor and copy it to the build directory
getLog().info( "Generating application.xml" );
try
{
generateStandardDeploymentDescriptor( javaEEVersion );
}
catch ( EarPluginException e )
{
throw new MojoExecutionException( "Failed to generate application.xml", e );
}
try
{
FileUtils.copyFileToDirectory( new File( generatedDescriptorLocation, "application.xml" ),
new File( getWorkDirectory(), "META-INF" ) );
}
catch ( IOException e )
{
throw new MojoExecutionException( "Unable to copy application.xml to final destination", e );
}
}
// Handle jboss-app.xml
if ( getJbossConfiguration() == null )
{
getLog().debug( "Generation of jboss-app.xml is disabled" );
return;
}
else
{
// Generate deployment descriptor and copy it to the build directory
getLog().info( "Generating jboss-app.xml" );
try
{
generateJbossDeploymentDescriptor();
}
catch ( EarPluginException e )
{
throw new MojoExecutionException( "Failed to generate jboss-app.xml", e );
}
try
{
FileUtils.copyFileToDirectory( new File( generatedDescriptorLocation, "jboss-app.xml" ),
new File( getWorkDirectory(), "META-INF" ) );
}
catch ( IOException e )
{
throw new MojoExecutionException( "Unable to copy jboss-app.xml to final destination", e );
}
}
}
/**
* Generates the deployment descriptor.
*/
protected void generateStandardDeploymentDescriptor( JavaEEVersion javaEEVersion )
throws EarPluginException
{
File outputDir = new File( generatedDescriptorLocation );
if ( !outputDir.exists() )
{
outputDir.mkdirs();
}
File descriptor = new File( outputDir, "application.xml" );
final ApplicationXmlWriter writer = new ApplicationXmlWriter( javaEEVersion, encoding, generateModuleId );
final ApplicationXmlWriterContext context =
new ApplicationXmlWriterContext( descriptor, getModules(), buildSecurityRoles(), buildEnvEntries(),
displayName, description, getActualLibraryDirectory(), applicationName,
initializeInOrder );
writer.write( context );
}
/**
* Generates the jboss deployment descriptor.
*/
protected void generateJbossDeploymentDescriptor()
throws EarPluginException
{
File outputDir = new File( generatedDescriptorLocation );
if ( !outputDir.exists() )
{
outputDir.mkdirs();
}
File descriptor = new File( outputDir, "jboss-app.xml" );
JbossAppXmlWriter writer = new JbossAppXmlWriter( encoding );
writer.write( descriptor, getJbossConfiguration(), getModules() );
}
/**
* Builds the security roles based on the configuration.
*
* @return a list of SecurityRole object(s)
* @throws EarPluginException if the configuration is invalid
*/
private List<SecurityRole> buildSecurityRoles()
throws EarPluginException
{
final List<SecurityRole> result = new ArrayList<SecurityRole>();
if ( security == null )
{
return result;
}
try
{
final PlexusConfiguration[] securityRoles = security.getChildren( SecurityRole.SECURITY_ROLE );
for ( int i = 0; i < securityRoles.length; i++ )
{
PlexusConfiguration securityRole = securityRoles[i];
final String id = securityRole.getAttribute( SecurityRole.ID_ATTRIBUTE );
final String roleName = securityRole.getChild( SecurityRole.ROLE_NAME ).getValue();
final String roleNameId =
securityRole.getChild( SecurityRole.ROLE_NAME ).getAttribute( SecurityRole.ID_ATTRIBUTE );
final String description = securityRole.getChild( SecurityRole.DESCRIPTION ).getValue();
final String descriptionId =
securityRole.getChild( SecurityRole.DESCRIPTION ).getAttribute( SecurityRole.ID_ATTRIBUTE );
if ( roleName == null )
{
throw new EarPluginException( "Invalid security-role configuration, role-name could not be null." );
}
else
{
result.add( new SecurityRole( roleName, roleNameId, id, description, descriptionId ) );
}
}
return result;
}
catch ( PlexusConfigurationException e )
{
throw new EarPluginException( "Invalid security-role configuration", e );
}
}
/**
* Builds the env-entries based on the configuration.
*
* @return a list of EnvEntry object(s)
* @throws EarPluginException if the configuration is invalid
*/
private List<EnvEntry> buildEnvEntries()
throws EarPluginException
{
final List<EnvEntry> result = new ArrayList<EnvEntry>();
if ( envEntries == null )
{
return result;
}
try
{
final PlexusConfiguration[] allEnvEntries = envEntries.getChildren( EnvEntry.ENV_ENTRY );
for ( PlexusConfiguration envEntry : allEnvEntries )
{
final String description = envEntry.getChild( EnvEntry.DESCRIPTION ).getValue();
final String envEntryName = envEntry.getChild( EnvEntry.ENV_ENTRY_NAME ).getValue();
final String envEntryType = envEntry.getChild( EnvEntry.ENV_ENTRY_TYPE ).getValue();
final String envEntryValue = envEntry.getChild( EnvEntry.ENV_ENTRY_VALUE ).getValue();
try
{
result.add( new EnvEntry( description, envEntryName, envEntryType, envEntryValue ) );
}
catch ( IllegalArgumentException e )
{
throw new EarPluginException( "Invalid env-entry [" + envEntry + "]", e );
}
}
return result;
}
catch ( PlexusConfigurationException e )
{
throw new EarPluginException( "Invalid env-entry configuration", e );
}
}
/**
* Returns the value to use for the <tt>library-directory</tt> element, based on the library directory mode.
*/
private String getActualLibraryDirectory()
throws EarPluginException
{
final String mode = libraryDirectoryMode == null ? DEFAULT : libraryDirectoryMode.toUpperCase();
if ( DEFAULT.equals( mode ) )
{
return defaultLibBundleDir;
}
else if ( EMPTY.equals( mode ) )
{
return "";
}
else if ( NONE.equals( mode ) )
{
return null;
}
else
{
throw new EarPluginException(
"Unsupported library directory mode [" + libraryDirectoryMode + "] Supported modes " +
( Arrays.asList( DEFAULT, EMPTY, NONE ) ) );
}
}
}