Class DefaultModuleDefinition
- java.lang.Object
-
- com.sun.enterprise.module.common_impl.DefaultModuleDefinition
-
- All Implemented Interfaces:
ModuleDefinition
- Direct Known Subclasses:
CookedModuleDefinition
public class DefaultModuleDefinition extends Object implements ModuleDefinition
ModuleDefinition
implementation that picks up most of the module properties from the manifest file of the jar, as baked in by the hk2-maven-plugin.- Author:
- Jerome Dochez
-
-
Field Summary
Fields Modifier and Type Field Description protected List<URI>
classPath
protected List<ModuleDependency>
dependencies
protected Attributes
mainAttributes
Main attributes section of the manifest.
-
Constructor Summary
Constructors Constructor Description DefaultModuleDefinition(File location)
TO DO need to support a URI constructorDefaultModuleDefinition(File location, Attributes attr)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected String
decorateClassPath(String classpathElement)
Extension point to manipulate the classpath element before it's parsed.ModuleDependency[]
getDependencies()
Returns the list of module dependenciesString
getImportPolicyClassName()
Returns the class name implementing theImportPolicy
interface for this module or null if there is no such implementationString
getLifecyclePolicyClassName()
Returns the class name implementing theLifecyclePolicy
interface for this module or null if there is no such implementationURI[]
getLocations()
Returns the list of URI locations forming the classpath for this module.Manifest
getManifest()
Returns the manifest file from the module's implementation jar fileModuleMetadata
getMetadata()
Gets the metadata that describes various components and services in this module.String
getName()
Returns the name of the moduleString[]
getPublicInterfaces()
Returns the list of classes and packages that have been designated as public interfaces of this module.String
getVersion()
Returns the module's versionprotected void
parseAttributes(Attributes attr)
Extensibility point to parse more information from Manifest attributes.protected void
parseClassPath(Attributes attr, URI baseURI)
Parses "Class-Path" from manifest attributes and updates URI list.String
toString()
Assists debugging.
-
-
-
Field Detail
-
dependencies
protected final List<ModuleDependency> dependencies
-
mainAttributes
protected final Attributes mainAttributes
Main attributes section of the manifest. Always non-null.
-
-
Constructor Detail
-
DefaultModuleDefinition
public DefaultModuleDefinition(File location) throws IOException
TO DO need to support a URI constructor- Throws:
IOException
-
DefaultModuleDefinition
public DefaultModuleDefinition(File location, Attributes attr) throws IOException
- Throws:
IOException
-
-
Method Detail
-
parseClassPath
protected void parseClassPath(Attributes attr, URI baseURI) throws IOException
Parses "Class-Path" from manifest attributes and updates URI list.- Throws:
IOException
-
decorateClassPath
protected String decorateClassPath(String classpathElement)
Extension point to manipulate the classpath element before it's parsed.- See Also:
parseClassPath(Attributes,URI)
-
parseAttributes
protected void parseAttributes(Attributes attr)
Extensibility point to parse more information from Manifest attributes.- Parameters:
attr
- Main attributes of the manifest. Always non-null.
-
getName
public String getName()
Returns the name of the module- Specified by:
getName
in interfaceModuleDefinition
- Returns:
- the name
-
getPublicInterfaces
public String[] getPublicInterfaces()
Returns the list of classes and packages that have been designated as public interfaces of this module.- Specified by:
getPublicInterfaces
in interfaceModuleDefinition
- Returns:
- the list of public packages or classes
-
getDependencies
public ModuleDependency[] getDependencies()
Returns the list of module dependencies- Specified by:
getDependencies
in interfaceModuleDefinition
- Returns:
- the ModuleDependency
-
getLocations
public URI[] getLocations()
Returns the list of URI locations forming the classpath for this module.- Specified by:
getLocations
in interfaceModuleDefinition
- Returns:
- the list of URI locations for this module
-
getVersion
public String getVersion()
Returns the module's version- Specified by:
getVersion
in interfaceModuleDefinition
- Returns:
- the module's version
-
getImportPolicyClassName
public String getImportPolicyClassName()
Returns the class name implementing theImportPolicy
interface for this module or null if there is no such implementation- Specified by:
getImportPolicyClassName
in interfaceModuleDefinition
- Returns:
- the
ImportPolicy
implementation class name
-
getLifecyclePolicyClassName
public String getLifecyclePolicyClassName()
Returns the class name implementing theLifecyclePolicy
interface for this module or null if there is no such implementation- Specified by:
getLifecyclePolicyClassName
in interfaceModuleDefinition
- Returns:
- the
LifecyclePolicy
implementation class name
-
getManifest
public Manifest getManifest()
Returns the manifest file from the module's implementation jar file- Specified by:
getManifest
in interfaceModuleDefinition
- Returns:
- never null.
-
getMetadata
public ModuleMetadata getMetadata()
Description copied from interface:ModuleDefinition
Gets the metadata that describes various components and services in this module.- Specified by:
getMetadata
in interfaceModuleDefinition
- Returns:
- Always non-null.
-
-