Class HeaderWebSessionIdResolver

java.lang.Object
org.springframework.web.server.session.HeaderWebSessionIdResolver
All Implemented Interfaces:
WebSessionIdResolver

public class HeaderWebSessionIdResolver extends Object implements WebSessionIdResolver
Request and response header-based WebSessionIdResolver.
Since:
5.0
Author:
Greg Turnquist, Rob Winch
  • Field Details

  • Constructor Details

    • HeaderWebSessionIdResolver

      public HeaderWebSessionIdResolver()
  • Method Details

    • setHeaderName

      public void setHeaderName(String headerName)
      Set the name of the session header to use for the session id. The name is used to extract the session id from the request headers as well to set the session id on the response headers.

      By default set to DEFAULT_HEADER_NAME

      Parameters:
      headerName - the header name
    • getHeaderName

      public String getHeaderName()
      Return the configured header name.
      Returns:
      the configured header name
    • resolveSessionIds

      public List<String> resolveSessionIds(ServerWebExchange exchange)
      Description copied from interface: WebSessionIdResolver
      Resolve the session id's associated with the request.
      Specified by:
      resolveSessionIds in interface WebSessionIdResolver
      Parameters:
      exchange - the current exchange
      Returns:
      the session id's or an empty list
    • setSessionId

      public void setSessionId(ServerWebExchange exchange, String id)
      Description copied from interface: WebSessionIdResolver
      Send the given session id to the client.
      Specified by:
      setSessionId in interface WebSessionIdResolver
      Parameters:
      exchange - the current exchange
      id - the session id
    • expireSession

      public void expireSession(ServerWebExchange exchange)
      Description copied from interface: WebSessionIdResolver
      Instruct the client to end the current session.
      Specified by:
      expireSession in interface WebSessionIdResolver
      Parameters:
      exchange - the current exchange