SessionManagerMXBean (Resin 4.0.s170329)

All Superinterfaces:

ManagedObjectMXBean

All Known Implementing Classes:

SessionManagerAdmin
```
public interface SessionManagerMXBean
extends ManagedObjectMXBean
```
Administration for the SessionManager for a WebApp. The JMX name looks like:
```
  resin:type=SessionManager,WebApp=/wiki,Host=caucho.com
 
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCookieDomain()` The host domain used for session cookies
`long`	`getCookieLength()` The length of the generated cookie
`long`	`getCookieMaxAge()` The session cookie max-age sent to the browser.
`java.lang.String`	`getCookieName()` The cookie name used for sessions.
`java.lang.String`	`getCookiePort()` The session cookie port sent to the client browser.
`int`	`getCookieVersion()` The cookie version sent to the browser.
`long`	`getEstimatedMemorySize()`
`PersistentStoreMXBean`	`getPersistentStore()` Returns the persistent store.
`java.lang.String`	`getSaveMode()` Returns the session save-mode.
`long`	`getSessionActiveCount()` Returns the count of active sessions.
`long`	`getSessionCreateCountTotal()` Returns the count of sessions created
`long`	`getSessionInvalidateCountTotal()` Returns the count of sessions invalidated
`int`	`getSessionMax()` The maximum number of sessions in memory.
`long`	`getSessionTimeout()` The maximum time an idle session will be saved.
`long`	`getSessionTimeoutCountTotal()` Returns the count of sessions timeout
`WebAppMXBean`	`getWebApp()` Returns the owning WebApp.
`boolean`	`isAlwaysSaveSession()` True if the session should be serialized for storage, even if no attributes in the session have been set.
`boolean`	`isCookieAppendServerIndex()` If true, the server's cluster index is appended to the cookie value.
`boolean`	`isCookieHttpOnly()` True if the cookie should only be used for http, not https requests.
`boolean`	`isCookieSecure()` True if the session cookie should only be sent on a secure connection.
`boolean`	`isEnableCookies()` True if the server reads and writes cookies
`boolean`	`isEnableURLRewriting()` (discouraged).
`boolean`	`isIgnoreSerializationErrors()` True if persistent sessions should ignore serialization errors.
`boolean`	`isInvalidateAfterListener()` True if the session should be invalidated only after listeners are called.
`boolean`	`isReuseSessionId()` True if session-id should be reused if no session exists.
`java.lang.String`	`sessionAsJsonString(java.lang.String id)`
`java.lang.String[]`	`sessionIdList()`
`java.lang.String`	`sessionsAsJsonString()`
`java.lang.String`	`sessionSerializationDebug(java.lang.String id)` Returns the debug string for a session
`int`	`stickySessionServer(java.lang.String sessionId, int n)`

Methods inherited from interface com.caucho.management.server.ManagedObjectMXBean
getName, getObjectName, getType

- Method Detail
  - getWebApp
```
WebAppMXBean getWebApp()
```
    Returns the owning WebApp.
  - getPersistentStore
```
PersistentStoreMXBean getPersistentStore()
```
    Returns the persistent store.
  - isAlwaysSaveSession
```
boolean isAlwaysSaveSession()
```
    True if the session should be serialized for storage, even if no attributes in the session have been set.
  - isCookieAppendServerIndex
```
boolean isCookieAppendServerIndex()
```
    If true, the server's cluster index is appended to the cookie value.
  - getCookieDomain
```
java.lang.String getCookieDomain()
```
    The host domain used for session cookies
  - isCookieHttpOnly
```
boolean isCookieHttpOnly()
```
    True if the cookie should only be used for http, not https requests.
  - getCookieLength
```
long getCookieLength()
```
    The length of the generated cookie
  - getCookieMaxAge
```
@Units(value="milliseconds")
long getCookieMaxAge()
```
    The session cookie max-age sent to the browser.
  - getCookieName
```
java.lang.String getCookieName()
```
    The cookie name used for sessions.
  - getCookiePort
```
java.lang.String getCookiePort()
```
    The session cookie port sent to the client browser.
  - isCookieSecure
```
boolean isCookieSecure()
```
    True if the session cookie should only be sent on a secure connection.
  - getCookieVersion
```
int getCookieVersion()
```
    The cookie version sent to the browser.
  - isEnableCookies
```
boolean isEnableCookies()
```
    True if the server reads and writes cookies
  - isEnableURLRewriting
```
boolean isEnableURLRewriting()
```
    (discouraged). True if the URL-rewriting is enabled. In general, URL-rewriting should be avoided as a security risk.
  - isIgnoreSerializationErrors
```
boolean isIgnoreSerializationErrors()
```
    True if persistent sessions should ignore serialization errors.
  - isInvalidateAfterListener
```
boolean isInvalidateAfterListener()
```
    True if the session should be invalidated only after listeners are called.
  - isReuseSessionId
```
boolean isReuseSessionId()
```
    True if session-id should be reused if no session exists. This should generally be true for web-app consistence.
  - getSaveMode
```
java.lang.String getSaveMode()
```
    Returns the session save-mode.
  - getSessionMax
```
int getSessionMax()
```
    The maximum number of sessions in memory. The number of persistent sessions may be larger.
  - getSessionTimeout
```
@Units(value="milliseconds")
long getSessionTimeout()
```
    The maximum time an idle session will be saved. session-timeout affects persistent sessions.
  - getSessionActiveCount
```
long getSessionActiveCount()
```
    Returns the count of active sessions.
  - getSessionCreateCountTotal
```
long getSessionCreateCountTotal()
```
    Returns the count of sessions created
  - getSessionInvalidateCountTotal
```
long getSessionInvalidateCountTotal()
```
    Returns the count of sessions invalidated
  - getSessionTimeoutCountTotal
```
long getSessionTimeoutCountTotal()
```
    Returns the count of sessions timeout
  - sessionSerializationDebug
```
java.lang.String sessionSerializationDebug(java.lang.String id)
```
    Returns the debug string for a session
  - sessionAsJsonString
```
java.lang.String sessionAsJsonString(java.lang.String id)
```
  - sessionIdList
```
java.lang.String[] sessionIdList()
```
  - sessionsAsJsonString
```
java.lang.String sessionsAsJsonString()
```
  - getEstimatedMemorySize
```
long getEstimatedMemorySize()
```
  - stickySessionServer
```
int stickySessionServer(java.lang.String sessionId,
                        int n)
```

Interface SessionManagerMXBean

Method Summary

Methods inherited from interface com.caucho.management.server.ManagedObjectMXBean

Method Detail

getWebApp

getPersistentStore

isAlwaysSaveSession

isCookieAppendServerIndex

getCookieDomain

isCookieHttpOnly

getCookieLength

getCookieMaxAge

getCookieName

getCookiePort

isCookieSecure

getCookieVersion

isEnableCookies

isEnableURLRewriting

isIgnoreSerializationErrors

isInvalidateAfterListener

isReuseSessionId

getSaveMode

getSessionMax

getSessionTimeout

getSessionActiveCount

getSessionCreateCountTotal

getSessionInvalidateCountTotal

getSessionTimeoutCountTotal

sessionSerializationDebug

sessionAsJsonString

sessionIdList

sessionsAsJsonString

getEstimatedMemorySize

stickySessionServer