Package weblogic.management.runtime

Interface WebAppComponentRuntimeMBean

All Superinterfaces:

ComponentConcurrentRuntimeMBean, ComponentRuntimeMBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface WebAppComponentRuntimeMBean
extends ComponentConcurrentRuntimeMBean

Describes a servlet component (servlet context).

Access limited to the following security roles:

Operator

Field Summary

Fields inherited from interface weblogic.management.runtime.ComponentRuntimeMBean

ACTIVATED, NEW, PREPARED, UNPREPARED

Method Summary

Modifier and Type	Method	Description
void	deleteInvalidSessions()	Invalidates expired sessions.
java.lang.String	getApplicationIdentifier()	Provides the identifier of the application that contains the web module.
CoherenceClusterRuntimeMBean	getCoherenceClusterRuntime()	Returns the Coherence Cluster related runtime MBean for this component.
java.lang.String	getComponentName()	Provides the name of this component.
java.lang.String	getConfiguredContextRoot()	Returns the context root (context path) configured in weblogic-application.xml or web.xml file, or determined by name of the war file.
java.lang.String	getContextRoot()	Returns the context root (context path) for the web application.
EJBRuntimeMBean	getEJBRuntime(java.lang.String ejbName)	Provides the EJBRuntimeMBean for the EJB with the specified name.
EJBRuntimeMBean[]	getEJBRuntimes()	Provides an array of EJBRuntimeMBean objects for this module.
JaxRsApplicationRuntimeMBean[]	getJaxRsApplications()	Provides an array of JaxRsApplicationMBeans associated with this module.
java.lang.String	getJSPCompileCommand()	Provides the JSP's compileCommand value as it is configured in weblogic.xml.
long	getJSPPageCheckSecs()	Provides the JSP's PageCheckSecs value as it is configured in weblogic.xml.
LibraryRuntimeMBean[]	getLibraryRuntimes()	Returns the list of library runtime instances for each Java EE library that is contained in this enterprise application.
java.lang.String	getLogFilename()	Returns the log filename as configured in the "logging/log-filename" element in weblogic.xml.
LogRuntimeMBean	getLogRuntime()	Returns the log runtime associated with the Java EE web application log.
java.lang.String	getModuleURI()	Returns the web URI as configured in application.xml for the web application.
java.lang.String	getMonitoringId(java.lang.String sessionId)	Returns the monitoring ID for a session for a given session ID.
java.lang.String	getName()	Provides the name of this MBean.
int	getOpenSessionsCurrentCount()	Provides a count of the current total number of open sessions in this module.
int	getOpenSessionsHighCount()	Provides the high water mark of the total number of open sessions in this server.
PageFlowsRuntimeMBean	getPageFlows()	Provides a hook for getting Beehive runtime metrics for the current module.
PersistenceUnitRuntimeMBean	getPersistenceUnitRuntime(java.lang.String unitName)	Provides the PersistenceUnitRuntimeMBean for the web application with the specified name.
PersistenceUnitRuntimeMBean[]	getPersistenceUnitRuntimes()	Provides an array of PersistenceUnitRuntimeMBean objects for this web application module.
int	getServletReloadCheckSecs()	Provides the servlet reload check seconds as it is configured in weblogic.xml.
ServletRuntimeMBean[]	getServlets()	Provides an array of ServletRuntimeMBeans associated with this module.
ServletSessionRuntimeMBean	getServletSession(java.lang.String sessionID)	Deprecated. as of WebLogic 9.0
ServletSessionRuntimeMBean[]	getServletSessions()	Deprecated. as of WebLogic 9.0, use getServletSessionsMonitoringTags()
java.lang.String[]	getServletSessionsMonitoringIds()	This method returns an array of monitoring IDs for HTTP sessions.
java.lang.String	getSessionCookieComment()	By default, all applications on WebLogic Server specify "WebLogic Session Tracking Cookie" as the cookie comment.
java.lang.String	getSessionCookieDomain()	By default, clients can return cookies only to the server that issued the cookie.
int	getSessionCookieMaxAgeSecs()	Provides the life span of the session cookie, in seconds, after which it expires on the client.
java.lang.String	getSessionCookieName()	By default, all applications on WebLogic Server specify "JSESSIONID" as the cookie name.
java.lang.String	getSessionCookiePath()	Provides the path name to which clients send cookies.
int	getSessionIDLength()	Provides the session ID length configured for HTTP sessions.
int	getSessionInvalidationIntervalSecs()	Provides the invalidation check timer interval configured for HTTP sessions.
long	getSessionLastAccessedTime(java.lang.String monitoringId)	Provides a record of the last time this session was accessed.
long	getSessionMaxInactiveInterval(java.lang.String monitoringId)	Returns the timeout (seconds) for the session corresponding to the given monitoring ID.
int	getSessionsOpenedTotalCount()	Provides a count of the total number of sessions opened.
int	getSessionTimeoutSecs()	Provides the timeout configured for HTTP sessions.
int	getSingleThreadedServletPoolSize()	Provides the single threaded servlet pool size as it is configured in weblogic.xml.
java.lang.String	getSourceInfo()	Provides an informative string about the module's source.
SpringRuntimeMBean	getSpringRuntimeMBean()
java.lang.String	getStatus()	Provides the status of the component.
WebPubSubRuntimeMBean	getWebPubSubRuntime()	Get HTTP pub-sub server runtime of this web application.
WebsocketApplicationRuntimeMBean	getWebsocketApplicationRuntimeMBean()	Provides a WebsocketApplicationRuntimeMBean associated with this module.
WseeClientConfigurationRuntimeMBean[]	getWseeClientConfigurationRuntimes()	Returns the list of Web Service client reference configuration runtime instances that are contained in this web application within an enterprise application.
WseeClientRuntimeMBean[]	getWseeClientRuntimes()	Returns the list of Web Service client runtime instances that are contained in this Enterprise JavaBean component.
WseeV2RuntimeMBean[]	getWseeV2Runtimes()	Returns the list of Web Service runtime instances that are contained in this web application within an enterprise application.
void	invalidateServletSession(java.lang.String monitoringId)	Invalidates this session for a given monitoring ID.
boolean	isFilterDispatchedRequestsEnabled()	Indicates whether the dispatched requests are filtered as configured in weblogic.xml.
boolean	isIndexDirectoryEnabled()	Provides the directory indexing indicator as it is configured in weblogic.xml.
boolean	isJSPDebug()	Provides the JSP's debug/linenumbers parameter value as it is configured in weblogic.xml.
boolean	isJSPKeepGenerated()	Provides the JSP's KeepGenerated parameter value as it is configured in weblogic.xml.
boolean	isJSPVerbose()	Provides the JSP's verbose parameter value as it is configured in weblogic.xml.
boolean	isSessionMonitoringEnabled()	Provides the session monitoring indicator as it is configured in weblogic.xml.
JaxRsApplicationRuntimeMBean	lookupJaxRsApplication(java.lang.String name)	Finds the JAX-RS application identified by name that is nothing but the corresponding servlet name.
WseeClientConfigurationRuntimeMBean	lookupWseeClientConfigurationRuntime(java.lang.String name)	Returns a named Web Service client reference configuration runtime instance that is contained in this web application within an enterprise application.
WseeClientRuntimeMBean	lookupWseeClientRuntime(java.lang.String rawClientId)	Returns a named Web Service client runtime instance that is contained in this Enterprise JavaBean component.
WseeV2RuntimeMBean	lookupWseeV2Runtime(java.lang.String name)	Returns a named Web Service runtime instance that is contained in this web application within an enterprise application.

