Top Description Methods
com.sun.enterprise.module

public Interface ModuleDefinition

Known Direct Implementers
com.sun.enterprise.module.common_impl.DefaultModuleDefinition, com.sun.enterprise.module.single.ProxyModuleDefinition
Imports
java.net.URI, java.util.jar.Manifest

A module definition contains all information about a module existence, its dependencies and its exported interfaces. This module meta information can be obtained from different sources and format. For instance OSGi modules use the manifest file and so is the glassfish application server. Others can use api or xml file.
Author
Jerome Dochez

Method Summary

Modifier and TypeMethod and Description
public ModuleDependency[]

Returns:

list of dependencies
getDependencies
()

Returns the list of this module's dependencies.

public String

Returns:

Fully qualified class name that's assignable to ImportPolicy, or null if no import policy exists.
getImportPolicyClassName
()

Returns the import policy class name.

public String

Returns:

Fully qualified class name that's assignable to LifecyclePolicy, or null if no import policy exists.
getLifecyclePolicyClassName
()

Returns the lifecycle policy class name.

public URI[]

Returns:

the module's list of implementation jars
getLocations
()

A Module is implemented by one to many jar files.

public Manifest

Returns:

the manifest file
getManifest
()

Returns the manifest file for the main module jar file

public ModuleMetadata

Returns:

Always non-null.
getMetadata
()

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

public String

Returns:

module name
getName
()

Returns the module name, usually this is the same name as the jar file name containing the module's implementation.

public String[]

Returns:

a array of public interfaces
getPublicInterfaces
()

Returns a list of public interfaces for this module.

public String

Returns:

a version number
getVersion
()

Returns the version of this module's implementation

Method Detail

getDependenciesback to summary
public ModuleDependency[] getDependencies()

Returns the list of this module's dependencies. Each dependency must be satisfied at run time for this module to function properly.

Returns:ModuleDependency[]

list of dependencies

getImportPolicyClassNameback to summary
public String getImportPolicyClassName()

Returns the import policy class name. Although the implementation of this policy does not necessary have to implement the ImportPolicy, but could use another interface, it is the responsibility of the associated Repository to invoke that interface when the module is started.

Returns:String

Fully qualified class name that's assignable to ImportPolicy, or null if no import policy exists.

getLifecyclePolicyClassNameback to summary
public String getLifecyclePolicyClassName()

Returns the lifecycle policy class name. Although the implementation of this policy does not necessary have to implement the LifecyclePolicy, but could use another interface, it is the responsibility of the associated Repository to invoke that interface when the module is started.

Returns:String

Fully qualified class name that's assignable to LifecyclePolicy, or null if no import policy exists.

getLocationsback to summary
public URI[] getLocations()

A Module is implemented by one to many jar files. This method returns the list of jar files implementing the module

Returns:URI[]

the module's list of implementation jars

getManifestback to summary
public Manifest getManifest()

Returns the manifest file for the main module jar file

Returns:Manifest

the manifest file

getMetadataback to summary
public ModuleMetadata getMetadata()

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

Returns:ModuleMetadata

Always non-null.

getNameback to summary
public String getName()

Returns the module name, usually this is the same name as the jar file name containing the module's implementation.

Returns:String

module name

getPublicInterfacesback to summary
public String[] getPublicInterfaces()

Returns a list of public interfaces for this module. Public interface can be packages, interfaces, or classes

Returns:String[]

a array of public interfaces

getVersionback to summary
public String getVersion()

Returns the version of this module's implementation

Returns:String

a version number