SessionHandlerImpl (Vertx Javadocs 4.0.3.GA API)

java.lang.Object
- io.vertx.ext.web.handler.impl.SessionHandlerImpl

All Implemented Interfaces:

Handler<RoutingContext>, SessionHandler
```
public class SessionHandlerImpl
extends Object
implements SessionHandler
```
Author:

Tim Fox

Field Summary

Fields
Modifier and Type Field and Description

static String SESSION_FLUSHED_KEY

static String SESSION_STOREUSER_KEY

static String SESSION_USER_HOLDER_KEY
- Fields inherited from interface io.vertx.ext.web.handler.SessionHandler
  DEFAULT_COOKIE_HTTP_ONLY_FLAG, DEFAULT_COOKIE_SECURE_FLAG, DEFAULT_LAZY_SESSION, DEFAULT_NAG_HTTPS, DEFAULT_SESSION_COOKIE_NAME, DEFAULT_SESSION_COOKIE_PATH, DEFAULT_SESSION_TIMEOUT, DEFAULT_SESSIONID_MIN_LENGTH

Fields
Modifier and Type	Field and Description
`static String`	`SESSION_FLUSHED_KEY`
`static String`	`SESSION_STOREUSER_KEY`
`static String`	`SESSION_USER_HOLDER_KEY`

Constructor Summary

Constructors
Constructor and Description

SessionHandlerImpl(SessionStore sessionStore)

Constructors
Constructor and Description
`SessionHandlerImpl(SessionStore sessionStore)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SessionHandler`	`flush(RoutingContext context, boolean ignoreStatus, Handler<AsyncResult<Void>> handler)` Flush a context session earlier to the store, this will allow the end user to have full control on the event of a failure at the store level.
`SessionHandler`	`flush(RoutingContext context, Handler<AsyncResult<Void>> handler)` Flush a context session earlier to the store, this will allow the end user to have full control on the event of a failure at the store level.
`void`	`handle(RoutingContext context)` Something has happened, so handle it.
`Session`	`newSession(RoutingContext context)` Create a new session
`SessionHandler`	`setAuthProvider(AuthProvider authProvider)` Deprecated.
`SessionHandler`	`setCookieHttpOnlyFlag(boolean httpOnly)` Sets whether the 'HttpOnly' flag should be set for the session cookie.
`SessionHandler`	`setCookieless(boolean cookieless)` Use sessions based on url paths instead of cookies.
`SessionHandler`	`setCookieMaxAge(long cookieMaxAge)` Set a Cookie max-age to the session cookie.
`SessionHandler`	`setCookieSameSite(CookieSameSite policy)` Set the session cookie SameSite policy to use.
`SessionHandler`	`setCookieSecureFlag(boolean secure)` Sets whether the 'secure' flag should be set for the session cookie.
`SessionHandler`	`setLazySession(boolean lazySession)` Use a lazy session creation mechanism.
`SessionHandler`	`setMinLength(int minLength)` Set expected session id minimum length.
`SessionHandler`	`setNagHttps(boolean nag)` Set whether a nagging log warning should be written if the session handler is accessed over HTTP, not HTTPS
`SessionHandler`	`setSessionCookieName(String sessionCookieName)` Set the session cookie name
`SessionHandler`	`setSessionCookiePath(String sessionCookiePath)` Set the session cookie path
`SessionHandler`	`setSessionTimeout(long timeout)` Set the session timeout
`Future<Void>`	`setUser(RoutingContext context, User user)` Set the user for the session

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.ext.web.handler.SessionHandler
create, flush, flush, setUser

- Field Detail
  - SESSION_USER_HOLDER_KEY
```
public static final String SESSION_USER_HOLDER_KEY
```
    See Also:
    
    Constant Field Values
  - SESSION_FLUSHED_KEY
```
public static final String SESSION_FLUSHED_KEY
```
    See Also:
    
    Constant Field Values
  - SESSION_STOREUSER_KEY
