Oracle Fusion Middleware
Oracle WebLogic Server API Reference
11g Release 1 (10.3.6)

Part Number E13941-06

weblogic.deploy.api.spi
Class WebLogicTargetModuleID

java.lang.Object
  extended by ModuleType
      extended by weblogic.deploy.api.shared.WebLogicModuleType
          extended by weblogic.deploy.api.spi.WebLogicTargetModuleID

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, JDBC, JMS, MODULETYPE_BPEL, MODULETYPE_JAVA, MODULETYPE_SCA_EXTENSION, MODULETYPE_SPRING, SCA_BPEL, SCA_EXTENSION, SCA_JAVA, SCA_SPRING, UNKNOWN, WLDF, WSEE
 
Method Summary
abstract  String getApplicationName()
          The name of the application without version information.
abstract  String getArchiveVersion()
          The archive version of the application.
abstract  String getModuleID()
          For root modules the id is the application identifier, which may include the application's name and version identifier.
abstract  String getPlanVersion()
          The deployment plan version for this application.
abstract  Target[] getServers()
          Servers associated with this target.
abstract  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 isTargeted()
          Indicates whether this module is specifically targeted or implied by a child or parent target.
 
Methods inherited from class weblogic.deploy.api.shared.WebLogicModuleType
equals, getModuleExtension, getModuleType, getTypeFromString, getValue, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getModuleID

public abstract String getModuleID()
For root modules the id is the application identifier, which may include the application's name and version identifier.


getApplicationName

public abstract String getApplicationName()
The name of the application without version information. For non-root modules, this is equivalent to getModuleID.


getArchiveVersion

public abstract String getArchiveVersion()
The archive version of the application. The version information extracted from the application's manifest attribute, Weblogic-Application-Version.


getPlanVersion

public abstract String getPlanVersion()
The deployment plan version for this application.


getVersion

public abstract String getVersion()

getServers

public abstract Target[] getServers()
                             throws IllegalStateException
Servers associated with this target. eg servers in a cluster.

Returns:
array of Target objects
Throws:
IllegalStateException - if unable to contact admin domain

isOnVirtualHost

public abstract boolean isOnVirtualHost()
Indicates this module is targeted to a virtual host


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.


Copyright 1996, 2011, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Oracle WebLogic Server API Reference
11g Release 1 (10.3.6)

Part Number E13941-06