org.apache.geronimo.j2ee.deployment
Class Module

java.lang.Object
  org.apache.geronimo.j2ee.deployment.Module

Direct Known Subclasses:

AppClientModule, ApplicationInfo, ConnectorModule, EJBModule, WebModule

public abstract class Module
extends Object

Field Summary

protected Map

sharedContext

Constructor Summary

protected

Module(boolean standAlone, AbstractName moduleName, Environment environment, JarFile moduleFile, String targetPath, org.apache.xmlbeans.XmlObject specDD, org.apache.xmlbeans.XmlObject vendorDD, String originalSpecDD, String namespace, AnnotatedApp annotatedApp)

Method Summary

void	close()
boolean	equals(Object obj)
AnnotatedApp	getAnnotatedApp()
org.apache.xbean.finder.ClassFinder	getClassFinder()
Artifact[]	getConfigId()
EARContext	getEarContext()
Environment	getEnvironment()
JarFile	getModuleFile()
AbstractName	getModuleName()
URI	getModuleURI()
String	getName()
String	getNamespace()
String	getOriginalSpecDD()
String	getRelativePath(String path) Given a path in the ear module, return something that will resolve to that location against the eventual configuration base uri.
EARContext	getRootEarContext()
Map	getSharedContext()
org.apache.xmlbeans.XmlObject	getSpecDD()
String	getTargetPath()
URI	getTargetPathURI()
abstract ConfigurationModuleType	getType()
org.apache.xmlbeans.XmlObject	getVendorDD()
int	hashCode()
boolean	isStandAlone()
void	setAnnotatedApp(AnnotatedApp annotatedApp)
void	setClassFinder(org.apache.xbean.finder.ClassFinder classFinder)
void	setEarContext(EARContext earContext)
void	setOriginalSpecDD(String originalSpecDD)
void	setRootEarContext(EARContext rootEarContext)
void	setSpecDD(org.apache.xmlbeans.XmlObject specDD)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

sharedContext

protected final Map sharedContext

Constructor Detail

Module

protected Module(boolean standAlone,
                 AbstractName moduleName,
                 Environment environment,
                 JarFile moduleFile,
                 String targetPath,
                 org.apache.xmlbeans.XmlObject specDD,
                 org.apache.xmlbeans.XmlObject vendorDD,
                 String originalSpecDD,
                 String namespace,
                 AnnotatedApp annotatedApp)

Method Detail

getType

public abstract ConfigurationModuleType getType()

getName

public String getName()

isStandAlone

public boolean isStandAlone()

getModuleName

public AbstractName getModuleName()

getEnvironment

public Environment getEnvironment()

getModuleURI

public URI getModuleURI()

getModuleFile

public JarFile getModuleFile()

getTargetPath

public String getTargetPath()

getTargetPathURI

public URI getTargetPathURI()

getSpecDD

public org.apache.xmlbeans.XmlObject getSpecDD()

getVendorDD

public org.apache.xmlbeans.XmlObject getVendorDD()

getOriginalSpecDD

public String getOriginalSpecDD()

getNamespace

public String getNamespace()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

close

public void close()

getEarContext

public EARContext getEarContext()

setEarContext

public void setEarContext(EARContext earContext)

getRootEarContext

public EARContext getRootEarContext()

setRootEarContext

public void setRootEarContext(EARContext rootEarContext)

getSharedContext

public Map getSharedContext()

setSpecDD

public void setSpecDD(org.apache.xmlbeans.XmlObject specDD)

setOriginalSpecDD

public void setOriginalSpecDD(String originalSpecDD)

getAnnotatedApp

public AnnotatedApp getAnnotatedApp()

setAnnotatedApp

public void setAnnotatedApp(AnnotatedApp annotatedApp)

getClassFinder

public org.apache.xbean.finder.ClassFinder getClassFinder()

setClassFinder

public void setClassFinder(org.apache.xbean.finder.ClassFinder classFinder)

getConfigId

public Artifact[] getConfigId()

getRelativePath

public String getRelativePath(String path)

Given a path in the ear module, return something that will resolve to that location against the eventual configuration base uri. Currently for all modules except wars that is the original path. If we create separate configurations for ejb or rar modules, those Module subclasses will need to reimplement this method. Example: if a war is myweb.war, and you pass in myweb.war/WEB-INF/lib/foo.jar, you get WEB-INF/lib/foo.jar if you pass in myFoo.jar, you get ../myFoo.jar

Parameters:

path - a path in the ear config, relative to the ear root.

Returns:

a path to the same location, but relative to the configuration this module represents' base uri.