weblogic.management.runtime
Interface AppRuntimeStateRuntimeMBean

public interface AppRuntimeStateRuntimeMBean

Provides access to runtime state for deployed applications.

Since:

9.0.0.0

Access limited to the following security roles:

Deployer, Operator, Monitor

STATE_NEW

static final String STATE_NEW

Configured but not deployed.

See Also:

Constant Field Values

STATE_FAILED

static final 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 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 app 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 String STATE_PREPARED

Ready for activation

See Also:

Constant Field Values

STATE_ADMIN

static final String STATE_ADMIN

Running but only accessible through admin port

See Also:

Constant Field Values

STATE_ACTIVE

static final String STATE_ACTIVE

Ruuning and available

See Also:

Constant Field Values

STATE_UPDATE_PENDING

static final String STATE_UPDATE_PENDING

Running and being updated

See Also:

Constant Field Values

getApplicationIds

String[] getApplicationIds()

Returns:

List of known applications

isAdminMode

boolean isAdminMode(String appid,
                    String target)

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

Parameters:

appid - is the application id

Returns:

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

isActiveVersion

boolean isActiveVersion(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(String appid)

The time when the app will be retired

Parameters:

appid -

getRetireTimeoutSeconds

int getRetireTimeoutSeconds(String appid)

The amount of time the app is given to retire

Parameters:

appid -

getIntendedState

String getIntendedState(String appid)

The state the application should be in.

Parameters:

appid -

getIntendedState

String getIntendedState(String appid,
                        String target)

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

Parameters:

appid -

target -

getCurrentState

String getCurrentState(String appid,
                       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

String[] getModuleIds(String appid)

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

Parameters:

appid -

Returns:

list of modules or null if app doesn't exist

getSubmoduleIds

String[] getSubmoduleIds(String appid,
                         String moduleid)

Submodules associated with this module

Parameters:

appid -

moduleid -

Returns:

type of module

See Also:

weblogic.deploy.api.shared.WebLogicModuleType

getModuleType

String getModuleType(String appid,
                     String moduleid)

Indicates type of module: EAR, WAR, etc

Parameters:

appid -

moduleid -

Returns:

type of module

See Also:

weblogic.deploy.api.shared.WebLogicModuleType

getCurrentState

String getCurrentState(String appid,
                       String moduleid,
                       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

String[] getModuleTargets(String appid,
                          String moduleid)

Logical targets where the module is deployed

Parameters:

appid -

moduleid -

getCurrentState

String getCurrentState(String appid,
                       String moduleid,
                       String subModuleId,
                       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

String[] getModuleTargets(String appid,
                          String moduleid,
                          String subModuleId)

Logical targets where the submodule is deployed

Parameters:

appid -

moduleid -

subModuleId -