javax.enterprise.deploy.spi

Interface TargetModuleID

public interface TargetModuleID

A TargetModuleID interface represents a unique identifier for a deployed application module. A deployable application module can be an EAR, JAR, WAR or RAR file. A TargetModuleID can represent a root module or a child module. A root module TargetModuleID has no parent. It represents a deployed EAR file or standalone module. A child module TargetModuleID represents a deployed sub module of a J2EE application. A child TargetModuleID has only one parent, the super module it was bundled and deployed with. The identifier consists of the target name and the unique identifier for the deployed application module.

Version:

$Rev: 467553 $ $Date: 2006-10-25 06:01:51 +0200 (Wed, 25 Oct 2006) $

Method Summary

Modifier and Type	Method and Description
TargetModuleID[]	getChildTargetModuleID() Retrieve a list of identifiers of the children of this deployed module.
java.lang.String	getModuleID() Retrieve the id assigned to represent the deployed module.
TargetModuleID	getParentTargetModuleID() Retrieve the identifier of the parent object of this deployed module.
Target	getTarget() Retrieve the target server that this module was deployed to.
java.lang.String	getWebURL() If this TargetModulID represents a web module retrieve the URL for it.
java.lang.String	toString() Retrieve the identifier representing the deployed module.

Method Detail

getTarget

Target getTarget()

Retrieve the target server that this module was deployed to.

Returns:

an object representing a server target.

getModuleID

java.lang.String getModuleID()

Retrieve the id assigned to represent the deployed module.

getWebURL

java.lang.String getWebURL()

If this TargetModulID represents a web module retrieve the URL for it.

Returns:

the URL of a web module or null if the module is not a web module.

toString

java.lang.String toString()

Retrieve the identifier representing the deployed module.

Overrides:

toString in class java.lang.Object

getParentTargetModuleID

TargetModuleID getParentTargetModuleID()

Retrieve the identifier of the parent object of this deployed module. If there is no parent then this is the root object deployed. The root could represent an EAR file or it could be a stand alone module that was deployed.

Returns:

the TargetModuleID of the parent of this object. A null value means this module is the root object deployed.

getChildTargetModuleID

TargetModuleID[] getChildTargetModuleID()

Retrieve a list of identifiers of the children of this deployed module.

Returns:

a list of TargetModuleIDs identifying the childern of this object. A null value means this module has no children