weblogic.management.runtime
Interface ApplicationRuntimeMBean

public interface ApplicationRuntimeMBean

An application represents a J2EE 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 at least one module in this application is currently active.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/products/weblogic/index.html.

Access limited to the following security roles:

Operator

UNPREPARED

static final int UNPREPARED

State indicating that none of the modules in this application are currently prepared or active.

PREPARED

static final int PREPARED

State indicating at least one module in this application is prepared, but none are active.

ACTIVATED

static final int ACTIVATED

State indicating at least one module in this application is currently active.

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 weblogic.deploy.version.AppActiveVersionState for state values.

lookupComponents

ComponentRuntimeMBean[] lookupComponents()

Deprecated. 

The ComponentRuntimeMBean's contained in this application

Returns:

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.

Returns:

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.

Since:

9.0.0.0

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.

Since:

9.0.0.0

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.

Returns:

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

Since:

9.0.0.0

getMinThreadsConstraintRuntimes

MinThreadsConstraintRuntimeMBean[] getMinThreadsConstraintRuntimes()

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

Since:

9.0.0.0

getRequestClassRuntimes

RequestClassRuntimeMBean[] getRequestClassRuntimes()

Get the runtime mbeans for all request classes defined at the app-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.

Returns:

lookupQueryCacheRuntime

QueryCacheRuntimeMBean lookupQueryCacheRuntime(String cacheName)

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

Returns:

getKodoPersistenceUnitRuntimes

KodoPersistenceUnitRuntimeMBean[] getKodoPersistenceUnitRuntimes()

Provides an array of KodoPersistenceUnitRuntimeMBean objects for this EJB module.

Returns:

The persistenceUnitRuntimes value

getKodoPersistenceUnitRuntime

KodoPersistenceUnitRuntimeMBean getKodoPersistenceUnitRuntime(String unitName)

Provides the KodoPersistenceUnitRuntimeMBean for the EJB 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.

Since:

10.3.0.0

getHealthState

HealthState getHealthState()

The HealthState mbean for the application.

See weblogic.health.HealthState for state values.

Returns:

Runtime mbean to get health state information for this application.

getCoherenceClusterRuntime

CoherenceClusterRuntimeMBean getCoherenceClusterRuntime()

Returns the Coherence Cluster related runtime mbean

Returns:

CoherenceClusterRuntimeMBean

Since:

10.3.3.0