程序包 cn.taketoday.session

类 HeaderSessionIdResolver

java.lang.Object

cn.taketoday.session.HeaderSessionIdResolver

所有已实现的接口:

SessionIdResolver

public class HeaderSessionIdResolver
extends Object
implements SessionIdResolver

A HeaderSessionIdResolver that uses a header to resolve the session id. Specifically, this implementation will allow specifying a header name using HeaderSessionIdResolver(String). Convenience factory methods for creating instances that use common header names, such as "X-Auth-Token" and "Authentication-Info", are available as well.

When a session is created, the HTTP response will have a response header of the specified name and the value of the session id. For example:

 HTTP/1.1 200 OK
 X-Auth-Token: f81d4fae-7dec-11d0-a765-00a0c91e6bf6
 

The client should now include the session in each request by specifying the same header in their request. For example:

 GET /messages/ HTTP/1.1
 Host: example.com
 X-Auth-Token: f81d4fae-7dec-11d0-a765-00a0c91e6bf6
 

When the session is invalidated, the server will send an HTTP response that has the header name and a blank value. For example:

 HTTP/1.1 200 OK
 X-Auth-Token:
 

从以下版本开始:

2019-10-03 10:56

作者:

Harry Yang

字段概要

字段

修饰符和类型	字段	说明
static final String	HEADER_AUTHENTICATION_INFO
static final String	HEADER_X_AUTH_TOKEN
private final String	headerName

从接口继承的字段 cn.taketoday.session.SessionIdResolver

WRITTEN_SESSION_ID_ATTR

构造器概要

构造器

构造器	说明
HeaderSessionIdResolver(String headerName)	The name of the header to obtain the session id from.

方法概要

修饰符和类型	方法	说明
static HeaderSessionIdResolver	authenticationInfo()	Convenience factory to create HeaderSessionIdResolver that uses "Authentication-Info" header.
void	expireSession(RequestContext exchange)	Instruct the client to end the current session.
String	getSessionId(RequestContext context)	Resolving session id from RequestContext
void	setSessionId(RequestContext context, String sessionId)	Send the given session id to the client.
static HeaderSessionIdResolver	xAuthToken()	Convenience factory to create HeaderSessionIdResolver that uses "X-Auth-Token" header.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

HEADER_X_AUTH_TOKEN

public static final String HEADER_X_AUTH_TOKEN

另请参阅:

• 常量字段值

HEADER_AUTHENTICATION_INFO

public static final String HEADER_AUTHENTICATION_INFO

另请参阅:

• 常量字段值

headerName

private final String headerName

构造器详细资料

HeaderSessionIdResolver

public HeaderSessionIdResolver(String headerName)

The name of the header to obtain the session id from.

参数:

headerName - the name of the header to obtain the session id from.

方法详细资料

getSessionId

@Nullable
public String getSessionId(RequestContext context)

从接口复制的说明: SessionIdResolver

Resolving session id from RequestContext

session id including applied session id

指定者:

getSessionId 在接口中 SessionIdResolver

参数:

context - request context

返回:

session id

setSessionId

public void setSessionId(RequestContext context,
 String sessionId)

从接口复制的说明: SessionIdResolver

Send the given session id to the client.

指定者:

setSessionId 在接口中 SessionIdResolver

参数:

context - the current context

sessionId - the session id

expireSession

public void expireSession(RequestContext exchange)

从接口复制的说明: SessionIdResolver

Instruct the client to end the current session.

指定者:

expireSession 在接口中 SessionIdResolver

参数:

exchange - the current exchange

xAuthToken

public static HeaderSessionIdResolver xAuthToken()

Convenience factory to create HeaderSessionIdResolver that uses "X-Auth-Token" header.

返回:

the instance configured to use "X-Auth-Token" header

authenticationInfo

public static HeaderSessionIdResolver authenticationInfo()

Convenience factory to create HeaderSessionIdResolver that uses "Authentication-Info" header.

返回:

the instance configured to use "Authentication-Info" header