Package weblogic.management.runtime

Interface AppRuntimeStateRuntimeMBean

All Superinterfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface AppRuntimeStateRuntimeMBean
extends RuntimeMBean

Provides access to runtime state for deployed applications.

Access limited to the following security roles:

Deployer, Operator, Monitor

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	STATE_ACTIVE	Running and available.
static java.lang.String	STATE_ADMIN	Running, but only accessible through the administration port.
static java.lang.String	STATE_FAILED	Configured but not deployed.
static java.lang.String	STATE_NEW	Configured but not deployed.
static java.lang.String	STATE_PREPARED	Ready for activation.
static java.lang.String	STATE_RETIRED	Configured but not deployed.
static java.lang.String	STATE_UPDATE_PENDING	Running and being updated.

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	getApplicationIds()
java.lang.String	getCurrentState(java.lang.String appid, java.lang.String target)	Aggregate state for the application.
java.lang.String	getCurrentState(java.lang.String appid, java.lang.String moduleid, java.lang.String target)	Aggregate state for the module.
java.lang.String	getCurrentState(java.lang.String appid, java.lang.String moduleid, java.lang.String subModuleId, java.lang.String target)	Aggregate state for a submodule.
java.lang.String	getIntendedState(java.lang.String appid)	The state the application should be in.
java.lang.String	getIntendedState(java.lang.String appid, java.lang.String target)	The state the application should be in on a specific target.
java.lang.String[]	getModuleIds(java.lang.String appid)	Names of the modules contained in the application.
java.lang.String[]	getModuleTargets(java.lang.String appid, java.lang.String moduleid)	Logical targets where the module is deployed.
java.lang.String[]	getModuleTargets(java.lang.String appid, java.lang.String moduleid, java.lang.String subModuleId)	Logical targets where the submodule is deployed.
java.lang.String	getModuleType(java.lang.String appid, java.lang.String moduleid)	Indicates the type of module: EAR, WAR, etc.
long	getRetireTimeMillis(java.lang.String appid)	The time when the application will be retired.
int	getRetireTimeoutSeconds(java.lang.String appid)	The amount of time the application is given to retire.
java.lang.String[]	getSubmoduleIds(java.lang.String appid, java.lang.String moduleid)	Submodules associated with this module.
boolean	isActiveVersion(java.lang.String appid)	Indicates if the application is the active version, the one that new sessions will use.
boolean	isAdminMode(java.lang.String appid, java.lang.String target)	Indicates if the application should only be available through the administration port.

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Field Detail

STATE_NEW

static final java.lang.String STATE_NEW

Configured but not deployed.

See Also:

Constant Field Values

STATE_FAILED

static final java.lang.String STATE_FAILED

Configured but not deployed. This is the state of an application after it fails during dynamic deployment activate or during static deployment startup. This state can only be set as a current state, but not as an intended state.

See Also:

Constant Field Values

STATE_RETIRED

static final java.lang.String STATE_RETIRED

Configured but not deployed. This is the state of an application version after it is retired. The administrator is responsible for explicitly removing the retired application version from the configuration. This state can only be set as a current state, but not as an intended state.

See Also:

Constant Field Values

STATE_PREPARED

static final java.lang.String STATE_PREPARED

Ready for activation.

See Also:

Constant Field Values

STATE_ADMIN

static final java.lang.String STATE_ADMIN

Running, but only accessible through the administration port.

See Also:

Constant Field Values

STATE_ACTIVE

static final java.lang.String STATE_ACTIVE

Running and available.

See Also:

Constant Field Values

STATE_UPDATE_PENDING

static final java.lang.String STATE_UPDATE_PENDING

Running and being updated.

See Also:

Constant Field Values

Method Detail

getApplicationIds

java.lang.String[] getApplicationIds()

Returns:

List of known applications

isAdminMode

boolean isAdminMode(java.lang.String appid,
                    java.lang.String target)

Indicates if the application should only be available through the administration port. This is the desired state of the application.

Parameters:

appid - is the application id

target -

Returns:

true if application deployed to named target is in admin mode. Returns false otherwise, or if application is not deployed to target.

isActiveVersion

boolean isActiveVersion(java.lang.String appid)

Indicates if the application is the active version, the one that new sessions will use.

Parameters:

appid - is the application id

Returns:

true if application deployed to named target is the active version.

getRetireTimeMillis

long getRetireTimeMillis(java.lang.String appid)

The time when the application will be retired.

Parameters:

appid -

getRetireTimeoutSeconds

int getRetireTimeoutSeconds(java.lang.String appid)

The amount of time the application is given to retire.

Parameters:

appid -

getIntendedState

java.lang.String getIntendedState(java.lang.String appid)

The state the application should be in.

Parameters:

appid -

getIntendedState

java.lang.String getIntendedState(java.lang.String appid,
                                  java.lang.String target)

The state the application should be in on a specific target.

Parameters:

appid -

target -

getCurrentState

java.lang.String getCurrentState(java.lang.String appid,
                                 java.lang.String target)

Aggregate state for the application. This is defined as the most advanced state of the application's modules on the named target.

Parameters:

appid -

target - logical target where the app is deployed

Returns:

Aggregate state for the application, or null if app not configured on target

getModuleIds

java.lang.String[] getModuleIds(java.lang.String appid)

Names of the modules contained in the application. This does not include submodules.

Parameters:

appid -

Returns:

list of modules or null if app doesn't exist

Access limited to the following security roles:

Deployer

getSubmoduleIds

java.lang.String[] getSubmoduleIds(java.lang.String appid,
                                   java.lang.String moduleid)

Submodules associated with this module.

Parameters:

appid -

moduleid -

Returns:

type of module

See Also:

WebLogicModuleType

getModuleType

java.lang.String getModuleType(java.lang.String appid,
                               java.lang.String moduleid)

Indicates the type of module: EAR, WAR, etc.

Parameters:

appid -

moduleid -

Returns:

type of module

See Also:

WebLogicModuleType

getCurrentState

java.lang.String getCurrentState(java.lang.String appid,
                                 java.lang.String moduleid,
                                 java.lang.String target)

Aggregate state for the module. This is defined as the most advanced state of the module on all servers associated with the named target.

Parameters:

appid -

moduleid -

target - logical target where module is deployed

Returns:

Aggregate state for the application, or null if app not configured on target

getModuleTargets

java.lang.String[] getModuleTargets(java.lang.String appid,
                                    java.lang.String moduleid)

Logical targets where the module is deployed.

Parameters:

appid -

moduleid -

getCurrentState

java.lang.String getCurrentState(java.lang.String appid,
                                 java.lang.String moduleid,
                                 java.lang.String subModuleId,
                                 java.lang.String target)

Aggregate state for a submodule. This is defined as the most advanced state of the submodule on all servers associated with the named target.

Parameters:

appid -

moduleid -

subModuleId -

target - logical target where module is deployed

Returns:

Aggregate state for the application, or null if app not configured on target

getModuleTargets

java.lang.String[] getModuleTargets(java.lang.String appid,
                                    java.lang.String moduleid,
                                    java.lang.String subModuleId)

Logical targets where the submodule is deployed.

Parameters:

appid -

moduleid -

subModuleId -