WebAppComponentRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Describes a servlet component (servlet context).

       
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • Operator
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.runtime.WebAppComponentRuntimeMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.


Related MBeans

This section describes attributes that provide access to other MBeans.


CoherenceClusterRuntime

Returns the Coherence Cluster related runtime mbean for this component

       
Privileges Read only
TypeCoherenceClusterRuntimeMBean
Relationship type: Reference.

KodoPersistenceUnitRuntimes

Provides an array of KodoPersistenceUnitRuntimeMBean objects for this EJB module.

       
Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
Privileges Read only
TypeKodoPersistenceUnitRuntimeMBean[]
Relationship type: Containment.

LibraryRuntimes

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

       
Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
Privileges Read only
TypeLibraryRuntimeMBean[]
Relationship type: Containment.

LogRuntime

Returns the log runtime associated with the j2ee webapp log

       
Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
Privileges Read only
TypeLogRuntimeMBean
Relationship type: Containment.

PageFlows

Provides an hook for getting Beehive runtime metrics for the current module

       
Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
Privileges Read only
TypePageFlowsRuntimeMBean
Relationship type: Containment.

Servlets

Provides an array of ServletRuntimeMBeans associated with this module

Return an array of ServletRuntimeMBeans associated with this component

       
Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
Privileges Read only
TypeServletRuntimeMBean[]
Relationship type: Containment.

ServletSessions

Provides an array of ServletSessionRuntimeMBeans associated with this component. This operation should only be done by explicit poll request (no real-time monitoring). This method will return a non-empty array only when session-monitoring has been turned on in weblogic.xml

Deprecated. as of WebLogic 9.0, use getServletSessionsMonitoringTags()

For more information, see:

       
Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
Privileges Read only
TypeServletSessionRuntimeMBean[]
Relationship type: Containment.

SpringRuntimeMBean

       
Privileges Read/Write
TypeSpringRuntimeMBean
Relationship type: Reference.
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

WebPubSubRuntime

Get Http Pub/Sub Server Runtime of this webapp

       
Privileges Read/Write
TypeWebPubSubRuntimeMBean
Relationship type: Reference.
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

WorkManagerRuntimes

Get the runtime mbeans for all work managers defined in this component

       
Privileges Read only
TypeWorkManagerRuntimeMBean[]
Relationship type: Reference.

WseeClientConfigurationRuntimes

Returns the list of Web Service client reference configuration runtime instances that are contained in this web app within an Enterprise application.

           
Lookup OperationlookupWseeClientConfigurationRuntime(String name)

Returns a javax.management.ObjectName for the instance of WseeClientConfigurationRuntimeMBean named name.

Privileges Read only
TypeWseeClientConfigurationRuntimeMBean[]
Relationship type: Reference.

WseeClientRuntimes

Returns the list of Web Service client runtime instances that are contained in this Enterprise JavaBean component.

           
Lookup OperationlookupWseeClientRuntime(String name)

Returns a javax.management.ObjectName for the instance of WseeClientRuntimeMBean named name.

Privileges Read only
TypeWseeClientRuntimeMBean[]
Relationship type: Reference.

WseeV2Runtimes

Returns the list of Web Service runtime instances that are contained in this web app within an Enterprise application.

           
Lookup OperationlookupWseeV2Runtime(String name)

Returns a javax.management.ObjectName for the instance of WseeV2RuntimeMBean named name.

Privileges Read only
TypeWseeV2RuntimeMBean[]
Relationship type: Reference.


Attributes

This section describes the following attributes:


ApplicationIdentifier

Provides the identifier of the application that contains the web module

       
Privileges Read only
Typejava.lang.String

CachingDisabled

Private property that disables caching in proxies.

       
Privileges Read only
Typeboolean

ComponentName

Provides the name of this component.

       
Privileges Read only
Typejava.lang.String

ContextRoot

Returns the context root (context path) for the webapp

       
Privileges Read only
Typejava.lang.String

DeploymentState

The current deployment state of the module.

A module can be in one and only one of the following states. State can be changed via deployment or administrator console.

- UNPREPARED. State indicating at this module is neither prepared or active.

- PREPARED. State indicating at this module of this application is prepared, but not active. The classes have been loaded and the module has been validated.

- ACTIVATED. State indicating at this module is currently active.

- NEW. State indicating this module has just been created and is being initialized.

