org.apache.maven.plugin.ear
Class EarMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugin.ear.AbstractEarMojo
          extended by org.apache.maven.plugin.ear.EarMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class EarMojo
extends AbstractEarMojo

Builds J2EE Enteprise Archive (EAR) files.

Version:
$Id: EarMojo.java 543041 2007-05-31 03:47:52Z snicoll $
Author:
Stephane Nicoll

Field Summary
 
Fields inherited from class org.apache.maven.plugin.ear.AbstractEarMojo
APPLICATION_XML_URI, artifactTypeMappings, encoding, generatedDescriptorLocation, META_INF, project, UTF_8
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
EarMojo()
           
 
Method Summary
 void execute()
           
 java.lang.String getApplicationXml()
           
protected  java.lang.String[] getExcludes()
          Returns a string array of the excludes to be used when assembling/copying the ear.
protected  java.lang.String[] getIncludes()
          Returns a string array of the includes to be used when assembling/copying the ear.
protected  org.codehaus.plexus.archiver.jar.JarArchiver getJarArchiver()
          Returns the JarArchiver implementation used to package the EAR file.
 void setApplicationXml(java.lang.String applicationXml)
           
 void unpack(java.io.File source, java.io.File destDir)
          Unpacks the module into the EAR structure.
 
Methods inherited from class org.apache.maven.plugin.ear.AbstractEarMojo
getJbossConfiguration, getModules, getProject, getWorkDirectory
 
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EarMojo

public EarMojo()
Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException
Specified by:
execute in interface org.apache.maven.plugin.Mojo
Overrides:
execute in class AbstractEarMojo
Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException

getApplicationXml

public java.lang.String getApplicationXml()

setApplicationXml

public void setApplicationXml(java.lang.String applicationXml)

getExcludes

protected java.lang.String[] getExcludes()
Returns a string array of the excludes to be used when assembling/copying the ear.

Returns:
an array of tokens to exclude

getIncludes

protected java.lang.String[] getIncludes()
Returns a string array of the includes to be used when assembling/copying the ear.

Returns:
an array of tokens to include

unpack

public void unpack(java.io.File source,
                   java.io.File destDir)
            throws org.codehaus.plexus.archiver.manager.NoSuchArchiverException,
                   java.io.IOException,
                   org.codehaus.plexus.archiver.ArchiverException
Unpacks the module into the EAR structure.

Parameters:
source - File to be unpacked.
destDir - Location where to put the unpacked files.
Throws:
org.codehaus.plexus.archiver.manager.NoSuchArchiverException
java.io.IOException
org.codehaus.plexus.archiver.ArchiverException

getJarArchiver

protected org.codehaus.plexus.archiver.jar.JarArchiver getJarArchiver()
Returns the JarArchiver implementation used to package the EAR file.

By default the archiver is obtained from the Plexus container.

Returns:
the archiver


Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.