```
public static final String SESSION_STOREUSER_KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SessionHandlerImpl
```
public SessionHandlerImpl(SessionStore sessionStore)
```
- Method Detail
  - setSessionTimeout
```
public SessionHandler setSessionTimeout(long timeout)
```
    Description copied from interface: SessionHandler
    
    Set the session timeout
    
    Specified by:
    
    setSessionTimeout in interface SessionHandler
    
    Parameters:
    
    timeout - the timeout, in ms.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setNagHttps
```
public SessionHandler setNagHttps(boolean nag)
```
    Description copied from interface: SessionHandler
    
    Set whether a nagging log warning should be written if the session handler is accessed over HTTP, not HTTPS
    
    Specified by:
    
    setNagHttps in interface SessionHandler
    
    Parameters:
    
    nag - true to nag
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setCookieSecureFlag
```
public SessionHandler setCookieSecureFlag(boolean secure)
```
    Description copied from interface: SessionHandler
    
    Sets whether the 'secure' flag should be set for the session cookie. When set this flag instructs browsers to only send the cookie over HTTPS. Note that this will probably stop your sessions working if used without HTTPS (e.g. in development).
    
    Specified by:
    
    setCookieSecureFlag in interface SessionHandler
    
    Parameters:
    
    secure - true to set the secure flag on the cookie
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setCookieHttpOnlyFlag
```
public SessionHandler setCookieHttpOnlyFlag(boolean httpOnly)
```
    Description copied from interface: SessionHandler
    
    Sets whether the 'HttpOnly' flag should be set for the session cookie. When set this flag instructs browsers to prevent Javascript access to the the cookie. Used as a line of defence against the most common XSS attacks.
    
    Specified by:
    
    setCookieHttpOnlyFlag in interface SessionHandler
    
    Parameters:
    
    httpOnly - true to set the HttpOnly flag on the cookie
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setSessionCookieName
```
public SessionHandler setSessionCookieName(String sessionCookieName)
```
    Description copied from interface: SessionHandler
    
    Set the session cookie name
    
    Specified by:
    
    setSessionCookieName in interface SessionHandler
    
    Parameters:
    
    sessionCookieName - the session cookie name
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setSessionCookiePath
```
public SessionHandler setSessionCookiePath(String sessionCookiePath)
```
    Description copied from interface: SessionHandler
    
    Set the session cookie path
    
    Specified by:
    
    setSessionCookiePath in interface SessionHandler
    
    Parameters:
    
    sessionCookiePath - the session cookie path
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setMinLength
```
public SessionHandler setMinLength(int minLength)
```
    Description copied from interface: SessionHandler
    
    Set expected session id minimum length.
    
    Specified by:
    
    setMinLength in interface SessionHandler
    
    Parameters:
    
    minLength - the session id minimal length
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setCookieSameSite
```
public SessionHandler setCookieSameSite(CookieSameSite policy)
```
    Description copied from interface: SessionHandler
    
    Set the session cookie SameSite policy to use.
    
    Specified by:
    
    setCookieSameSite in interface SessionHandler
    
    Parameters:
    
    policy - to use, null for no policy.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setLazySession
```
public SessionHandler setLazySession(boolean lazySession)
```
    Description copied from interface: SessionHandler
    
    Use a lazy session creation mechanism. The session will only be created when accessed from the context. Thus the session cookie is set only if the session was accessed.
    
    Specified by:
    
    setLazySession in interface SessionHandler
    
    Parameters:
    
    lazySession - true to have a lazy session creation.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setCookieMaxAge
```
public SessionHandler setCookieMaxAge(long cookieMaxAge)
```
    Description copied from interface: SessionHandler
    
    Set a Cookie max-age to the session cookie. When doing this the Cookie will be persistent across browser restarts. This can be dangerous as closing a browser windows does not invalidate the session. For more information refer to https://cheatsheetseries.owasp.org/cheatsheets/Session_Management_Cheat_Sheet.html#Expire_and_Max-Age_Attributes
    
    Specified by:
    
    setCookieMaxAge in interface SessionHandler
    
    Parameters:
    
    cookieMaxAge - a non negative max-age, note that 0 means expire now.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setAuthProvider
```
@Deprecated
public SessionHandler setAuthProvider(AuthProvider authProvider)
```
    Deprecated.
    
    Description copied from interface: SessionHandler
    
    Set an auth provider that will allow retrieving the User object from the session to the current routing context.
    
    Specified by:
    
    setAuthProvider in interface SessionHandler
    
    Parameters:
    
    authProvider - any auth provider.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setCookieless
```
public SessionHandler setCookieless(boolean cookieless)
```
    Description copied from interface: SessionHandler
    
    Use sessions based on url paths instead of cookies. This is an potential less safe alternative to cookies but offers an alternative when Cookies are not desired, for example, to avoid showing banners on a website due to cookie laws, or doing machine to machine operations where state is required to maintain.
    
    Specified by:
    
    setCookieless in interface SessionHandler
    
    Parameters:
    
    cookieless - true if a cookieless session should be used
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - flush
```
public SessionHandler flush(RoutingContext context,
                            Handler<AsyncResult<Void>> handler)