Methods inherited from interface weblogic.management.runtime.ComponentConcurrentRuntimeMBean

getManagedExecutorServiceRuntimes, getManagedScheduledExecutorServiceRuntimes, getManagedThreadFactoryRuntimes

Methods inherited from interface weblogic.management.runtime.ComponentRuntimeMBean

getDeploymentState, getModuleId, getWorkManagerRuntimes

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Method Detail

getApplicationIdentifier

java.lang.String getApplicationIdentifier()

Provides the identifier of the application that contains the web module.

Returns:

The application identifier.

getName

java.lang.String getName()

Provides the name of this MBean.

Specified by:

getName in interface WebLogicMBean

Returns:

The name value

getComponentName

java.lang.String getComponentName()

Provides the name of this component.

Returns:

The componentName value

getContextRoot

java.lang.String getContextRoot()

Returns the context root (context path) for the web application.

Returns:

The contextRoot value

getConfiguredContextRoot

java.lang.String getConfiguredContextRoot()

Returns the context root (context path) configured in weblogic-application.xml or web.xml file, or determined by name of the war file.

For web application deployed in partition scope, this configured context root does not include uriPrefix of the virtual target. The getContextRoot() method returns value which includes the uriPrefix of the virtual target.

For web application deployed in domain scope, this method returns same value as getContextRoot() method.

