Type-Safe Access to BEA WebLogic Server 9.2 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)

weblogic.management.runtime
Interface WebAppComponentRuntimeMBean

All Superinterfaces:

ComponentRuntimeMBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.management.runtime.RuntimeMBean, weblogic.management.WebLogicMBean

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. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

Field Summary

Fields inherited from interface weblogic.management.runtime.ComponentRuntimeMBean

ACTIVATED, NEW, PREPARED, UNPREPARED

Method Summary

void	deleteInvalidSessions() Invalidates expired sessions.
String	getComponentName() Provides the name of this component.
String	getContextRoot() Returns the context root (context path) for the webapp
String	getJSPCompileCommand() Provides the jsp's compileCommand as it is configured in weblogic.xml.
long	getJSPPageCheckSecs() Provides the jsp's PageCheckSecs as it is configured in weblogic.xml.
weblogic.management.runtime.LibraryRuntimeMBean[]	getLibraryRuntimes() Returns the list of library runtime instances for each J2EE library that is contained in this Enterprise application.
String	getLogFilename() Returns the log filename as configured in the "logging/log-filename" element in weblogic.xml
weblogic.management.runtime.LogRuntimeMBean	getLogRuntime() Returns the log runtime associated with the j2ee webapp log
String	getModuleURI() Returns the web-uri as configured in application.xml for the webapp.
String	getMonitoringId(String sessionId) Returns the monitoring id for a session for a given sessionId
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.
weblogic.management.runtime.PageFlowsRuntimeMBean	getPageFlows() Provides an hook for getting Beehive runtime metrics for the current 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(String sessionID) Deprecated. as of WebLogic 9.0
ServletSessionRuntimeMBean[]	getServletSessions() Deprecated. as of WebLogic 9.0, use getServletSessionsMonitoringTags()
String[]	getServletSessionsMonitoringIds() This method returns an array of monitoring Ids for http sessions.
String	getSessionCookieComment() By default, all applications on WebLogic Server specify "WebLogic Session Tracking Cookie" as the cookie comment.
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.
String	getSessionCookieName() By default, all applications on WebLogic Server specify "JSESSIONID" as the cookie name.
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(String monitoringId) Provides a record of the last time this session was accessed.
long	getSessionMaxInactiveInterval(String monitoringId) Returns the timeout (seconds) for the session corresponding to the given monitoringId.
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.
String	getSourceInfo() Provides an informative string about the module's source.
String	getStatus() Provides the status of the component.
void	invalidateServletSession(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.

Methods inherited from interface weblogic.management.runtime.ComponentRuntimeMBean

getDeploymentState, getModuleId, getWorkManagerRuntimes

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, 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

Method Detail

deleteInvalidSessions

public void deleteInvalidSessions()

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

getComponentName

public String getComponentName()

Provides the name of this component.

Returns:

The componentName value

getContextRoot

public String getContextRoot()

Returns the context root (context path) for the webapp

Returns:

The contextRoot value

getJSPCompileCommand

public String getJSPCompileCommand()

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

Returns:

The jSPCompileCommand value

getJSPPageCheckSecs

public long getJSPPageCheckSecs()

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

Returns:

The jSPPageCheckSecs value

getLibraryRuntimes

public weblogic.management.runtime.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.

getLogFilename

public 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

public weblogic.management.runtime.LogRuntimeMBean getLogRuntime()

Returns the log runtime associated with the j2ee webapp log

Returns:

LogRuntimeMBean associated with the webapp log

getModuleURI

public 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

getMonitoringId

public 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

getName

public String getName()

Provides the name of this mbean.

Specified by:

getName in interface weblogic.management.WebLogicMBean

Returns:

The name value

getOpenSessionsCurrentCount

public 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

public 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

getPageFlows

public weblogic.management.runtime.PageFlowsRuntimeMBean getPageFlows()

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

Returns:

The Runtime MBean that surfaces Beehive runtime metrics

getServletReloadCheckSecs

public int getServletReloadCheckSecs()

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

Returns:

The servletReloadCheckSecs value

getServlets

public ServletRuntimeMBean[] getServlets()

Provides an array of ServletRuntimeMBeans associated with this module

Return an array of ServletRuntimeMBeans associated with this component

Returns:

The servlets value

getServletSession

public ServletSessionRuntimeMBean getServletSession(String sessionID)

Deprecated. as of WebLogic 9.0

Provides the servlet session by its session ID.

Parameters:

sessionID -

Returns:

The servletSession value

getServletSessions

public 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()

getServletSessionsMonitoringIds

public 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

getSessionCookieComment

public 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

public 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 Cookie.setDomain() in the Servlet specification from Sun Microsystems.

Returns:

The sessionCookieDomain value

getSessionCookieMaxAgeSecs

public 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

getSessionCookieName

public 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

getSessionCookiePath

public String getSessionCookiePath()

Provides the path name to which clients send cookies.

Returns:

The sessionCookiePath value

getSessionIDLength

public int getSessionIDLength()

Provides the session ID length configured for http sessions.

Returns:

The sessionIDLength value

getSessionInvalidationIntervalSecs

public int getSessionInvalidationIntervalSecs()

Provides the invalidation check timer interval configured for http sessions.

Returns:

The sessionInvalidationIntervalSecs value

getSessionLastAccessedTime

public 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:

getServletSessionsMonitoringIds()

getSessionMaxInactiveInterval

public 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:

getServletSessionsMonitoringIds()

getSessionsOpenedTotalCount

public int getSessionsOpenedTotalCount()

Provides a count of the total number of sessions opened.

Returns:

The sessionsOpenedTotalCount value

getSessionTimeoutSecs

public int getSessionTimeoutSecs()

Provides the timeout configured for http sessions.

Returns:

The sessionTimeoutSecs value

getSingleThreadedServletPoolSize

public int getSingleThreadedServletPoolSize()

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

Returns:

The singleThreadedServletPoolSize value

getSourceInfo

public String getSourceInfo()

Provides an informative string about the module's source.

Return an informative string about the component's source.

Returns:

The sourceInfo value

getStatus

public String getStatus()

Provides the status of the component.

Returns:

The status value

invalidateServletSession

public 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:

getServletSessionsMonitoringIds()

isFilterDispatchedRequestsEnabled

public boolean isFilterDispatchedRequestsEnabled()

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

Returns:

The filterDispatchedRequestsEnabled value

isIndexDirectoryEnabled

public boolean isIndexDirectoryEnabled()

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

Returns:

The indexDirectoryEnabled value

isJSPDebug

public boolean isJSPDebug()

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

Returns:

The jSPDebug value

isJSPKeepGenerated

public boolean isJSPKeepGenerated()

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

Returns:

The jSPKeepGenerated value

isJSPVerbose

public boolean isJSPVerbose()

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

Returns:

The jSPVerbose value

isSessionMonitoringEnabled

public boolean isSessionMonitoringEnabled()

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

Returns:

The sessionMonitoringEnabled value