org.apache.maven.plugin.ear
Class WebModule

java.lang.Object
  extended by org.apache.maven.plugin.ear.AbstractEarModule
      extended by org.apache.maven.plugin.ear.WebModule
All Implemented Interfaces:
EarModule

public class WebModule
extends AbstractEarModule

The EarModule implementation for a Web application module.

Version:
$Id: WebModule.java 332974 2005-11-13 12:42:44Z snicoll $
Author:
Stephane Nicoll

Field Summary
protected static java.lang.String CONTEXT_ROOT_FIELD
           
protected static java.lang.String WEB_MODULE
           
protected static java.lang.String WEB_URI_FIELD
           
 
Fields inherited from class org.apache.maven.plugin.ear.AbstractEarModule
bundleDir, bundleFileName, excluded, MODULE_ELEMENT
 
Constructor Summary
WebModule()
           
WebModule(org.apache.maven.artifact.Artifact a)
           
 
Method Summary
 void appendModule(org.codehaus.plexus.util.xml.XMLWriter writer, java.lang.String version)
          Appends the XML representation of this module.
 java.lang.String getContextRoot()
          Returns the context root to use for the web module.
protected  java.lang.String getType()
          Returns the type associated to the module.
 void resolveArtifact(java.util.Set artifacts, java.lang.String defaultJavaBundleDir)
          Resolves the Artifact represented by the module with the specified execution configuration.
 
Methods inherited from class org.apache.maven.plugin.ear.AbstractEarModule
getArtifact, getArtifactId, getBundleDir, getBundleFileName, getGroupId, getUri, isExcluded, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

WEB_MODULE

protected static final java.lang.String WEB_MODULE
See Also:
Constant Field Values

WEB_URI_FIELD

protected static final java.lang.String WEB_URI_FIELD
See Also:
Constant Field Values

CONTEXT_ROOT_FIELD

protected static final java.lang.String CONTEXT_ROOT_FIELD
See Also:
Constant Field Values
Constructor Detail

WebModule

public WebModule()

WebModule

public WebModule(org.apache.maven.artifact.Artifact a)
Method Detail

appendModule

public void appendModule(org.codehaus.plexus.util.xml.XMLWriter writer,
                         java.lang.String version)
Description copied from interface: EarModule
Appends the XML representation of this module.

Parameters:
writer - the writer to use
version - the version of the application.xml file

resolveArtifact

public void resolveArtifact(java.util.Set artifacts,
                            java.lang.String defaultJavaBundleDir)
                     throws org.apache.maven.plugin.MojoFailureException
Description copied from interface: EarModule
Resolves the Artifact represented by the module with the specified execution configuration.

Specified by:
resolveArtifact in interface EarModule
Overrides:
resolveArtifact in class AbstractEarModule
Parameters:
artifacts - the project's artifacts
defaultJavaBundleDir - the default bundle dir for JavaModule
Throws:
org.apache.maven.plugin.MojoFailureException

getContextRoot

public java.lang.String getContextRoot()
Returns the context root to use for the web module.

Note that this might return null till the artifact has been resolved.

Returns:
the context root

getType

protected java.lang.String getType()
Description copied from class: AbstractEarModule
Returns the type associated to the module.

Specified by:
getType in class AbstractEarModule
Returns:
the artifact's type of the module


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