SessionCookieParameters (sessioncookie 1.0.0-beta API)

All Known Implementing Classes:

SessionCookieDefaultParameters
```
public interface SessionCookieParameters
```
All parameters used by SessionCookie. These parameters are not cached and will be called on HTTP request threads. It's important that each of these methods return immediately (no IO blocking) or request performance will be impacted.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_COOKIE_DOMAIN` `null`
`static String`	`DEFAULT_COOKIE_NAME` `org.baswell.sessioncookie`
`static int`	`DEFAULT_COOKIE_SIZE_WARNING` 4KB
`static int`	`DEFAULT_INACTIVITY_TIMEOUT_SECONDS` `-1`
`static int`	`DEFAULT_MAX_IN_MEMORY_SESSIONS` `-1`
`static int`	`DEFAULT_MINIMUM_SECONDS_BETWEEN_SESSION_CACHE_PURGES` `15`
`static boolean`	`DEFAULT_PURGE_SESSION_CACHE_WITH_BACKGROUND_THREAD` `false`
`static int`	`DEFAULT_SESSION_TIMEOUT_MINUTES` `30`
`static String`	`DEFAULT_SYMMETRIC_ENCRYPTION_ALGORITHM` `AES`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default String`	`getCookieDomain()` The domain set (`Cookie.setDomain(String)`) on the session cookie.
`default String`	`getCookieName()` The name used for the session cookie.
`default int`	`getCookieSizeWarning()` The minimum session cookie value size in bytes for `SessionCookieErrorHandler.onSessionCookieSizeWarning(HttpSession, int)` to be called.
`default int`	`getInactivityTimeoutSeconds()` The time, in seconds, between client requests that session are allowed to remain active.
`default int`	`getMaxInMemorySessions()` The maximum number of sessions that are cached in memory.
`default int`	`getMinimumSecondsBetweenSessionCachePurges()` The minimum number of seconds between session cache purges.
`default boolean`	`getPurgeSessionCacheWithBackgroundThread()` Indicates if a background thread should be used to removed candidates from the session cache.
`default int`	`getSessionTimeoutMinutes()` The time, in minutes, from creation time that sessions are allowed to remain active.
`default String`	`getSymmetricEncryptionAlgorithm()` The symmetric encryption algorithm used to encrypt and decrypt the session cookie.
`byte[]`	`getSymmetricEncryptionKey()` The symmetric encryption key used to encrypt and decrypt the session cookie.

- Field Detail
  - DEFAULT_SESSION_TIMEOUT_MINUTES
```
static final int DEFAULT_SESSION_TIMEOUT_MINUTES
```
    30
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INACTIVITY_TIMEOUT_SECONDS
```
static final int DEFAULT_INACTIVITY_TIMEOUT_SECONDS
```
    -1
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_IN_MEMORY_SESSIONS
```
static final int DEFAULT_MAX_IN_MEMORY_SESSIONS
```
    -1
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PURGE_SESSION_CACHE_WITH_BACKGROUND_THREAD
```
static final boolean DEFAULT_PURGE_SESSION_CACHE_WITH_BACKGROUND_THREAD
```
    false
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MINIMUM_SECONDS_BETWEEN_SESSION_CACHE_PURGES
```
static final int DEFAULT_MINIMUM_SECONDS_BETWEEN_SESSION_CACHE_PURGES
```
    15
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SYMMETRIC_ENCRYPTION_ALGORITHM
```
static final String DEFAULT_SYMMETRIC_ENCRYPTION_ALGORITHM
```
    AES
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COOKIE_DOMAIN
```
static final String DEFAULT_COOKIE_DOMAIN
```
    null
  - DEFAULT_COOKIE_NAME
```
static final String DEFAULT_COOKIE_NAME
```
    org.baswell.sessioncookie
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COOKIE_SIZE_WARNING
```
static final int DEFAULT_COOKIE_SIZE_WARNING
```
    4KB
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getSessionTimeoutMinutes
```
default int getSessionTimeoutMinutes()
```
    The time, in minutes, from creation time that sessions are allowed to remain active. A negative time indicates the session should never timeout.
    
    Returns:
    
    DEFAULT_SESSION_TIMEOUT_MINUTES by default
  - getInactivityTimeoutSeconds
```
default int getInactivityTimeoutSeconds()
```
    The time, in seconds, between client requests that session are allowed to remain active. A negative time indicates the session should never timeout.
    
    Returns:
    
    DEFAULT_INACTIVITY_TIMEOUT_SECONDS by default
  - getMaxInMemorySessions
```
default int getMaxInMemorySessions()
```
    The maximum number of sessions that are cached in memory. A zero or negative value indicates that no sessions are cached.
    
    Returns:
    
    DEFAULT_MAX_IN_MEMORY_SESSIONS by default
  - getPurgeSessionCacheWithBackgroundThread
```
default boolean getPurgeSessionCacheWithBackgroundThread()
```
    Indicates if a background thread should be used to removed candidates from the session cache. If false sessions will be removed from the cache on request threads.
    
    Returns:
    
    DEFAULT_PURGE_SESSION_CACHE_WITH_BACKGROUND_THREAD by default
  - getMinimumSecondsBetweenSessionCachePurges
```
default int getMinimumSecondsBetweenSessionCachePurges()
```
    The minimum number of seconds between session cache purges.
    
    Returns:
    
    DEFAULT_MINIMUM_SECONDS_BETWEEN_SESSION_CACHE_PURGES by default
  - getSymmetricEncryptionAlgorithm
```
default String getSymmetricEncryptionAlgorithm()
```
    The symmetric encryption algorithm used to encrypt and decrypt the session cookie.
    
    Returns:
    
    DEFAULT_SYMMETRIC_ENCRYPTION_ALGORITHM by default
  - getSymmetricEncryptionKey
```
byte[] getSymmetricEncryptionKey()
                          throws GeneralSecurityException