Returns:

The configured contextRoot value

getModuleURI

java.lang.String getModuleURI()

Returns the web URI as configured in application.xml for the web application. For a standalone WAR, it will return the docroot (if exploded) or the name of the WAR file (if archived).

Returns:

the module URI for the web application

getStatus

java.lang.String getStatus()

Provides the status of the component.

Returns:

The status value

getSourceInfo

java.lang.String getSourceInfo()

Provides an informative string about the module's source.

Returns an informative string about the component's source.

Returns:

The sourceInfo value

getServlets

ServletRuntimeMBean[] getServlets()

Provides an array of ServletRuntimeMBeans associated with this module.

Returns an array of ServletRuntimeMBeans associated with this component.

Returns:

The servlet value

getEJBRuntimes

EJBRuntimeMBean[] getEJBRuntimes()

Provides an array of EJBRuntimeMBean objects for this module. The EJBRuntimeMBean instances can be cast to their appropriate subclass (EntityEJBRuntimeMBean, StatelessEJBRuntimeMBean, StatefulEJBRuntimeMBean or MessageDrivenEJBRuntimeMBean) to access additional runtime information for the particular EJB.

Returns:

The eJBRuntimes value

getEJBRuntime

EJBRuntimeMBean getEJBRuntime(java.lang.String ejbName)

Provides the EJBRuntimeMBean for the EJB with the specified name.

Parameters:

ejbName -

Returns:

The eJBRuntime value

getJaxRsApplications

JaxRsApplicationRuntimeMBean[] getJaxRsApplications()

Provides an array of JaxRsApplicationMBeans associated with this module.

Returns:

The array of JAX-RS application MBeans

lookupJaxRsApplication

JaxRsApplicationRuntimeMBean lookupJaxRsApplication(java.lang.String name)

Finds the JAX-RS application identified by name that is nothing but the corresponding servlet name.

Parameters:

name - the name of the runtime MBean

Returns:

the JAX-RS application when found or null

getWebsocketApplicationRuntimeMBean

WebsocketApplicationRuntimeMBean getWebsocketApplicationRuntimeMBean()

Provides a WebsocketApplicationRuntimeMBean associated with this module.

Returns:

WebSocket application runtime MBean

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

@Deprecated
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:

getServletSessionsMonitoringIds()

getServletSession

@Deprecated
ServletSessionRuntimeMBean getServletSession(java.lang.String sessionID)

Deprecated.

as of WebLogic 9.0

Provides the servlet session by its session ID.

Parameters:

sessionID -

Returns:

The servletSession value

getServletSessionsMonitoringIds

java.lang.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(java.lang.String monitoringId)
                       throws java.lang.IllegalStateException

