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

Part Number E27170-02

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:

ApplicationRuntimeMBean encapsulates runtime information about a deployed Enterprise application.

Access limited to the following security roles:
Operator

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
 int getActiveVersionState()
          Specifies whether this application version is the currently active version.
 String getApplicationName()
          The name of the Enterprise application.
 String getApplicationVersion()
          The Enterprise application's version identifier.
 ClassRedefinitionRuntimeMBean getClassRedefinitionRuntime()
          If class fast-swap feature is enabled for the application, return the runtime mbean to monitor and control the class fast-swap within the application.
 CoherenceClusterRuntimeMBean getCoherenceClusterRuntime()
          Returns the Coherence Cluster related runtime mbean
 ComponentRuntimeMBean[] getComponentRuntimes()
          Returns the list of component runtime instances for each J2EE component (such as an EJB or a Web application) that is contained in this Enterprise application.
 HealthState getHealthState()
          The HealthState mbean for the application.
 KodoPersistenceUnitRuntimeMBean getKodoPersistenceUnitRuntime(String unitName)
          Deprecated. As of 11.1.2.0, use getPersistenceUnitRuntime instead
 KodoPersistenceUnitRuntimeMBean[] getKodoPersistenceUnitRuntimes()
          Deprecated. As of 11.1.2.0, use getPersistenceUnitRuntimes instead
 LibraryRuntimeMBean[] getLibraryRuntimes()
          Returns the list of library runtime instances for each J2EE library that is contained in this Enterprise application.
 MaxThreadsConstraintRuntimeMBean[] getMaxThreadsConstraintRuntimes()
          Get the runtime mbeans for all MaxThreadsConstraints defined at the app-level
 MinThreadsConstraintRuntimeMBean[] getMinThreadsConstraintRuntimes()
          Get the runtime mbeans for all MinThreadsConstraints defined at the app-level
 LibraryRuntimeMBean[] getOptionalPackageRuntimes()
          Returns the list of optional package runtime instances for each J2EE 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.
 PersistenceUnitRuntimeMBean getPersistenceUnitRuntime(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 app-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
 ComponentRuntimeMBean[] lookupComponents()
          Deprecated.  
 QueryCacheRuntimeMBean lookupQueryCacheRuntime(String cacheName)
          Returns a QueryCacheRuntimeMBean for the app-scoped query-cache with name 'cacheName'.
 WorkManagerRuntimeMBean lookupWorkManagerRuntime(String componentName, String wmName)
          Lookup the WorkManagerRuntimeMBean given the component name and work manager name.
 WseeV2RuntimeMBean lookupWseeV2Runtime(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 weblogic.management.WebLogicMBean
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, 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 Enterprise application.

Returns:
The applicationName value

getApplicationVersion

String getApplicationVersion()

The Enterprise 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 in which 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 one 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

Access limited to the following security roles:
Deployer

getComponentRuntimes

ComponentRuntimeMBean[] getComponentRuntimes()

Returns the list of component runtime instances for each J2EE 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 J2EE library that is contained in this Enterprise application.

Returns:
LibraryRuntimeMBean Array, null if this App is not referencing any Libraries.

getOptionalPackageRuntimes

LibraryRuntimeMBean[] getOptionalPackageRuntimes()

Returns the list of optional package runtime instances for each J2EE optional package that is contained in this Enterprise application.

Returns:
LibraryRuntimeMBean Array, null if this App 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(String componentName,
                                                 String wmName)

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


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 app-level


getMinThreadsConstraintRuntimes

MinThreadsConstraintRuntimeMBean[] getMinThreadsConstraintRuntimes()

Get the runtime mbeans for all MinThreadsConstraints defined at the app-level


getRequestClassRuntimes

RequestClassRuntimeMBean[] getRequestClassRuntimes()

Get the runtime mbeans for all request classes defined at the app-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(String cacheName)

Returns a QueryCacheRuntimeMBean for the app-scoped query-cache with name '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 class fast-swap feature is enabled for the application, return the runtime mbean to monitor and control the class fast-swap within the application.

Returns:
Runtime mbean to monitor and control class fast-swap 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. Currenly 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

getCoherenceClusterRuntime

CoherenceClusterRuntimeMBean getCoherenceClusterRuntime()

Returns the Coherence Cluster related runtime mbean

Returns:
CoherenceClusterRuntimeMBean

Copyright 1996, 2013, 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.1.2)

Part Number E27170-02