hk2 4.0.1 · com.sun.enterprise.module.common_impl.DefaultModuleDefinition

Field Summary

Modifier and Type	Field and Description
protected final List<URI>	classPath
protected final List<ModuleDependency>	dependencies
private static final Manifest	EMPTY_MANIFEST
private final String	importPolicy
private final String	lifecyclePolicy
private static final Logger	LOGGER
protected final Attributes	mainAttributes Main attributes section of the manifest.
private final Manifest	manifest
private final ModuleMetadata	metadata Metadata that works like index.
private final String	name
private final String[]	publicPkgs
private final String	version

Constructor Summary

Access	Constructor and Description
public	DefaultModuleDefinition(File location) TO DO need to support a URI constructor
public	DefaultModuleDefinition(File location, Attributes attr)

Method Summary

Modifier and Type	Method and Description
protected String	decorateClassPath(String classpathElement) Extension point to manipulate the classpath element before it's parsed.
public ModuleDependency[]	Returns: the ModuleDependency getDependencies() Implements com.sun.enterprise.module.ModuleDefinition.getDependencies. Returns the list of module dependencies
public String	Returns: the `ImportPolicy` implementation class name getImportPolicyClassName() Implements com.sun.enterprise.module.ModuleDefinition.getImportPolicyClassName. Returns the class name implementing the `ImportPolicy` interface for this module or null if there is no such implementation
public String	Returns: the `LifecyclePolicy` implementation class name getLifecyclePolicyClassName() Implements com.sun.enterprise.module.ModuleDefinition.getLifecyclePolicyClassName. Returns the class name implementing the `LifecyclePolicy` interface for this module or null if there is no such implementation
public URI[]	Returns: the list of URI locations for this module getLocations() Implements com.sun.enterprise.module.ModuleDefinition.getLocations. Returns the list of URI locations forming the classpath for this module.
public Manifest	Returns: never null. getManifest() Implements com.sun.enterprise.module.ModuleDefinition.getManifest. Returns the manifest file from the module's implementation jar file
public ModuleMetadata	getMetadata() Implements com.sun.enterprise.module.ModuleDefinition.getMetadata. Gets the metadata that describes various components and services in this module.
public String	Returns: the name getName() Implements com.sun.enterprise.module.ModuleDefinition.getName. Returns the name of the module
public String[]	Returns: the list of public packages or classes getPublicInterfaces() Implements com.sun.enterprise.module.ModuleDefinition.getPublicInterfaces. Returns the list of classes and packages that have been designated as public interfaces of this module.
public String	Returns: the module's version getVersion() Implements com.sun.enterprise.module.ModuleDefinition.getVersion. Returns the module's version
protected void	parseAttributes(Attributes Main attributes of the manifest. Always non-null. 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.
private boolean	testClassPath(URI uri) Optional error diagnostics performed during the development time to check if the URL pointed by the path actually exists.
public String	toString() Overrides java.lang.Object.toString. Assists debugging.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

classPath	back to summary
protected final List<URI> classPath

dependencies	back to summary
protected final List<ModuleDependency> dependencies

EMPTY_MANIFEST	back to summary
private static final Manifest EMPTY_MANIFEST

importPolicy	back to summary
private final String importPolicy

lifecyclePolicy	back to summary
private final String lifecyclePolicy

LOGGER	back to summary
private static final Logger LOGGER

mainAttributes	back to summary
protected final Attributes mainAttributes Main attributes section of the manifest. Always non-null.

manifest	back to summary
private final Manifest manifest

metadata	back to summary
private final ModuleMetadata metadata Metadata that works like index.

name	back to summary
private final String name

publicPkgs	back to summary
private final String[] publicPkgs

version	back to summary
private final String version

Constructor Detail

DefaultModuleDefinition	back to summary
public DefaultModuleDefinition(File location) throws IOException TO DO need to support a URI constructor

DefaultModuleDefinition	back to summary
public DefaultModuleDefinition(File location, Attributes attr) throws IOException

Method Detail

decorateClassPath back to summary

decorateClassPath	back to summary
protected String decorateClassPath(String classpathElement) Extension point to manipulate the classpath element before it's parsed. See Also `parseClassPath(Attributes, URI)`

protected String decorateClassPath(String classpathElement)

Extension point to manipulate the classpath element before it's parsed.

See Also: parseClassPath(Attributes, URI)

getDependencies	back to summary
public ModuleDependency[] getDependencies() Implements com.sun.enterprise.module.ModuleDefinition.getDependencies. Returns the list of module dependencies Returns:ModuleDependency[] the ModuleDependency

getDependencies

back to summary

public ModuleDependency[] getDependencies()

Implements com.sun.enterprise.module.ModuleDefinition.getDependencies.

Returns the list of module dependencies

Returns:ModuleDependency[]: the ModuleDependency

getImportPolicyClassName back to summary

getImportPolicyClassName	back to summary
public String getImportPolicyClassName() Implements com.sun.enterprise.module.ModuleDefinition.getImportPolicyClassName. Returns the class name implementing the `ImportPolicy` interface for this module or null if there is no such implementation Returns:String the `ImportPolicy` implementation class name

public String getImportPolicyClassName()

Implements com.sun.enterprise.module.ModuleDefinition.getImportPolicyClassName.

Returns the class name implementing the ImportPolicy interface for this module or null if there is no such implementation

Returns:String: the ImportPolicy implementation class name

getLifecyclePolicyClassName back to summary

getLifecyclePolicyClassName	back to summary
public String getLifecyclePolicyClassName() Implements com.sun.enterprise.module.ModuleDefinition.getLifecyclePolicyClassName. Returns the class name implementing the `LifecyclePolicy` interface for this module or null if there is no such implementation Returns:String the `LifecyclePolicy` implementation class name

public String getLifecyclePolicyClassName()

Implements com.sun.enterprise.module.ModuleDefinition.getLifecyclePolicyClassName.

Returns the class name implementing the LifecyclePolicy interface for this module or null if there is no such implementation

Returns:String: the LifecyclePolicy implementation class name

getLocations	back to summary
public URI[] getLocations() Implements com.sun.enterprise.module.ModuleDefinition.getLocations. Returns the list of URI locations forming the classpath for this module. Returns:URI[] the list of URI locations for this module

getLocations

back to summary

public URI[] getLocations()

Implements com.sun.enterprise.module.ModuleDefinition.getLocations.

Returns the list of URI locations forming the classpath for this module.

Returns:URI[]: the list of URI locations for this module

getManifest	back to summary
public Manifest getManifest() Implements com.sun.enterprise.module.ModuleDefinition.getManifest. Returns the manifest file from the module's implementation jar file Returns:Manifest never null.

getManifest

back to summary

public Manifest getManifest()

Implements com.sun.enterprise.module.ModuleDefinition.getManifest.

Returns the manifest file from the module's implementation jar file

Returns:Manifest: never null.

getMetadata

back to summary

public ModuleMetadata getMetadata()

Implements com.sun.enterprise.module.ModuleDefinition.getMetadata.

Doc from com.sun.enterprise.module.ModuleDefinition.getMetadata.

Gets the metadata that describes various components and services in this module.

getName	back to summary
public String getName() Implements com.sun.enterprise.module.ModuleDefinition.getName. Returns the name of the module Returns:String the name

getName

back to summary

public String getName()

Implements com.sun.enterprise.module.ModuleDefinition.getName.

Returns the name of the module

Returns:String: the name

getPublicInterfaces	back to summary
public String[] getPublicInterfaces() Implements com.sun.enterprise.module.ModuleDefinition.getPublicInterfaces. Returns the list of classes and packages that have been designated as public interfaces of this module. Returns:String[] the list of public packages or classes

getPublicInterfaces

back to summary

public String[] getPublicInterfaces()

Implements com.sun.enterprise.module.ModuleDefinition.getPublicInterfaces.

Returns the list of classes and packages that have been designated as public interfaces of this module.

Returns:String[]: the list of public packages or classes

getVersion	back to summary
public String getVersion() Implements com.sun.enterprise.module.ModuleDefinition.getVersion. Returns the module's version Returns:String the module's version

getVersion

back to summary

public String getVersion()

Implements com.sun.enterprise.module.ModuleDefinition.getVersion.

Returns the module's version

Returns:String: the module's version

parseAttributes	back to summary
protected void parseAttributes(Attributes attr) Extensibility point to parse more information from Manifest attributes. Parameters attr:Attributes Main attributes of the manifest. Always non-null.

parseAttributes

back to summary

protected void parseAttributes(Attributes attr)

Extensibility point to parse more information from Manifest attributes.

Parameters

attr:Attributes: Main attributes of the manifest. Always non-null.

parseClassPath	back to summary
protected void parseClassPath(Attributes attr, URI baseURI) throws IOException Parses `Class-Path` from manifest attributes and updates URI list.

testClassPath	back to summary
private boolean testClassPath(URI uri) Optional error diagnostics performed during the development time to check if the URL pointed by the path actually exists.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Assists debugging.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Assists debugging.

public Class DefaultModuleDefinition

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail