|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WebAppComponentRuntimeMBean
Describes a servlet component (servlet context).
Field Summary |
---|
Fields inherited from interface weblogic.management.runtime.ComponentRuntimeMBean |
---|
ACTIVATED, NEW, PREPARED, UNPREPARED |
Method Summary | |
---|---|
abstract void |
deleteInvalidSessions() Invalidates expired sessions. |
abstract String |
getApplicationIdentifier() Provides the identifier of the application that contains the web module. |
abstract CoherenceClusterRuntimeMBean |
getCoherenceClusterRuntime() Returns the Coherence Cluster related runtime MBean for this component. |
abstract String |
getComponentName() Provides the name of this component. |
abstract 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. |
abstract String |
getContextRoot() Returns the context root (context path) for the web application. |
abstract EJBRuntimeMBean |
getEJBRuntime(String ejbName) Provides the EJBRuntimeMBean for the EJB with the specified name. |
abstract EJBRuntimeMBean[] |
getEJBRuntimes() Provides an array of EJBRuntimeMBean objects for this module. |
abstract JaxRsApplicationRuntimeMBean[] |
getJaxRsApplications() Provides an array of JaxRsApplicationMBeans associated with this module. |
abstract String |
getJSPCompileCommand() Provides the JSP's compileCommand value as it is configured in weblogic.xml. |
abstract long |
getJSPPageCheckSecs() Provides the JSP's PageCheckSecs value as it is configured in weblogic.xml. |
abstract KodoPersistenceUnitRuntimeMBean |
getKodoPersistenceUnitRuntime(String unitName) Deprecated. As of 11.1.2.0, use getPersistenceUnitRuntime instead |
abstract KodoPersistenceUnitRuntimeMBean[] |
getKodoPersistenceUnitRuntimes() Deprecated. As of 11.1.2.0, use getPersistenceUnitRuntimes instead |
abstract LibraryRuntimeMBean[] |
getLibraryRuntimes() Returns the list of library runtime instances for each Java EE library that is contained in this enterprise application. |
abstract String |
getLogFilename() Returns the log filename as configured in the "logging/log-filename" element in weblogic.xml. |
abstract LogRuntimeMBean |
getLogRuntime() Returns the log runtime associated with the Java EE web application log. |
abstract String |
getModuleURI() Returns the web URI as configured in application.xml for the web application. |
abstract String |
getMonitoringId(String sessionId) Returns the monitoring ID for a session for a given session ID. |
abstract String |
getName() Provides the name of this MBean. |
abstract int |
getOpenSessionsCurrentCount() Provides a count of the current total number of open sessions in this module. |
abstract int |
getOpenSessionsHighCount() Provides the high water mark of the total number of open sessions in this server. |
abstract PageFlowsRuntimeMBean |
getPageFlows() Provides a hook for getting Beehive runtime metrics for the current module. |
abstract PersistenceUnitRuntimeMBean |
getPersistenceUnitRuntime(String unitName) Provides the PersistenceUnitRuntimeMBean for the web application with the specified name. |
abstract PersistenceUnitRuntimeMBean[] |
getPersistenceUnitRuntimes() Provides an array of PersistenceUnitRuntimeMBean objects for this web application module. |
abstract int |
getServletReloadCheckSecs() Provides the servlet reload check seconds as it is configured in weblogic.xml. |
abstract ServletRuntimeMBean[] |
getServlets() Provides an array of ServletRuntimeMBeans associated with this module. |
abstract ServletSessionRuntimeMBean |
getServletSession(String sessionID) Deprecated. as of WebLogic 9.0 |
abstract ServletSessionRuntimeMBean[] |
getServletSessions() Deprecated. as of WebLogic 9.0, use getServletSessionsMonitoringTags() |
abstract String[] |
getServletSessionsMonitoringIds() This method returns an array of monitoring IDs for HTTP sessions. |
abstract String |
getSessionCookieComment() By default, all applications on WebLogic Server specify "WebLogic Session Tracking Cookie" as the cookie comment. |
abstract String |
getSessionCookieDomain() By default, clients can return cookies only to the server that issued the cookie. |
abstract int |
getSessionCookieMaxAgeSecs() Provides the life span of the session cookie, in seconds, after which it expires on the client. |
abstract String |
getSessionCookieName() By default, all applications on WebLogic Server specify "JSESSIONID" as the cookie name. |
abstract String |
getSessionCookiePath() Provides the path name to which clients send cookies. |
abstract int |
getSessionIDLength() Provides the session ID length configured for HTTP sessions. |
abstract int |
getSessionInvalidationIntervalSecs() Provides the invalidation check timer interval configured for HTTP sessions. |
abstract long |
getSessionLastAccessedTime(String monitoringId) Provides a record of the last time this session was accessed. |
abstract long |
getSessionMaxInactiveInterval(String monitoringId) Returns the timeout (seconds) for the session corresponding to the given monitoring ID. |
abstract int |
getSessionsOpenedTotalCount() Provides a count of the total number of sessions opened. |
abstract int |
getSessionTimeoutSecs() Provides the timeout configured for HTTP sessions. |
abstract int |
getSingleThreadedServletPoolSize() Provides the single threaded servlet pool size as it is configured in weblogic.xml. |
abstract String |
getSourceInfo() Provides an informative string about the module's source. |
abstract SpringRuntimeMBean |
getSpringRuntimeMBean() |
abstract String |
getStatus() Provides the status of the component. |
abstract WebPubSubRuntimeMBean |
getWebPubSubRuntime() Get HTTP pub-sub server runtime of this web application. |
abstract WebsocketApplicationRuntimeMBean |
getWebsocketApplicationRuntimeMBean() Provides a WebsocketApplicationRuntimeMBean associated with this module. |
abstract WseeClientConfigurationRuntimeMBean[] |
getWseeClientConfigurationRuntimes() Returns the list of Web Service client reference configuration runtime instances that are contained in this web application within an enterprise application. |
abstract WseeClientRuntimeMBean[] |
getWseeClientRuntimes() Returns the list of Web Service client runtime instances that are contained in this Enterprise JavaBean component. |
abstract WseeV2RuntimeMBean[] |
getWseeV2Runtimes() Returns the list of Web Service runtime instances that are contained in this web application within an enterprise application. |
abstract void |
invalidateServletSession(String monitoringId) Invalidates this session for a given monitoring ID. |
abstract boolean |
isFilterDispatchedRequestsEnabled() Indicates whether the dispatched requests are filtered as configured in weblogic.xml. |
abstract boolean |
isIndexDirectoryEnabled() Provides the directory indexing indicator as it is configured in weblogic.xml. |
abstract boolean |
isJSPDebug() Provides the JSP's debug/linenumbers parameter value as it is configured in weblogic.xml. |
abstract boolean |
isJSPKeepGenerated() Provides the JSP's KeepGenerated parameter value as it is configured in weblogic.xml. |
abstract boolean |
isJSPVerbose() Provides the JSP's verbose parameter value as it is configured in weblogic.xml. |
abstract boolean |
isSessionMonitoringEnabled() Provides the session monitoring indicator as it is configured in weblogic.xml. |
abstract JaxRsApplicationRuntimeMBean |
lookupJaxRsApplication(String name) Finds the JAX-RS application identified by name that is nothing but the corresponding servlet name. |
abstract WseeClientConfigurationRuntimeMBean |
lookupWseeClientConfigurationRuntime(String name) Returns a named Web Service client reference configuration runtime instance that is contained in this web application within an enterprise application. |
abstract WseeClientRuntimeMBean |
lookupWseeClientRuntime(String rawClientId) Returns a named Web Service client runtime instance that is contained in this Enterprise JavaBean component. |
abstract WseeV2RuntimeMBean |
lookupWseeV2Runtime(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 weblogic.management.runtime.RuntimeMBean |
---|
addPropertyChangeListener, removePropertyChangeListener |
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 |
---|
String getApplicationIdentifier()
Provides the identifier of the application that contains the web module.
String getName()
Provides the name of this MBean.
getName
in interface WebLogicMBean
String getComponentName()
Provides the name of this component.
String getContextRoot()
Returns the context root (context path) for the web application.
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 WebAppComponentRuntimeMBean.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 WebAppComponentRuntimeMBean.getContextRoot()
method.
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).
String getStatus()
Provides the status of the component.
String getSourceInfo()
Provides an informative string about the module's source.
Returns an informative string about the component's source.
ServletRuntimeMBean[] getServlets()
Provides an array of ServletRuntimeMBeans associated with this module.
Returns an array of ServletRuntimeMBeans associated with this component.
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.
EJBRuntimeMBean getEJBRuntime(String ejbName)
Provides the EJBRuntimeMBean for the EJB with the specified name.
ejbName
-JaxRsApplicationRuntimeMBean[] getJaxRsApplications()
Provides an array of JaxRsApplicationMBeans associated with this module.
JaxRsApplicationRuntimeMBean lookupJaxRsApplication(String name)
Finds the JAX-RS application identified by name that is nothing but the corresponding servlet name.
name
- the name of the runtime MBeanWebsocketApplicationRuntimeMBean getWebsocketApplicationRuntimeMBean()
Provides a WebsocketApplicationRuntimeMBean associated with this module.
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.
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.
int getSessionsOpenedTotalCount()
Provides a count of the total number of sessions opened.
ServletSessionRuntimeMBean[] getServletSessions()
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.
WebAppComponentRuntimeMBean.getServletSessionsMonitoringIds()
ServletSessionRuntimeMBean getServletSession(String sessionID)
Provides the servlet session by its session ID.
sessionID
-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.
void invalidateServletSession(String monitoringId) throws IllegalStateException
Invalidates this session for a given monitoring ID.
monitoringId
-IllegalStateException
- if sessions has been invalidated alreadyWebAppComponentRuntimeMBean.getServletSessionsMonitoringIds()
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().
monitoringId
-IllegalStateException
- if sessions has been invalidated alreadyWebAppComponentRuntimeMBean.getServletSessionsMonitoringIds()
long getSessionMaxInactiveInterval(String monitoringId) throws IllegalStateException
Returns the timeout (seconds) for the session corresponding to the given monitoring ID.
monitoringId
-IllegalStateException
- if sessions have been invalidated alreadyWebAppComponentRuntimeMBean.getServletSessionsMonitoringIds()
String getMonitoringId(String sessionId)
Returns the monitoring ID for a session for a given session ID.
sessionId
-IllegalStateException
- if sessions have been invalidated alreadyvoid deleteInvalidSessions()
Invalidates expired sessions. This is useful for cleanup if the session invalidation trigger is too large.
int getSessionTimeoutSecs()
Provides the timeout configured for HTTP sessions.
int getSessionInvalidationIntervalSecs()
Provides the invalidation check timer interval configured for HTTP sessions.
int getSessionIDLength()
Provides the session ID length configured for HTTP sessions.
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.
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.
String getSessionCookiePath()
Provides the path name to which clients send cookies.
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.
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.
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.
int getServletReloadCheckSecs()
Provides the servlet reload check seconds as it is configured in weblogic.xml.
int getSingleThreadedServletPoolSize()
Provides the single threaded servlet pool size as it is configured in weblogic.xml.
boolean isSessionMonitoringEnabled()
Provides the session monitoring indicator 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 isJSPDebug()
Provides the JSP's debug/linenumbers parameter value as it is configured in weblogic.xml.
long getJSPPageCheckSecs()
Provides the JSP's PageCheckSecs value as it is configured in weblogic.xml.
String getJSPCompileCommand()
Provides the JSP's compileCommand value as it is configured in weblogic.xml.
String getLogFilename()
LogRuntimeMBean getLogRuntime()
Returns the log runtime associated with the Java EE web application log.
LibraryRuntimeMBean[] getLibraryRuntimes()
Returns the list of library runtime instances for each Java EE library that is contained in this enterprise application.
PageFlowsRuntimeMBean getPageFlows()
Provides a hook for getting Beehive runtime metrics for the current module.
SpringRuntimeMBean getSpringRuntimeMBean()
KodoPersistenceUnitRuntimeMBean[] getKodoPersistenceUnitRuntimes()
Provides an array of KodoPersistenceUnitRuntimeMBean objects for this web application module.
KodoPersistenceUnitRuntimeMBean getKodoPersistenceUnitRuntime(String unitName)
Provides the KodoPersistenceUnitRuntimeMBean for the web application with the specified name.
unitName
-PersistenceUnitRuntimeMBean[] getPersistenceUnitRuntimes()
Provides an array of PersistenceUnitRuntimeMBean objects for this web application module.
PersistenceUnitRuntimeMBean getPersistenceUnitRuntime(String unitName)
Provides the PersistenceUnitRuntimeMBean for the web application with the specified name.
unitName
-WebPubSubRuntimeMBean getWebPubSubRuntime()
CoherenceClusterRuntimeMBean getCoherenceClusterRuntime()
Returns the Coherence Cluster related runtime MBean for this component.
WseeClientRuntimeMBean[] getWseeClientRuntimes()
Returns the list of Web Service client runtime instances that are contained in this Enterprise JavaBean component.
WseeClientRuntimeMBean lookupWseeClientRuntime(String rawClientId)
Returns a named Web Service client runtime instance that is contained in this Enterprise JavaBean component.
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.WseeV2RuntimeMBean[] getWseeV2Runtimes()
Returns the list of Web Service runtime instances that are contained in this web application within an enterprise application.
WseeV2RuntimeMBean lookupWseeV2Runtime(String name)
Returns a named Web Service runtime instance that is contained in this web application within an enterprise application.
name
- The web service description name of the web service to look up.WseeClientConfigurationRuntimeMBean[] getWseeClientConfigurationRuntimes()
Returns the list of Web Service client reference configuration runtime instances that are contained in this web application within an enterprise application.
WseeClientConfigurationRuntimeMBean lookupWseeClientConfigurationRuntime(String name)
Returns a named Web Service client reference configuration runtime instance that is contained in this web application within an enterprise application.
name
- The web service client reference name to look up.
|
Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |