weblogic.management.runtime
Interface WebAppComponentRuntimeMBean

All Superinterfaces:

ComponentRuntimeMBean

public interface WebAppComponentRuntimeMBean
extends ComponentRuntimeMBean

Describes a servlet component (servlet context).

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.

Access limited to the following security roles:

Operator

getApplicationIdentifier

String getApplicationIdentifier()

Provides the identifier of the application that contains the web module

Returns:

The application identifier.

getName

String getName()

Provides the name of this mbean.

Returns:

The name value

getComponentName

String getComponentName()

Provides the name of this component.

Returns:

The componentName value

getContextRoot

String getContextRoot()

Returns the context root (context path) for the webapp

Returns:

The contextRoot value

getModuleURI

String getModuleURI()

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

Returns:

the module URI for the webapp

getStatus

String getStatus()

Provides the status of the component.

Returns:

The status value

getSourceInfo

String getSourceInfo()

Provides an informative string about the module's source.

Return an informative string about the component's source.

Returns:

The sourceInfo value

getServlets

ServletRuntimeMBean[] getServlets()

Provides an array of ServletRuntimeMBeans associated with this module

Return an array of ServletRuntimeMBeans associated with this component

Returns:

The servlets value

getOpenSessionsCurrentCount

int getOpenSessionsCurrentCount()

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.

Returns:

The openSessionsCurrentCount value

getOpenSessionsHighCount

int getOpenSessionsHighCount()

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.

Returns:

The openSessionsHighCount value

getSessionsOpenedTotalCount

int getSessionsOpenedTotalCount()

Provides a count of the total number of sessions opened.

Returns:

The sessionsOpenedTotalCount value

getServletSessions

ServletSessionRuntimeMBean[] getServletSessions()

Deprecated. as of WebLogic 9.0, use getServletSessionsMonitoringTags()

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

Returns:

The servletSessions value

See Also:

WebAppComponentRuntimeMBean.getServletSessionsMonitoringIds()

getServletSession

ServletSessionRuntimeMBean getServletSession(String sessionID)

Deprecated. as of WebLogic 9.0

Provides the servlet session by its session ID.

Parameters:

sessionID -

Returns:

The servletSession value

getServletSessionsMonitoringIds

String[] getServletSessionsMonitoringIds()

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.

Returns:

monitoring ids for http sessions

invalidateServletSession

void invalidateServletSession(String monitoringId)
                              throws IllegalStateException

Invalidates this session for a given monitoring id.

Parameters:

monitoringId -

Throws:

IllegalStateException - if sessions has been invalidated already

See Also:

WebAppComponentRuntimeMBean.getServletSessionsMonitoringIds()

getSessionLastAccessedTime

long getSessionLastAccessedTime(String monitoringId)
                                throws IllegalStateException

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

Parameters:

monitoringId -

Returns:

The lastAccessedTime for a session

Throws:

IllegalStateException - if sessions has been invalidated already

See Also:

WebAppComponentRuntimeMBean.getServletSessionsMonitoringIds()

getSessionMaxInactiveInterval

long getSessionMaxInactiveInterval(String monitoringId)
                                   throws IllegalStateException

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

Parameters:

monitoringId -

Returns:

session's maxInactiveInterval

Throws:

IllegalStateException - if sessions has been invalidated already

See Also:

WebAppComponentRuntimeMBean.getServletSessionsMonitoringIds()

getMonitoringId

String getMonitoringId(String sessionId)

Returns the monitoring id for a session for a given sessionId

Parameters:

sessionId -

Returns:

monitoring ID

Throws:

IllegalStateException - if sessions has been invalidated already

deleteInvalidSessions

void deleteInvalidSessions()

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

getSessionTimeoutSecs

int getSessionTimeoutSecs()

Provides the timeout configured for http sessions.

Returns:

The sessionTimeoutSecs value

getSessionInvalidationIntervalSecs

int getSessionInvalidationIntervalSecs()

Provides the invalidation check timer interval configured for http sessions.

Returns:

The sessionInvalidationIntervalSecs value

getSessionIDLength

int getSessionIDLength()

Provides the session ID length configured for http sessions.

Returns:

The sessionIDLength value

getSessionCookieComment

String getSessionCookieComment()

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.

Returns:

The sessionCookieComment value

getSessionCookieDomain

String getSessionCookieDomain()

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.

Returns:

The sessionCookieDomain value

getSessionCookiePath

String getSessionCookiePath()

Provides the path name to which clients send cookies.

Returns:

The sessionCookiePath value

getSessionCookieName

String getSessionCookieName()

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.

Returns:

The sessionCookieName value

getSessionCookieMaxAgeSecs

int getSessionCookieMaxAgeSecs()

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.

Returns:

The sessionCookieMaxAgeSecs value

isFilterDispatchedRequestsEnabled

boolean isFilterDispatchedRequestsEnabled()

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

Returns:

The filterDispatchedRequestsEnabled value

isIndexDirectoryEnabled

boolean isIndexDirectoryEnabled()

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

Returns:

The indexDirectoryEnabled value

getServletReloadCheckSecs

int getServletReloadCheckSecs()

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

Returns:

The servletReloadCheckSecs value

getSingleThreadedServletPoolSize

int getSingleThreadedServletPoolSize()

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

Returns:

The singleThreadedServletPoolSize value

isSessionMonitoringEnabled

boolean isSessionMonitoringEnabled()

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

Returns:

The sessionMonitoringEnabled value

isJSPKeepGenerated

boolean isJSPKeepGenerated()

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

Returns:

The jSPKeepGenerated value

isJSPVerbose

boolean isJSPVerbose()

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

Returns:

The jSPVerbose value

isJSPDebug

boolean isJSPDebug()

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

Returns:

The jSPDebug value

getJSPPageCheckSecs

long getJSPPageCheckSecs()

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

Returns:

The jSPPageCheckSecs value

getJSPCompileCommand

String getJSPCompileCommand()

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

Returns:

The jSPCompileCommand value

getLogFilename

String getLogFilename()

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

Returns:

The name of the logfile. null if not configured.

getLogRuntime

LogRuntimeMBean getLogRuntime()

Returns the log runtime associated with the j2ee webapp log

Returns:

LogRuntimeMBean associated with the webapp log

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.

getPageFlows

PageFlowsRuntimeMBean getPageFlows()

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

Returns:

The Runtime MBean that surfaces Beehive runtime metrics

setSpringRuntimeMBean

void setSpringRuntimeMBean(SpringRuntimeMBean springRuntimeMBean)

Provides an hook for getting Spring runtime for the current module

getSpringRuntimeMBean

SpringRuntimeMBean getSpringRuntimeMBean()

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

getWebPubSubRuntime

WebPubSubRuntimeMBean getWebPubSubRuntime()

Get Http Pub/Sub Server Runtime of this webapp

setWebPubSubRuntime

void setWebPubSubRuntime(WebPubSubRuntimeMBean webPubSubRuntimeMBean)

Set Http Pub/Sub Server Runtime of this webapp

getCoherenceClusterRuntime

CoherenceClusterRuntimeMBean getCoherenceClusterRuntime()

Returns the Coherence Cluster related runtime mbean for this component

Returns:

CoherenceClusterRuntimeMBean

Since:

10.3.3.0

getWseeClientRuntimes

WseeClientRuntimeMBean[] getWseeClientRuntimes()

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

Returns:

lookupWseeClientRuntime

WseeClientRuntimeMBean lookupWseeClientRuntime(String rawClientId)

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

Parameters:

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

Returns:

The client runtime or null if no such client could be found.

getWseeV2Runtimes

WseeV2RuntimeMBean[] getWseeV2Runtimes()

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

Returns:

lookupWseeV2Runtime

WseeV2RuntimeMBean lookupWseeV2Runtime(String name)

Returns a named Web Service runtime instance that is contained in this web app within an 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.

getWseeClientConfigurationRuntimes

WseeClientConfigurationRuntimeMBean[] getWseeClientConfigurationRuntimes()

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

Returns:

lookupWseeClientConfigurationRuntime

WseeClientConfigurationRuntimeMBean lookupWseeClientConfigurationRuntime(String name)

Returns a named Web Service client reference configuration runtime instance that is contained in this web app within an Enterprise application.

Parameters:

name - The web service client reference name to look up.

Returns:

The web service client reference configuration runtime or null if no web service client reference configuration runtime with the given name could be found.