ApplicationRuntimeMBean (Java API Reference for Oracle WebLogic Server)

All Superinterfaces:

javax.management.DynamicMBean, HealthFeedback, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, RuntimeMBean, WebLogicMBean
```
@Contract
public interface ApplicationRuntimeMBean
extends RuntimeMBean, HealthFeedback
```
An application represents a Java EE enterprise application packaged in an EAR file or EAR exploded directory. The EAR file or directory contains a set of components such as WAR, EJB, and RAR connector components, each of which can be deployed on one or more targets. A target is a server or a cluster. Modules in the application can have one of the following states:
- UNPREPARED - Indicates that none of the modules in this application are currently prepared or active.
- PREPARED - Indicates that none of the modules in this application are currently prepared or active.
- ACTIVATED - Indicates that at least one module in this application is currently active.
ApplicationRuntimeMBean encapsulates runtime information about a deployed enterprise application.
Access limited to the following security roles:

Operator

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ACTIVATED`	State indicating at least one module in this application is currently active.
`static int`	`PREPARED`	State indicating at least one module in this application is prepared, but none are active.
`static int`	`UNPREPARED`	State indicating that none of the modules in this application are currently prepared or active.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`int`	`getActiveVersionState()`	Specifies whether this application version is the currently active version.
`java.lang.String`	`getApplicationName()`	The name of the application.
`java.lang.String`	`getApplicationVersion()`	The application's version identifier.
`ClassLoaderRuntimeMBean`	`getClassLoaderRuntime()`	Get statistics for system-level class loading.
`ClassRedefinitionRuntimeMBean`	`getClassRedefinitionRuntime()`	If the class FastSwap feature is enabled for the application, returns the runtime MBean to monitor and control the class FastSwap within the application.
`CoherenceClusterRuntimeMBean`	`getCoherenceClusterRuntime()`	Returns the Coherence Cluster related runtime MBean.
`ComponentRuntimeMBean[]`	`getComponentRuntimes()`	Returns the list of component runtime instances for each Java EE component (such as an EJB or a web application) that is contained in this enterprise application.
`HealthState`	`getHealthState()`	The HealthState MBean for the application.
`javax.management.openmbean.CompositeData`	`getHealthStateJMX()`	The health state for the application.
`LibraryRuntimeMBean[]`	`getLibraryRuntimes()`	Returns the list of library runtime instances for each Java EE library that is contained in this enterprise application.
`ManagedExecutorServiceRuntimeMBean[]`	`getManagedExecutorServiceRuntimes()`	Returns the list of managed executor service runtime instances for each application-scoped managed executor service that is associated with this enterprise application.
`ManagedScheduledExecutorServiceRuntimeMBean[]`	`getManagedScheduledExecutorServiceRuntimes()`	Returns the list of managed scheduled executor service runtime instances for each application-scoped managed scheduled executor service that is associated with this enterprise application.
`ManagedThreadFactoryRuntimeMBean[]`	`getManagedThreadFactoryRuntimes()`	Returns the list of managed thread factory runtime instances for each application-scoped managed thread factory that is associated with this enterprise application.
`MaxThreadsConstraintRuntimeMBean[]`	`getMaxThreadsConstraintRuntimes()`	Get the runtime MBeans for all MaxThreadsConstraints defined at the application level.
`MinThreadsConstraintRuntimeMBean[]`	`getMinThreadsConstraintRuntimes()`	Get the runtime MBeans for all MinThreadsConstraints defined at the application level.
`LibraryRuntimeMBean[]`	`getOptionalPackageRuntimes()`	Returns the list of optional package runtime instances for each Java EE optional package that is contained in this enterprise application.
`HealthState`	`getOverallHealthState()`	The overall health of the application including that of some of the components that report health.
`javax.management.openmbean.CompositeData`	`getOverallHealthStateJMX()`	The overall health of the application including that of some of the components that report health.
`PersistenceUnitRuntimeMBean`	`getPersistenceUnitRuntime(java.lang.String unitName)`	Provides the PersistenceUnitRuntimeMBean for the application with the specified name.
`PersistenceUnitRuntimeMBean[]`	`getPersistenceUnitRuntimes()`	Provides an array of PersistenceUnitRuntimeMBean objects for this EAR module.
`QueryCacheRuntimeMBean[]`	`getQueryCacheRuntimes()`	Returns a list of QueryCacheRuntimeMBeans configured for this application.
`RequestClassRuntimeMBean[]`	`getRequestClassRuntimes()`	Get the runtime MBeans for all request classes defined at the application level.
`WorkManagerRuntimeMBean[]`	`getWorkManagerRuntimes()`	Returns the list of work manager runtime instances for each application-scoped work manager that is associated with this enterprise application.
`WseeRuntimeMBean[]`	`getWseeRuntimes()`	Deprecated. Use getWseeV2Runtimes from the web app or EJB component instead
`WseeV2RuntimeMBean[]`	`getWseeV2Runtimes()`	Returns the list of Web Service runtime instances that are contained at the application scope of this enterprise application.
`boolean`	`hasApplicationCache()`	Returns true if the application has an (EJB) Application Level Cache
`boolean`	`isInternal()`	Indicates whether this application is an internal application.
`ComponentRuntimeMBean[]`	`lookupComponents()`	Deprecated.
`ManagedExecutorServiceRuntimeMBean`	`lookupManagedExecutorServiceRuntime(java.lang.String componentName, java.lang.String name)`	Look up the ManagedExecutorServiceRuntimeMBean given the component name and managed executor service name.
`ManagedScheduledExecutorServiceRuntimeMBean`	`lookupManagedScheduledExecutorServiceRuntime(java.lang.String componentName, java.lang.String name)`	Look up the ManagedScheduledExecutorServiceRuntimeMBean given the component name and managed scheduled executor service name.
`ManagedThreadFactoryRuntimeMBean`	`lookupManagedThreadFactoryRuntime(java.lang.String componentName, java.lang.String name)`	Look up the ManagedThreadFactoryRuntimeMBean given the component name and managed thread factory name.
`QueryCacheRuntimeMBean`	`lookupQueryCacheRuntime(java.lang.String cacheName)`	Returns a QueryCacheRuntimeMBean for the app-scoped query-cache with name 'cacheName'.
`WorkManagerRuntimeMBean`	`lookupWorkManagerRuntime(java.lang.String componentName, java.lang.String wmName)`	Look up the WorkManagerRuntimeMBean given the component name and work manager name.
`WseeV2RuntimeMBean`	`lookupWseeV2Runtime(java.lang.String name)`	Returns a named Web Service runtime instance that is contained at application scope of this enterprise application.
`void`	`reInitializeApplicationCachesAndPools()`	If the application has an (EJB) Application Level Cache, then this method will reinitialize the cache and any of its associated pools to their startup time states if possible.

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
  - UNPREPARED
```
static final int UNPREPARED
```
    State indicating that none of the modules in this application are currently prepared or active.
    
    See Also:
    
    Constant Field Values
  - PREPARED
```
static final int PREPARED
```
    State indicating at least one module in this application is prepared, but none are active.
    
    See Also:
    
    Constant Field Values
  - ACTIVATED
```
static final int ACTIVATED
```
    State indicating at least one module in this application is currently active.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getApplicationName
```
java.lang.String getApplicationName()
```
    The name of the application.
    
    Returns:
    
    The applicationName value
  - getApplicationVersion
```
java.lang.String getApplicationVersion()
```
    The application's version identifier.
    
    This is particularly useful, when using the side-by-side deployment feature, to differentiate between two different versions of the same application that are deployed at the same time.
    
    Returns:
    
    The applicationVersion value
  - getActiveVersionState
```
int getActiveVersionState()
```
    Specifies whether this application version is the currently active version.
    
    An application can be the only version currently deployed, or it can have more than one version currently deployed, using the side-by-side deployment feature. If more than one version is deployed, only one version can be active. This attribute specifies the state the current application version is in.
    
    An application can be in an INACTIVE state, which means that it has not been activated yet, or that there is more than one version of the application deployed (using side-by-side deployment) and this version is retiring.
    
    An application can be in ACTIVE_ADMIN state, which means that it is the currently active version for administrative channel requests.
    
    An application can be in ACTIVE state, which means that it is the currently active version for normal (non-administrative) channel requests.
    
    See Also:
    
    AppActiveVersionState
  - lookupComponents
```
@Deprecated
ComponentRuntimeMBean[] lookupComponents()
```
    Deprecated.
    
    The ComponentRuntimeMBean's contained in this application.
    
    Access limited to the following security roles:
    
    Deployer
  - getComponentRuntimes
```
ComponentRuntimeMBean[] getComponentRuntimes()
```
    Returns the list of component runtime instances for each Java EE component (such as an EJB or a web application) that is contained in this enterprise application.
  - getLibraryRuntimes
```
LibraryRuntimeMBean[] getLibraryRuntimes()
```
    Returns the list of library runtime instances for each Java EE library that is contained in this enterprise application.
    
    Returns:
    
    LibraryRuntimeMBean Array, null if this application is not referencing any libraries.
  - getOptionalPackageRuntimes
```
LibraryRuntimeMBean[] getOptionalPackageRuntimes()
```
    Returns the list of optional package runtime instances for each Java EE optional package that is contained in this enterprise application.
    
    Returns:
    
    LibraryRuntimeMBean Array, null if this application is not referencing any Optional Packages.
  - getWorkManagerRuntimes
```
WorkManagerRuntimeMBean[] getWorkManagerRuntimes()
```
    Returns the list of work manager runtime instances for each application-scoped work manager that is associated with this enterprise application.
  - lookupWorkManagerRuntime
```
WorkManagerRuntimeMBean lookupWorkManagerRuntime(java.lang.String componentName,
                                                 java.lang.String wmName)
