software.sandc.springframework.security.jwt.impl

Class DefaultJWTRequestResponseHandler

java.lang.Object

software.sandc.springframework.security.jwt.impl.DefaultJWTRequestResponseHandler

All Implemented Interfaces:

JWTRequestResponseHandler

public class DefaultJWTRequestResponseHandler
extends Object
implements JWTRequestResponseHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected String	cookiePath
protected String	jwtCookieParameter
protected String	jwtModeRequestHeaderParameter
protected String	jwtRequestHeaderParameter
protected String	jwtResponseHeaderParameter
protected boolean	secureCookie
static String	SPRING_SECURITY_JWT_COOKIE_JWT_PARAMETER
static String	SPRING_SECURITY_JWT_COOKIE_XSRF_PARAMETER
static String	SPRING_SECURITY_JWT_REQUEST_HEADER_JWT
static String	SPRING_SECURITY_JWT_REQUEST_HEADER_JWT_MODE
static String	SPRING_SECURITY_JWT_REQUEST_HEADER_JWT_MODE_VALUE_APP
static String	SPRING_SECURITY_JWT_REQUEST_HEADER_JWT_MODE_VALUE_WEB
static String	SPRING_SECURITY_JWT_REQUEST_HEADER_XSRF
static String	SPRING_SECURITY_JWT_RESPONSE_HEADER_JWT
static String	SPRING_SECURITY_JWT_RESPONSE_HEADER_XSRF
protected String	xsrfCookieParameter
protected String	xsrfRequestHeaderParameter
protected String	xsrfResponseHeaderParameter

Constructor Summary

Constructors

Constructor and Description
DefaultJWTRequestResponseHandler()

Method Summary

Modifier and Type	Method and Description
protected String	getJWTModeFromHeader(javax.servlet.http.HttpServletRequest request)
protected String	getJWTTokenFromCookie(javax.servlet.http.HttpServletRequest request)
protected String	getJWTTokenFromHeader(javax.servlet.http.HttpServletRequest request)
protected String	getJWTTokenFromRequest(javax.servlet.http.HttpServletRequest request)
Parameters	getParametersFromRequest(javax.servlet.http.HttpServletRequest request) Extract Parameters from HTTP request.
TokenContainer	getTokenFromRequest(javax.servlet.http.HttpServletRequest request) Extract tokens from HTTP request.
protected String	getXSRFTokenFromHeader(javax.servlet.http.HttpServletRequest request)
protected boolean	isJWTRequestedInAppMode(javax.servlet.http.HttpServletRequest request)
protected boolean	istJWTInAppMode(String jwtMode)
void	putTokenToResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, TokenContainer tokenContainer) Attach tokens to HTTP response.
void	setCookiePath(String cookiePath)
void	setJwtCookieParameter(String jwtCookieParameter)
void	setJwtModeRequestHeaderParameter(String jwtModeRequestHeaderParameter)
void	setJwtRequestHeaderParameter(String jwtRequestHeaderParameter)
void	setJwtResponseHeaderParameter(String jwtResponseHeaderParameter)
void	setSecureCookie(boolean secureCookie)
void	setXsrfCookieParameter(String xsrfCookieParameter)
void	setXsrfRequestHeaderParameter(String xsrfRequestHeaderParameter)
void	setXsrfResponseHeaderParameter(String xsrfResponseHeaderParameter)

Methods inherited from class java.lang.Object

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

Field Detail

SPRING_SECURITY_JWT_COOKIE_JWT_PARAMETER

public static final String SPRING_SECURITY_JWT_COOKIE_JWT_PARAMETER

See Also:

Constant Field Values

SPRING_SECURITY_JWT_COOKIE_XSRF_PARAMETER

public static final String SPRING_SECURITY_JWT_COOKIE_XSRF_PARAMETER

See Also:

Constant Field Values

SPRING_SECURITY_JWT_RESPONSE_HEADER_XSRF

public static final String SPRING_SECURITY_JWT_RESPONSE_HEADER_XSRF

See Also:

Constant Field Values

SPRING_SECURITY_JWT_REQUEST_HEADER_XSRF

public static final String SPRING_SECURITY_JWT_REQUEST_HEADER_XSRF

See Also:

Constant Field Values

SPRING_SECURITY_JWT_REQUEST_HEADER_JWT

public static final String SPRING_SECURITY_JWT_REQUEST_HEADER_JWT

See Also:

Constant Field Values

SPRING_SECURITY_JWT_REQUEST_HEADER_JWT_MODE