```
    Description copied from interface: SessionHandler
    
    Flush a context session earlier to the store, this will allow the end user to have full control on the event of a failure at the store level. Once a session is flushed no automatic save will be performed at end of request.
    
    Specified by:
    
    flush in interface SessionHandler
    
    Parameters:
    
    context - the current context
    
    handler - the event handler to signal a asynchronous response.
    
    Returns:
    
    fluent self
  - flush
```
public SessionHandler flush(RoutingContext context,
                            boolean ignoreStatus,
                            Handler<AsyncResult<Void>> handler)
```
    Description copied from interface: SessionHandler
    
    Flush a context session earlier to the store, this will allow the end user to have full control on the event of a failure at the store level. Once a session is flushed no automatic save will be performed at end of request.
    
    Specified by:
    
    flush in interface SessionHandler
    
    Parameters:
    
    context - the current context
    
    ignoreStatus - flush regardless of response status code
    
    handler - the event handler to signal a asynchronous response.
    
    Returns:
    
    fluent self
  - handle
```
public void handle(RoutingContext context)
```
    Description copied from interface: Handler
    
    Something has happened, so handle it.
    
    Specified by:
    
    handle in interface Handler<RoutingContext>
    
    Parameters:
    
    context - the event to handle
  - newSession
```
public Session newSession(RoutingContext context)
```
    Description copied from interface: SessionHandler
    
    Create a new session
    
    Specified by:
    
    newSession in interface SessionHandler
    
    Parameters:
    
    context - the routing context
    
    Returns:
    
    the session
  - setUser
```
public Future<Void> setUser(RoutingContext context,
                            User user)
```
    Description copied from interface: SessionHandler
    
    Set the user for the session
    
    Specified by:
    
    setUser in interface SessionHandler
    
    Parameters:
    
    context - the routing context
    
    user - the user
    
    Returns:
    
    future that will be called when complete, or a failure

Class SessionHandlerImpl

Field Summary

Fields inherited from interface io.vertx.ext.web.handler.SessionHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.vertx.ext.web.handler.SessionHandler

Field Detail

SESSION_USER_HOLDER_KEY

SESSION_FLUSHED_KEY

SESSION_STOREUSER_KEY

Constructor Detail

SessionHandlerImpl

Method Detail

setSessionTimeout

setNagHttps

setCookieSecureFlag

setCookieHttpOnlyFlag

setSessionCookieName

setSessionCookiePath

setMinLength

setCookieSameSite

setLazySession

setCookieMaxAge

setAuthProvider

setCookieless

flush

flush

handle

newSession

setUser