Invalidates this session for a given monitoring ID.

Parameters:

monitoringId -

Throws:

java.lang.IllegalStateException - if sessions has been invalidated already

See Also:

getServletSessionsMonitoringIds()

getSessionLastAccessedTime

long getSessionLastAccessedTime(java.lang.String monitoringId)
                         throws java.lang.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:

java.lang.IllegalStateException - if sessions has been invalidated already

See Also:

getServletSessionsMonitoringIds()

getSessionMaxInactiveInterval

long getSessionMaxInactiveInterval(java.lang.String monitoringId)
                            throws java.lang.IllegalStateException

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

Parameters:

monitoringId -

Returns:

session's maxInactiveInterval

Throws:

java.lang.IllegalStateException - if sessions have been invalidated already

See Also:

getServletSessionsMonitoringIds()

getMonitoringId

java.lang.String getMonitoringId(java.lang.String sessionId)

Returns the monitoring ID for a session for a given session ID.

Parameters:

sessionId -

Returns:

monitoring ID

Throws:

java.lang.IllegalStateException - if sessions have been invalidated already

deleteInvalidSessions

void deleteInvalidSessions()

Invalidates expired sessions. This is useful for 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

java.lang.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

java.lang.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.

Returns:

The sessionCookieDomain value

getSessionCookiePath

java.lang.String getSessionCookiePath()

Provides the path name to which clients send cookies.

Returns:

The sessionCookiePath value

getSessionCookieName

java.lang.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 value as it is configured in weblogic.xml.

Returns:

The jSPPageCheckSecs value

getJSPCompileCommand

java.lang.String getJSPCompileCommand()

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

Returns:

The jSPCompileCommand value

getLogFilename

java.lang.String getLogFilename()

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

Returns:

The name of the log file. Null if not configured.

getLogRuntime

LogRuntimeMBean getLogRuntime()

Returns the log runtime associated with the Java EE web application log.

Returns:

LogRuntimeMBean associated with the web application log

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.

getPageFlows

PageFlowsRuntimeMBean getPageFlows()

Provides a hook for getting Beehive runtime metrics for the current module.

Returns:

The Runtime MBean that surfaces Beehive runtime metrics

getSpringRuntimeMBean

SpringRuntimeMBean getSpringRuntimeMBean()

getPersistenceUnitRuntimes

PersistenceUnitRuntimeMBean[] getPersistenceUnitRuntimes()

Provides an array of PersistenceUnitRuntimeMBean objects for this web application module.

Returns:

The persistenceUnitRuntimes value

getPersistenceUnitRuntime

PersistenceUnitRuntimeMBean getPersistenceUnitRuntime(java.lang.String unitName)

Provides the PersistenceUnitRuntimeMBean for the web application with the specified name.

Parameters:

unitName -

Returns:

The persistenceUnitRuntime value

getWebPubSubRuntime

WebPubSubRuntimeMBean getWebPubSubRuntime()

Get HTTP pub-sub server runtime of this web application.

getCoherenceClusterRuntime

CoherenceClusterRuntimeMBean getCoherenceClusterRuntime()

Returns the Coherence Cluster related runtime MBean for this component.

Returns:

CoherenceClusterRuntimeMBean

getWseeClientRuntimes

WseeClientRuntimeMBean[] getWseeClientRuntimes()

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

lookupWseeClientRuntime

WseeClientRuntimeMBean lookupWseeClientRuntime(java.lang.String rawClientId)

Returns a named Web Service client runtime instance 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 application within an enterprise application.

lookupWseeV2Runtime

WseeV2RuntimeMBean lookupWseeV2Runtime(java.lang.String name)

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

lookupWseeClientConfigurationRuntime

WseeClientConfigurationRuntimeMBean lookupWseeClientConfigurationRuntime(java.lang.String name)

Returns a named Web Service client reference configuration runtime instance that is contained in this web application 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.