spring-framework / org.springframework.web.server.session / HeaderWebSessionIdResolver

HeaderWebSessionIdResolver

open class HeaderWebSessionIdResolver : WebSessionIdResolver

Request and response header-based WebSessionIdResolver.

Author
Greg Turnquist

Author
Rob Winch

Since
5.0

Constructors

<init>

HeaderWebSessionIdResolver()

Request and response header-based WebSessionIdResolver.

Properties

DEFAULT_HEADER_NAME

static val DEFAULT_HEADER_NAME: String

Default value for #setHeaderName(String).

Functions

expireSession

open fun expireSession(exchange: ServerWebExchange): Unit

getHeaderName

open fun getHeaderName(): String

Return the configured header name.

resolveSessionIds

open fun resolveSessionIds(exchange: ServerWebExchange): MutableList<String>

setHeaderName

open fun setHeaderName(headerName: String): Unit

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

setSessionId

open fun setSessionId(exchange: ServerWebExchange, id: String): Unit