For more information, see:

       
Privileges Read only
Typeint

FilterDispatchedRequestsEnabled

Indicates whether the dispatched requests are filtered as configured in weblogic.xml.

       
Privileges Read only
Typeboolean

IndexDirectoryEnabled

Provides the directory indexing indicator as it is configured in weblogic.xml.

       
Privileges Read only
Typeboolean

JSPCompileCommand

Provides the jsp's compileCommand as it is configured in weblogic.xml.

       
Privileges Read only
Typejava.lang.String

JSPDebug

Provides the jsp's debug/linenumbers parameter value as it is configured in weblogic.xml.

       
Privileges Read only
Typeboolean

JSPKeepGenerated

Provides the jsp's KeepGenerated parameter value as it is configured in weblogic.xml.

       
Privileges Read only
Typeboolean

JSPPageCheckSecs

Provides the jsp's PageCheckSecs as it is configured in weblogic.xml.

       
Privileges Read only
Typelong

JSPVerbose

Provides the jsp's verbose parameter value as it is configured in weblogic.xml.

       
Privileges Read only
Typeboolean

LogFilename

Returns the log filename as configured in the "logging/log-filename" element in weblogic.xml

       
Privileges Read only
Typejava.lang.String

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

       
Privileges Read only
Typejavax.management.MBeanInfo

ModuleId

Returns the identifier for this Component. The identifier is unique within the application.

Typical modules will use the URI for their id. Web Modules will return their context-root since the web-uri may not be unique within an EAR.

       
Privileges Read only
Typejava.lang.String

ModuleURI

Returns the web-uri as configured in application.xml for the webapp. For a standalone war it will return the docroot (if exploded) or name of the war file (if archived).

       
Privileges Read only
Typejava.lang.String

Name

Provides the name of this mbean.

       
Privileges Read only
Typejava.lang.String

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

Deprecated.

       
Privileges Read only
Typeweblogic.management.WebLogicObjectName

OpenSessionsCurrentCount

Provides a count of the current total number of open sessions in this module.

Returns the current total number of open sessions in this component.

       
Privileges Read only
Typeint

OpenSessionsHighCount

Provides the high water mark of the total number of open sessions in this server. The count starts at zero each time the server is activated. Note that this is an optimization method for a highly useful statistic that could be implemented less efficiently using change notification.

       
Privileges Read only
Typeint

Parent

Return the immediate parent for this MBean

       
Privileges Read/Write
Type

Registered

Returns false if the MBean represented by this object has been unregistered.

Deprecated.

       
Privileges Read only
Typeboolean

ServletReloadCheckSecs

Provides the servlet reload check seconds as it is configured in weblogic.xml.

       
Privileges Read only
Typeint

ServletSessionsMonitoringIds

This method returns an array of monitoring Ids for http sessions. By default the monitoring id for a given http session is a random string (not the same as session id for security reasons). If the value of the element monitoring-attribute-name in session-descriptor of weblogic.xml is set, the monitoring id will be the toString() of the attribute value in the session, using monitoring-attribute-name as the key.

       
Privileges Read only
Typeclass java.lang.String[]

SessionCookieComment

By default, all applications on WebLogic Server specify "WebLogic Session Tracking Cookie" as the cookie comment. To provide a more specific comment, edit your application's weblogic.xml deployment descriptor.

       
Privileges Read only
Typejava.lang.String

SessionCookieDomain

By default, clients can return cookies only to the server that issued the cookie. You can change this default behavior by editing your application's weblogic.xml deployment descriptor.

For more information, see the Servlet specification from Sun Microsystems.

       
Privileges Read only
Typejava.lang.String

SessionCookieMaxAgeSecs

Provides the life span of the session cookie, in seconds, after which it expires on the client. If the value is 0, the cookie expires immediately.
If set to -1, the cookie expires when the user exits the browser.

       
Privileges Read only
Typeint

SessionCookieName

By default, all applications on WebLogic Server specify "JSESSIONID" as the cookie name. To provide a more specific name, edit your application's weblogic.xml deployment descriptor.

       
Privileges Read only
Typejava.lang.String

SessionCookiePath

Provides the path name to which clients send cookies.

       
Privileges Read only
Typejava.lang.String

SessionIDLength

Provides the session ID length configured for http sessions.

       
Privileges Read only
Typeint