```
    Look up the WorkManagerRuntimeMBean given the component name and work manager name. If the component name is null then the WorkManagerRuntime is retrieved from the application itself.
    
    Parameters:
    
    componentName -
    
    wmName -
  - getClassLoaderRuntime
```
ClassLoaderRuntimeMBean getClassLoaderRuntime()
```
    Get statistics for system-level class loading.
  - getWseeRuntimes
```
@Deprecated
WseeRuntimeMBean[] getWseeRuntimes()
```
    Deprecated.
    Use getWseeV2Runtimes from the web app or EJB component instead
    
    Returns the list of Web Service runtime instances that are contained in this enterprise application.
  - getWseeV2Runtimes
```
WseeV2RuntimeMBean[] getWseeV2Runtimes()
```
    Returns the list of Web Service runtime instances that are contained at the application scope of this enterprise application. This can happen when javax.xml.ws.Endpoint.publish() is called from within an application lifecycle listener.
    
    Returns:
    
    Web Service Runtime MBeans
  - lookupWseeV2Runtime
```
WseeV2RuntimeMBean lookupWseeV2Runtime(java.lang.String name)
```
    Returns a named Web Service runtime instance that is contained at application scope of this enterprise application.
    
    Parameters:
    
    name - The web service description name of the web service to look up.
    
    Returns:
    
    The web service runtime or null if no web service with the given name could be found.
  - getMaxThreadsConstraintRuntimes
```
MaxThreadsConstraintRuntimeMBean[] getMaxThreadsConstraintRuntimes()
```
    Get the runtime MBeans for all MaxThreadsConstraints defined at the application level.
  - getMinThreadsConstraintRuntimes
```
MinThreadsConstraintRuntimeMBean[] getMinThreadsConstraintRuntimes()
```
    Get the runtime MBeans for all MinThreadsConstraints defined at the application level.
  - getRequestClassRuntimes
```
RequestClassRuntimeMBean[] getRequestClassRuntimes()
```
    Get the runtime MBeans for all request classes defined at the application level.
  - hasApplicationCache
```
boolean hasApplicationCache()
```
    Returns true if the application has an (EJB) Application Level Cache
  - reInitializeApplicationCachesAndPools
```
void reInitializeApplicationCachesAndPools()
```
    If the application has an (EJB) Application Level Cache, then this method will reinitialize the cache and any of its associated pools to their startup time states if possible.
  - getQueryCacheRuntimes
```
QueryCacheRuntimeMBean[] getQueryCacheRuntimes()
```
    Returns a list of QueryCacheRuntimeMBeans configured for this application.
  - lookupQueryCacheRuntime
```
QueryCacheRuntimeMBean lookupQueryCacheRuntime(java.lang.String cacheName)
```
    Returns a QueryCacheRuntimeMBean for the app-scoped query-cache with name 'cacheName'.
    
    Parameters:
    
    cacheName -
  - getPersistenceUnitRuntimes
```
PersistenceUnitRuntimeMBean[] getPersistenceUnitRuntimes()
```
    Provides an array of PersistenceUnitRuntimeMBean objects for this EAR module.
    
    Returns:
    
    The persistenceUnitRuntimes value
  - getPersistenceUnitRuntime
```
PersistenceUnitRuntimeMBean getPersistenceUnitRuntime(java.lang.String unitName)
```
    Provides the PersistenceUnitRuntimeMBean for the application with the specified name.
    
    Parameters:
    
    unitName -
    
    Returns:
    
    The persistenceUnitRuntime value
  - getClassRedefinitionRuntime
```
ClassRedefinitionRuntimeMBean getClassRedefinitionRuntime()
```
    If the class FastSwap feature is enabled for the application, returns the runtime MBean to monitor and control the class FastSwap within the application.
    
    Returns:
    
    Runtime MBean to monitor and control class FastSwap within the application, if enabled.
  - getHealthState
```
HealthState getHealthState()
```
    The HealthState MBean for the application.
    
    Specified by:
    
    getHealthState in interface HealthFeedback
    
    Returns:
    
    Runtime MBean to get health state information for this application.
    
    See Also:
    
    HealthState
  - getOverallHealthState
```
HealthState getOverallHealthState()
```
    The overall health of the application including that of some of the components that report health. Currently, only connector modules report health status and are the only ones considered in the overall health state of the application.
    
    Returns:
    
    Runtime MBean to get overall health state information for this application.
    
    See Also:
    
    HealthState
  - getHealthStateJMX
```
javax.management.openmbean.CompositeData getHealthStateJMX()
                                                    throws javax.management.openmbean.OpenDataException
