ApplicationRuntimeMBean (Java API Reference for Oracle WebLogic Server)

Class

Use

Tree

Help

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

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.runtime
Interface ApplicationRuntimeMBean

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

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.

Field Summary
`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
`abstract int`	`getActiveVersionState()` Specifies whether this application version is the currently active version.
`abstract String`	`getApplicationName()` The name of the application.
`abstract String`	`getApplicationVersion()` The application's version identifier.
`abstract ClassLoaderRuntimeMBean`	`getClassLoaderRuntime()` Get statistics for system-level class loading.
`abstract 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.
`abstract CoherenceClusterRuntimeMBean`	`getCoherenceClusterRuntime()` Returns the Coherence Cluster related runtime MBean.
`abstract 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.
`abstract HealthState`	`getHealthState()` The HealthState MBean for the application.
`abstract CompositeData`	`getHealthStateJMX()` The health state for the application.
`abstract KodoPersistenceUnitRuntimeMBean`	`getKodoPersistenceUnitRuntime(String unitName)` Deprecated. As of 11.1.2.0, use getPersistenceUnitRuntime instead
`abstract KodoPersistenceUnitRuntimeMBean[]`	`getKodoPersistenceUnitRuntimes()` Deprecated. As of 11.1.2.0, use getPersistenceUnitRuntimes instead
`abstract LibraryRuntimeMBean[]`	`getLibraryRuntimes()` Returns the list of library runtime instances for each Java EE library that is contained in this enterprise application.
`abstract 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.
`abstract 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.
`abstract 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.
`abstract MaxThreadsConstraintRuntimeMBean[]`	`getMaxThreadsConstraintRuntimes()` Get the runtime MBeans for all MaxThreadsConstraints defined at the application level.
`abstract MinThreadsConstraintRuntimeMBean[]`	`getMinThreadsConstraintRuntimes()` Get the runtime MBeans for all MinThreadsConstraints defined at the application level.
`abstract LibraryRuntimeMBean[]`	`getOptionalPackageRuntimes()` Returns the list of optional package runtime instances for each Java EE optional package that is contained in this enterprise application.
`abstract HealthState`	`getOverallHealthState()` The overall health of the application including that of some of the components that report health.
`abstract CompositeData`	`getOverallHealthStateJMX()` The overall health of the application including that of some of the components that report health.
`abstract PersistenceUnitRuntimeMBean`	`getPersistenceUnitRuntime(String unitName)` Provides the PersistenceUnitRuntimeMBean for the application with the specified name.
`abstract PersistenceUnitRuntimeMBean[]`	`getPersistenceUnitRuntimes()` Provides an array of PersistenceUnitRuntimeMBean objects for this EAR module.
`abstract QueryCacheRuntimeMBean[]`	`getQueryCacheRuntimes()` Returns a list of QueryCacheRuntimeMBeans configured for this application.
`abstract RequestClassRuntimeMBean[]`	`getRequestClassRuntimes()` Get the runtime MBeans for all request classes defined at the application level.
`abstract WorkManagerRuntimeMBean[]`	`getWorkManagerRuntimes()` Returns the list of work manager runtime instances for each application-scoped work manager that is associated with this enterprise application.
`abstract WseeRuntimeMBean[]`	`getWseeRuntimes()` Deprecated. Use getWseeV2Runtimes from the web app or EJB component instead
`abstract WseeV2RuntimeMBean[]`	`getWseeV2Runtimes()` Returns the list of Web Service runtime instances that are contained at the application scope of this enterprise application.
`abstract boolean`	`hasApplicationCache()` Returns true if the application has an (EJB) Application Level Cache
`abstract boolean`	`isInternal()` Indicates whether this application is an internal application.
`abstract ComponentRuntimeMBean[]`	`lookupComponents()` Deprecated.
`abstract ManagedExecutorServiceRuntimeMBean`	`lookupManagedExecutorServiceRuntime(String componentName, String name)` Look up the ManagedExecutorServiceRuntimeMBean given the component name and managed executor service name.
`abstract ManagedScheduledExecutorServiceRuntimeMBean`	`lookupManagedScheduledExecutorServiceRuntime(String componentName, String name)` Look up the ManagedScheduledExecutorServiceRuntimeMBean given the component name and managed scheduled executor service name.
`abstract ManagedThreadFactoryRuntimeMBean`	`lookupManagedThreadFactoryRuntime(String componentName, String name)` Look up the ManagedThreadFactoryRuntimeMBean given the component name and managed thread factory name.
`abstract QueryCacheRuntimeMBean`	`lookupQueryCacheRuntime(String cacheName)` Returns a QueryCacheRuntimeMBean for the app-scoped query-cache with name 'cacheName'.
`abstract WorkManagerRuntimeMBean`	`lookupWorkManagerRuntime(String componentName, String wmName)` Look up the WorkManagerRuntimeMBean given the component name and work manager name.
`abstract WseeV2RuntimeMBean`	`lookupWseeV2Runtime(String name)` Returns a named Web Service runtime instance that is contained at application scope of this enterprise application.
`abstract 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 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

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

String getApplicationName()

The name of the application.

Returns:: The applicationName value

getApplicationVersion

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

ComponentRuntimeMBean[] lookupComponents()

Deprecated.

The ComponentRuntimeMBean's contained in this application.

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.

Since:: 9.0.0.0

lookupWorkManagerRuntime

WorkManagerRuntimeMBean lookupWorkManagerRuntime(String componentName,
                                                 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 -
Since:: 9.0.0.0

getClassLoaderRuntime

ClassLoaderRuntimeMBean getClassLoaderRuntime()

Get statistics for system-level class loading.

Since:: 12.2.1

getWseeRuntimes

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(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.

Since:: 9.0.0.0

getMinThreadsConstraintRuntimes

MinThreadsConstraintRuntimeMBean[] getMinThreadsConstraintRuntimes()

Get the runtime MBeans for all MinThreadsConstraints defined at the application level.

Since:: 9.0.0.0

getRequestClassRuntimes

RequestClassRuntimeMBean[] getRequestClassRuntimes()

Get the runtime MBeans for all request classes defined at the application level.

Since:: 9.0.0.0

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(String cacheName)

Returns a QueryCacheRuntimeMBean for the app-scoped query-cache with name 'cacheName'.

Parameters:: cacheName -

getKodoPersistenceUnitRuntimes

KodoPersistenceUnitRuntimeMBean[] getKodoPersistenceUnitRuntimes()

Deprecated. As of 11.1.2.0, use getPersistenceUnitRuntimes instead

Provides an array of KodoPersistenceUnitRuntimeMBean objects for this EJB module.

Returns:: The persistenceUnitRuntimes value

getKodoPersistenceUnitRuntime

KodoPersistenceUnitRuntimeMBean getKodoPersistenceUnitRuntime(String unitName)

Deprecated. As of 11.1.2.0, use getPersistenceUnitRuntime instead

Provides the KodoPersistenceUnitRuntimeMBean for the EJB with the specified name.

Parameters:: unitName -
Returns:: The persistenceUnitRuntime value

getPersistenceUnitRuntimes

PersistenceUnitRuntimeMBean[] getPersistenceUnitRuntimes()

Provides an array of PersistenceUnitRuntimeMBean objects for this EAR module.

Returns:: The persistenceUnitRuntimes value

getPersistenceUnitRuntime

PersistenceUnitRuntimeMBean getPersistenceUnitRuntime(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.
Since:: 10.3.0.0

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.
Since:: 12.1.2.0
See Also:: HealthState

getHealthStateJMX

CompositeData getHealthStateJMX()
                                throws OpenDataException

The health state for the application.

Returns:: The health state information for this application as CompositeData.
Throws:: OpenDataException

getOverallHealthStateJMX

CompositeData getOverallHealthStateJMX()
                                       throws OpenDataException

Returns:: The overall health state information for this application as CompositeData.
Throws:: OpenDataException

getCoherenceClusterRuntime

CoherenceClusterRuntimeMBean getCoherenceClusterRuntime()

Returns the Coherence Cluster related runtime MBean.

Returns:: CoherenceClusterRuntimeMBean
Since:: 10.3.3.0

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.
Since:: 12.1.3.0

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(String componentName,
                                                                   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(String componentName,
                                                                       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(String componentName,
                                                                                         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 -

Overview

Package