Package org.glassfish.deployment.common
Class ModuleDescriptor<T extends RootDeploymentDescriptor>
- java.lang.Object
-
- java.util.Observable
-
- org.glassfish.deployment.common.DynamicAttributesDescriptor
-
- org.glassfish.deployment.common.Descriptor
-
- org.glassfish.deployment.common.ModuleDescriptor<T>
-
- All Implemented Interfaces:
Serializable
public class ModuleDescriptor<T extends RootDeploymentDescriptor> extends Descriptor
This class describes a module information for an application module- Version:
- Author:
- Jerome Dochez
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.glassfish.deployment.common.Descriptor
DESCRIPTION_CHANGED, DESCRIPTOR_CHANGED, docType, LARGE_ICON_CHANGED, NAME_CHANGED, SMALL_ICON_CHANGED
-
-
Constructor Summary
Constructors Constructor Description ModuleDescriptor()
Creates new ModuleDescriptor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getAlternateDescriptor()
String
getArchiveUri()
String
getContextRoot()
T
getDescriptor()
Manifest
getManifest()
String
getModuleName()
Returns the value of the module-name element in the application.xml if it's defined.ArchiveType
getModuleType()
Iterator
getWebDeploymentExtensions()
boolean
isStandalone()
void
print(StringBuilder toStringBuilder)
A String representation of this object.void
setAlternateDescriptor(String altDD)
Sets the path to the alternate deployment descriptors in the application archivevoid
setArchiveUri(String path)
Sets the archive uri as defined in the application xml or the full archive path for standalone modulesvoid
setContextRoot(String contextRoot)
Sets the context root for Web modulevoid
setDescriptor(T descriptor)
Sets theBundleDescriptor
descriptor for this modulevoid
setManifest(Manifest m)
Sets theManifest
information for this modulevoid
setModuleName(String moduleName)
Sets the module namevoid
setModuleType(ArchiveType type)
void
setStandalone(boolean standalone)
Sets the standalone flag-
Methods inherited from class org.glassfish.deployment.common.Descriptor
addDescriptorExtension, addPrefixMapping, createUniqueFilenameAmongst, createUniqueNameAmongst, createUniqueNameAmongstNamedDescriptors, fillDocType, getDeploymentExtensions, getDescription, getDescriptorExtension, getDescriptorExtensions, getDisplayName, getDocType, getLargeIconUri, getLocalizedDescription, getLocalizedDescriptions, getLocalizedDisplayName, getLocalizedDisplayNames, getLocalizedLargeIconUri, getLocalizedLargeIconUris, getLocalizedSmallIconUri, getLocalizedSmallIconUris, getName, getPrefixMapping, getSmallIconUri, isBoundsChecking, setBoundsChecking, setDescription, setDisplayName, setLargeIconUri, setLocalizedDescription, setLocalizedDisplayName, setLocalizedLargeIconUri, setLocalizedSmallIconUri, setName, setSmallIconUri, visit
-
Methods inherited from class org.glassfish.deployment.common.DynamicAttributesDescriptor
addExtraAttribute, getExtraAttribute, getExtraAttributes, removeExtraAttribute, toString
-
Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged
-
-
-
-
Method Detail
-
setModuleType
public void setModuleType(ArchiveType type)
-
getModuleType
public ArchiveType getModuleType()
- Returns:
- the module type for this module
-
setArchiveUri
public void setArchiveUri(String path)
Sets the archive uri as defined in the application xml or the full archive path for standalone modules
-
getArchiveUri
public String getArchiveUri()
- Returns:
- the archive uri for this module
-
setAlternateDescriptor
public void setAlternateDescriptor(String altDD)
Sets the path to the alternate deployment descriptors in the application archive- Parameters:
altDD
- the uri for the deployment descriptors
-
getAlternateDescriptor
public String getAlternateDescriptor()
- Returns:
- the alternate deployment descriptor path or null if this module does not use alternate deployment descriptors
-
setDescriptor
public void setDescriptor(T descriptor)
Sets theBundleDescriptor
descriptor for this module- Parameters:
descriptor
- the module descriptor
-
getDescriptor
public T getDescriptor()
- Returns:
- the see
BundleDescriptor
module descriptor
-
setContextRoot
public void setContextRoot(String contextRoot)
Sets the context root for Web module- Parameters:
contextRoot
- the contextRoot
-
getContextRoot
public String getContextRoot()
- Returns:
- the context root for a web module
-
getModuleName
public String getModuleName()
Returns the value of the module-name element in the application.xml if it's defined. The default module name is the pathname of the module in the ear file with any filename extension (.jar, .war, .rar) removed, but with any directory names included.- Returns:
- the module of this application
-
setModuleName
public void setModuleName(String moduleName)
Sets the module name- Parameters:
moduleName
- the module name of this application
-
getManifest
public Manifest getManifest()
- Returns:
- the @see Manifest manifest information for this module
-
isStandalone
public boolean isStandalone()
- Returns:
- true if this module is a standalone module
-
setStandalone
public void setStandalone(boolean standalone)
Sets the standalone flag
-
getWebDeploymentExtensions
public Iterator getWebDeploymentExtensions()
- Returns:
- an iterator on the deployment-extension
-
print
public void print(StringBuilder toStringBuilder)
Description copied from class:Descriptor
A String representation of this object.- Overrides:
print
in classDescriptor
-
-