```
    The health state for the application.
    
    Returns:
    
    The health state information for this application as CompositeData.
    
    Throws:
    
    javax.management.openmbean.OpenDataException
  - getOverallHealthStateJMX
```
javax.management.openmbean.CompositeData getOverallHealthStateJMX()
                                                           throws javax.management.openmbean.OpenDataException
```
    The overall health of the application including that of some of the components that report health. Currently, only connector modules report health status and are the only ones considered in the overall health state of the application.
    
    Returns:
    
    The overall health state information for this application as CompositeData.
    
    Throws:
    
    javax.management.openmbean.OpenDataException
  - getCoherenceClusterRuntime
```
CoherenceClusterRuntimeMBean getCoherenceClusterRuntime()
```
    Returns the Coherence Cluster related runtime MBean.
    
    Returns:
    
    CoherenceClusterRuntimeMBean
  - isInternal
```
boolean isInternal()
```
    Indicates whether this application is an internal application. Such applications are not displayed in the console or persisted in the config.xml.
    
    Returns:
    
    Whether the application is internal.
  - getManagedThreadFactoryRuntimes
```
ManagedThreadFactoryRuntimeMBean[] getManagedThreadFactoryRuntimes()
```
    Returns the list of managed thread factory runtime instances for each application-scoped managed thread factory that is associated with this enterprise application.
  - lookupManagedThreadFactoryRuntime
```
ManagedThreadFactoryRuntimeMBean lookupManagedThreadFactoryRuntime(java.lang.String componentName,
                                                                   java.lang.String name)
```
    Look up the ManagedThreadFactoryRuntimeMBean given the component name and managed thread factory name. If the component name is null then the ManagedThreadFactoryRuntimeMBean is retrieved from the application itself.
    
    Parameters:
    
    componentName -
    
    name -
  - getManagedExecutorServiceRuntimes
```
ManagedExecutorServiceRuntimeMBean[] getManagedExecutorServiceRuntimes()
```
    Returns the list of managed executor service runtime instances for each application-scoped managed executor service that is associated with this enterprise application.
  - lookupManagedExecutorServiceRuntime
```
ManagedExecutorServiceRuntimeMBean lookupManagedExecutorServiceRuntime(java.lang.String componentName,
                                                                       java.lang.String name)
```
    Look up the ManagedExecutorServiceRuntimeMBean given the component name and managed executor service name. If the component name is null then the ManagedExecutorServiceRuntimeMBean is retrieved from the application itself.
    
    Parameters:
    
    componentName -
    
    name -
  - getManagedScheduledExecutorServiceRuntimes
```
ManagedScheduledExecutorServiceRuntimeMBean[] getManagedScheduledExecutorServiceRuntimes()
```
    Returns the list of managed scheduled executor service runtime instances for each application-scoped managed scheduled executor service that is associated with this enterprise application.
  - lookupManagedScheduledExecutorServiceRuntime
```
ManagedScheduledExecutorServiceRuntimeMBean lookupManagedScheduledExecutorServiceRuntime(java.lang.String componentName,
                                                                                         java.lang.String name)
