Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


weblogic.management.runtime
Interface AppRuntimeStateRuntimeMBean

All Superinterfaces:
DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface AppRuntimeStateRuntimeMBean
extends RuntimeMBean

Provides access to runtime state for deployed applications.

Since:
9.0.0.0

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

 

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

 

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

 

Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes

 

Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister

 

Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener

 

Field Detail

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 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 String STATE_PREPARED
Ready for activation.
See Also:
Constant Field Values

STATE_ADMIN

static final String STATE_ADMIN
Running, but only accessible through the administration port.
See Also:
Constant Field Values

STATE_ACTIVE

static final String STATE_ACTIVE
Running 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

Method Detail

getApplicationIds

String[] getApplicationIds()
Returns:
List of known applications

isAdminMode

boolean isAdminMode(String appid,
                    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(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 application will be retired.
Parameters:
appid -

getRetireTimeoutSeconds

int getRetireTimeoutSeconds(String appid)
The amount of time the application 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 the 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:
WebLogicModuleType

getModuleType

String getModuleType(String appid,
                     String moduleid)
Indicates the type of module: EAR, WAR, etc.
Parameters:
appid -
moduleid -
Returns:
type of module
See Also:
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 -

Skip navigation links

Copyright 1996, 2015, 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
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09