Package weblogic.deploy.api.spi

Class WebLogicTargetModuleID

java.lang.Object

weblogic.deploy.api.shared.WebLogicModuleType

weblogic.deploy.api.spi.WebLogicTargetModuleID

All Implemented Interfaces:

javax.enterprise.deploy.spi.TargetModuleID

public abstract class WebLogicTargetModuleID
extends WebLogicModuleType

WLS extensions to the javax.enterprise.deploy.spi.TargetModuleID interface.

The WebLogicTargetModuleIDs represented by this class have a close relationship to The configured TargetInMBeans (AppDeploymentMBean, ModuleTargetMBean and SubModuletargetMBean). These Mbeans tend to provide a very sparse picture of where modules are targeted.

Similarly a WebLogicTargetModuleID may only exist for a module it is has more specific targeting than its parent WebLogicTargetModuleID.

Field Summary

Fields inherited from class weblogic.deploy.api.shared.WebLogicModuleType

COHERENCE_CLUSTER, GAR, JDBC, JMS, MODULETYPE_BPEL, MODULETYPE_GAR, MODULETYPE_JAVA, MODULETYPE_SCA_EXTENSION, MODULETYPE_SPRING, REST_WEBSERVICE, SCA_BPEL, SCA_EXTENSION, SCA_JAVA, SCA_SPRING, UNKNOWN, WLDF, WSEE

Method Summary

Modifier and Type	Method	Description
abstract java.lang.String	getApplicationName()	The name of the application without version information.
abstract java.lang.String	getArchiveVersion()	The archive version of the application.
abstract java.lang.String	getModuleID()	For root modules the id is the application identifier, which may include the application's name and version identifier.
abstract java.lang.String	getPlanVersion()	The deployment plan version for this application.
abstract javax.enterprise.deploy.spi.Target[]	getServers()	Servers associated with this target.
abstract java.lang.String	getVersion()
abstract boolean	isOnCluster()	Indicates this module is targeted to a cluster
abstract boolean	isOnJMSServer()	Indicates this module is targeted to a JMS server
abstract boolean	isOnSAFAgent()	Indicates this module is targeted to a SAF agent
abstract boolean	isOnServer()	Indicates this module is targeted to a server
abstract boolean	isOnVirtualHost()	Indicates this module is targeted to a virtual host
abstract boolean	isOnVirtualTarget()	Indicates this module is targeted to a virtual target
abstract boolean	isTargeted()	Indicates whether this module is specifically targeted or implied by a child or parent target.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class weblogic.deploy.api.shared.WebLogicModuleType

getModuleExtension, getModuleType, getTypeFromString, getValue

Method Detail

getModuleID

public abstract java.lang.String getModuleID()

For root modules the id is the application identifier, which may include the application's name and version identifier.

Specified by:

getModuleID in interface javax.enterprise.deploy.spi.TargetModuleID

getApplicationName

public abstract java.lang.String getApplicationName()

The name of the application without version information. For non-root modules, this is equivalent to getModuleID.

getArchiveVersion

public abstract java.lang.String getArchiveVersion()

The archive version of the application. The version information extracted from the application's manifest attribute, Weblogic-Application-Version.

getPlanVersion

public abstract java.lang.String getPlanVersion()

The deployment plan version for this application.

getVersion

public abstract java.lang.String getVersion()

getServers

public abstract javax.enterprise.deploy.spi.Target[] getServers()
                                                         throws java.lang.IllegalStateException

Servers associated with this target. eg servers in a cluster.

Returns:

array of Target objects

Throws:

java.lang.IllegalStateException - if unable to contact admin domain

isOnVirtualHost

public abstract boolean isOnVirtualHost()

Indicates this module is targeted to a virtual host

isOnVirtualTarget

public abstract boolean isOnVirtualTarget()

Indicates this module is targeted to a virtual target

isOnServer

public abstract boolean isOnServer()

Indicates this module is targeted to a server

isOnCluster

public abstract boolean isOnCluster()

Indicates this module is targeted to a cluster

isOnJMSServer

public abstract boolean isOnJMSServer()

Indicates this module is targeted to a JMS server

isOnSAFAgent

public abstract boolean isOnSAFAgent()

Indicates this module is targeted to a SAF agent

isTargeted

public abstract boolean isTargeted()

Indicates whether this module is specifically targeted or implied by a child or parent target. If false, this object only exists because it has a child or parent that is specifically targeted.