SessionInvalidationIntervalSecs

Provides the invalidation check timer interval configured for http sessions.

       
Privileges Read only
Typeint

SessionMonitoringEnabled

Provides the session monitoring indicator as it is configured in weblogic.xml.

       
Privileges Read only
Typeboolean

SessionsOpenedTotalCount

Provides a count of the total number of sessions opened.

       
Privileges Read only
Typeint

SessionTimeoutSecs

Provides the timeout configured for http sessions.

       
Privileges Read only
Typeint

SingleThreadedServletPoolSize

Provides the single threaded servlet pool size as it is configured in weblogic.xml.

       
Privileges Read only
Typeint

SourceInfo

Provides an informative string about the module's source.

Return an informative string about the component's source.

       
Privileges Read only
Typejava.lang.String

Status

Provides the status of the component.

       
Privileges Read only
Typejava.lang.String

Type

Returns the type of the MBean.

       
Privileges Read only
Typejava.lang.String


Operations

This section describes the following operations:


deleteInvalidSessions

Invalidates expired sessions. This is useful to do the cleanup if the session invalidation trigger is too large.

   
Operation Name"deleteInvalidSessions"
Parametersnull
Signaturenull
Returns void

getKodoPersistenceUnitRuntime

Provides the KodoPersistenceUnitRuntimeMBean for the EJB with the specified name.

   
Operation Name"getKodoPersistenceUnitRuntime"
ParametersObject [] {  unitName }

where:

  • unitName is an object of type java.lang.String that specifies:

    unitName

SignatureString [] { "java.lang.String" }
ReturnsKodoPersistenceUnitRuntimeMBean

getMonitoringId

Returns the monitoring id for a session for a given sessionId

   
Operation Name"getMonitoringId"
ParametersObject [] {  sessionId }

where:

  • sessionId is an object of type java.lang.String that specifies:

    sessionId

SignatureString [] { "java.lang.String" }
ReturnsString

getServletSession

Provides the servlet session by its session ID.

Deprecated. as of WebLogic 9.0

   
Operation Name"getServletSession"
ParametersObject [] {  sessionID }

where:

  • sessionID is an object of type java.lang.String that specifies:

    sessionID

SignatureString [] { "java.lang.String" }
ReturnsServletSessionRuntimeMBean

getSessionLastAccessedTime

Provides a record of the last time this session was accessed. You need to pass the string returned by getServletSessionsMonitoringIds()

For more information, see:

   
Operation Name"getSessionLastAccessedTime"
ParametersObject [] {  monitoringId }

where:

  • monitoringId is an object of type java.lang.String that specifies:

    monitoringId

SignatureString [] { "java.lang.String" }
Returns long
Exceptions
  • java.lang.IllegalStateException
    IllegalStateException if sessions has been invalidated already

getSessionMaxInactiveInterval

Returns the timeout (seconds) for the session corresponding to the given monitoringId.

For more information, see:

   
Operation Name"getSessionMaxInactiveInterval"
ParametersObject [] {  monitoringId }

where:

  • monitoringId is an object of type java.lang.String that specifies:

    monitoringId

SignatureString [] { "java.lang.String" }
Returns long
Exceptions
  • java.lang.IllegalStateException
    IllegalStateException if sessions has been invalidated already

invalidateServletSession

Invalidates this session for a given monitoring id.

For more information, see:

   
Operation Name"invalidateServletSession"
ParametersObject [] {  monitoringId }

where:

  • monitoringId is an object of type java.lang.String that specifies:

    monitoringId

SignatureString [] { "java.lang.String" }
Returns void
Exceptions
  • java.lang.IllegalStateException
    IllegalStateException if sessions has been invalidated already

lookupWseeClientRuntime

Returns a named Web Service client runtime instances that is contained in this Enterprise JavaBean component.

   
Operation Name"lookupWseeClientRuntime"
ParametersObject [] {  rawClientId }

where:

  • rawClientId is an object of type java.lang.String that specifies:

    The raw client ID of the client to lookup. This ID does not contain the application/component qualifiers that are prepended to the full client ID for the client.

SignatureString [] { "java.lang.String" }
ReturnsWseeClientRuntimeMBean

preDeregister

   
Operation Name"preDeregister"
Parametersnull
Signaturenull
Returns void
Exceptions
  • java.lang.Exception