```
    The symmetric encryption key used to encrypt and decrypt the session cookie.
    
    Returns:
    
    The encoded key value
    
    Throws:
    
    GeneralSecurityException - if the key cannot be generated
  - getCookieDomain
```
default String getCookieDomain()
```
    The domain set (Cookie.setDomain(String)) on the session cookie.
    
    Returns:
    
    DEFAULT_COOKIE_DOMAIN by default
  - getCookieName
```
default String getCookieName()
```
    The name used for the session cookie.
    
    Returns:
    
    DEFAULT_COOKIE_NAME by default
  - getCookieSizeWarning
```
default int getCookieSizeWarning()
```
    The minimum session cookie value size in bytes for SessionCookieErrorHandler.onSessionCookieSizeWarning(HttpSession, int) to be called.
    
    Returns:
    
    DEFAULT_COOKIE_SIZE_WARNING by default
    
    See Also:
    
    SessionCookieErrorHandler.onSessionCookieSizeWarning(HttpSession, int)

Interface SessionCookieParameters

Field Summary

Method Summary

Field Detail

DEFAULT_SESSION_TIMEOUT_MINUTES

DEFAULT_INACTIVITY_TIMEOUT_SECONDS

DEFAULT_MAX_IN_MEMORY_SESSIONS

DEFAULT_PURGE_SESSION_CACHE_WITH_BACKGROUND_THREAD

DEFAULT_MINIMUM_SECONDS_BETWEEN_SESSION_CACHE_PURGES

DEFAULT_SYMMETRIC_ENCRYPTION_ALGORITHM

DEFAULT_COOKIE_DOMAIN

DEFAULT_COOKIE_NAME

DEFAULT_COOKIE_SIZE_WARNING

Method Detail

getSessionTimeoutMinutes

getInactivityTimeoutSeconds

getMaxInMemorySessions

getPurgeSessionCacheWithBackgroundThread

getMinimumSecondsBetweenSessionCachePurges

getSymmetricEncryptionAlgorithm

getSymmetricEncryptionKey

getCookieDomain

getCookieName

getCookieSizeWarning