```
    Look up the ManagedScheduledExecutorServiceRuntimeMBean given the component name and managed scheduled executor service name. If the component name is null then the ManagedScheduledExecutorServiceRuntimeMBean is retrieved from the application itself.
    
    Parameters:
    
    componentName -
    
    name -

Interface ApplicationRuntimeMBean

Field Summary

Method Summary

Methods inherited from interface javax.management.DynamicMBean

Methods inherited from interface javax.management.MBeanRegistration

Methods inherited from interface javax.management.NotificationBroadcaster

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

Methods inherited from interface weblogic.management.WebLogicMBean

Field Detail

UNPREPARED

PREPARED

ACTIVATED

Method Detail

getApplicationName

getApplicationVersion

getActiveVersionState

lookupComponents

getComponentRuntimes

getLibraryRuntimes

getOptionalPackageRuntimes

getWorkManagerRuntimes

lookupWorkManagerRuntime

getClassLoaderRuntime

getWseeRuntimes

getWseeV2Runtimes

lookupWseeV2Runtime

getMaxThreadsConstraintRuntimes

getMinThreadsConstraintRuntimes

getRequestClassRuntimes

hasApplicationCache

reInitializeApplicationCachesAndPools

getQueryCacheRuntimes

lookupQueryCacheRuntime

getPersistenceUnitRuntimes

getPersistenceUnitRuntime

getClassRedefinitionRuntime

getHealthState

getOverallHealthState

getHealthStateJMX

getOverallHealthStateJMX

getCoherenceClusterRuntime

isInternal

getManagedThreadFactoryRuntimes

lookupManagedThreadFactoryRuntime

getManagedExecutorServiceRuntimes

lookupManagedExecutorServiceRuntime

getManagedScheduledExecutorServiceRuntimes

lookupManagedScheduledExecutorServiceRuntime