Top Description Methods
javax.enterprise.deploy.spi

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 stand alone module. A child module TargetModuleID represents a deployed sub module of a Java EE 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.

Method Summary

Modifier and TypeMethod and Description
public TargetModuleID[]

Returns:

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

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

public String
getModuleID()

Retrieve the id assigned to represent the deployed module.

public TargetModuleID

Returns:

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

Retrieve the identifier of the parent object of this deployed module.

public Target

Returns:

Target an object representing a server target.
getTarget()

Retrieve the name of the target server.

public String

Returns:

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

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

public String
toString()

Retrieve the identifier representing the deployed module.

Method Detail

getChildTargetModuleIDback to summary
public TargetModuleID[] getChildTargetModuleID()

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

Returns:TargetModuleID[]

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

getModuleIDback to summary
public String getModuleID()

Retrieve the id assigned to represent the deployed module.

getParentTargetModuleIDback to summary
public 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:TargetModuleID

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

getTargetback to summary
public Target getTarget()

Retrieve the name of the target server. this module was deployed to.

Returns:Target

Target an object representing a server target.

getWebURLback to summary
public String getWebURL()

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

Returns:String

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

toStringback to summary
public String toString()

Retrieve the identifier representing the deployed module.