public static final String SPRING_SECURITY_JWT_REQUEST_HEADER_JWT_MODE

See Also:

Constant Field Values

SPRING_SECURITY_JWT_RESPONSE_HEADER_JWT

public static final String SPRING_SECURITY_JWT_RESPONSE_HEADER_JWT

See Also:

Constant Field Values

SPRING_SECURITY_JWT_REQUEST_HEADER_JWT_MODE_VALUE_WEB

public static final String SPRING_SECURITY_JWT_REQUEST_HEADER_JWT_MODE_VALUE_WEB

See Also:

Constant Field Values

SPRING_SECURITY_JWT_REQUEST_HEADER_JWT_MODE_VALUE_APP

public static final String SPRING_SECURITY_JWT_REQUEST_HEADER_JWT_MODE_VALUE_APP

See Also:

Constant Field Values

jwtCookieParameter

protected String jwtCookieParameter

jwtRequestHeaderParameter

protected String jwtRequestHeaderParameter

jwtResponseHeaderParameter

protected String jwtResponseHeaderParameter

jwtModeRequestHeaderParameter

protected String jwtModeRequestHeaderParameter

xsrfCookieParameter

protected String xsrfCookieParameter

xsrfResponseHeaderParameter

protected String xsrfResponseHeaderParameter

xsrfRequestHeaderParameter

protected String xsrfRequestHeaderParameter

cookiePath

protected String cookiePath

secureCookie

protected boolean secureCookie

Constructor Detail

DefaultJWTRequestResponseHandler

public DefaultJWTRequestResponseHandler()

Method Detail

getTokenFromRequest

public TokenContainer getTokenFromRequest(javax.servlet.http.HttpServletRequest request)

Description copied from interface: JWTRequestResponseHandler

Extract tokens from HTTP request.

Specified by:

getTokenFromRequest in interface JWTRequestResponseHandler

Parameters:

request - HTTP request.

Returns:

A TokenContainer object which contains all relevant tokens.

getParametersFromRequest

public Parameters getParametersFromRequest(javax.servlet.http.HttpServletRequest request)

Description copied from interface: JWTRequestResponseHandler

Extract Parameters from HTTP request. The content of the returned Parameters object may vary depending on the underlying implementation.

Specified by:

getParametersFromRequest in interface JWTRequestResponseHandler

Parameters:

request - HTTP request.

Returns:

Parameters object extracted from HTTP request. This value may be null.

putTokenToResponse

public void putTokenToResponse(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response,
                               TokenContainer tokenContainer)

Description copied from interface: JWTRequestResponseHandler

Attach tokens to HTTP response.

Specified by:

putTokenToResponse in interface JWTRequestResponseHandler

Parameters:

request - HTTP request.

response - HTTP response.

tokenContainer - A TokenContainer object which contains all relevant tokens.

setJwtCookieParameter

public void setJwtCookieParameter(String jwtCookieParameter)

setJwtRequestHeaderParameter

public void setJwtRequestHeaderParameter(String jwtRequestHeaderParameter)

setJwtModeRequestHeaderParameter

public void setJwtModeRequestHeaderParameter(String jwtModeRequestHeaderParameter)

setJwtResponseHeaderParameter

public void setJwtResponseHeaderParameter(String jwtResponseHeaderParameter)

setXsrfResponseHeaderParameter

public void setXsrfResponseHeaderParameter(String xsrfResponseHeaderParameter)

setXsrfCookieParameter

public void setXsrfCookieParameter(String xsrfCookieParameter)

setXsrfRequestHeaderParameter

public void setXsrfRequestHeaderParameter(String xsrfRequestHeaderParameter)

setCookiePath

public void setCookiePath(String cookiePath)

setSecureCookie

public void setSecureCookie(boolean secureCookie)

getJWTTokenFromRequest

protected String getJWTTokenFromRequest(javax.servlet.http.HttpServletRequest request)

getJWTTokenFromCookie

protected String getJWTTokenFromCookie(javax.servlet.http.HttpServletRequest request)

getJWTTokenFromHeader

protected String getJWTTokenFromHeader(javax.servlet.http.HttpServletRequest request)

getXSRFTokenFromHeader

protected String getXSRFTokenFromHeader(javax.servlet.http.HttpServletRequest request)

getJWTModeFromHeader

protected String getJWTModeFromHeader(javax.servlet.http.HttpServletRequest request)

isJWTRequestedInAppMode

protected boolean isJWTRequestedInAppMode(javax.servlet.http.HttpServletRequest request)

istJWTInAppMode

protected boolean istJWTInAppMode(String jwtMode)