Class JarModule

  • All Implemented Interfaces:
    EarModule
    Direct Known Subclasses:
    EjbClientModule, JavaModule

    public class JarModule
    extends AbstractEarModule
    The EarModule implementation for a non J2EE module such as third party libraries.

    Such module is not incorporated in the generated application.xml but some application servers support it. To include it in the generated deployment descriptor anyway, set the includeInApplicationXml boolean flag.

    This class deprecates JavaModule.

    Version:
    $Id: JarModule.java 1648046 2014-12-27 11:07:02Z khmarbaise $
    • Field Detail

      • includeInApplicationXml

        private java.lang.Boolean includeInApplicationXml
    • Constructor Detail

      • JarModule

        public JarModule()
        Create an instance.
      • JarModule

        public JarModule​(org.apache.maven.artifact.Artifact a,
                         java.lang.String defaultLibBundleDir,
                         java.lang.Boolean includeInApplicationXml)
        Parameters:
        a - Artifact
        defaultLibBundleDir - The default library bundle directory.
        includeInApplicationXml - Include the application xml or not.
    • Method Detail

      • appendModule

        public void appendModule​(org.codehaus.plexus.util.xml.XMLWriter writer,
                                 java.lang.String version,
                                 java.lang.Boolean generateId)
        Appends the XML representation of this module.
        Parameters:
        writer - the writer to use
        version - the version of the application.xml file
        generateId - whether an id should be generated
      • resolveArtifact

        public void resolveArtifact​(java.util.Set<org.apache.maven.artifact.Artifact> artifacts)
                             throws EarPluginException,
                                    org.apache.maven.plugin.MojoFailureException
        Resolves the Artifact represented by the module. Note that the EarExecutionContext might be used to customize further the resolution.
        Specified by:
        resolveArtifact in interface EarModule
        Overrides:
        resolveArtifact in class AbstractEarModule
        Parameters:
        artifacts - the project's artifacts
        Throws:
        EarPluginException - if the artifact could not be resolved
        org.apache.maven.plugin.MojoFailureException - if an unexpected error occurred
      • getType

        public java.lang.String getType()
        Returns the type associated to the module.
        Returns:
        the artifact's type of the module
      • setLibBundleDir

        private void setLibBundleDir​(java.lang.String defaultLibBundleDir)