services.moleculer.web.middleware

Class XSRFToken

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.service.Service

services.moleculer.web.middleware.HttpMiddleware

services.moleculer.web.middleware.XSRFToken

All Implemented Interfaces:

services.moleculer.service.MoleculerLifecycle, HttpConstants

public class XSRFToken
extends HttpMiddleware
implements HttpConstants

This middleware adds "X-XSRF-TOKEN" header to responses. Sample:

 restRoute.use(new XSRFToken());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	XSRFToken.TokenHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	cookieName Name of the HTTP-cookie.
protected boolean	enableCookie Enable XSRF-TOKEN cookie.
protected java.lang.String	headerName Name of the HTTP-header.
protected static org.slf4j.Logger	logger
protected long	maxAge Cookie / token timeout in SECONDS.
protected java.lang.String	path Cookie path.
protected java.lang.String	secret Secret.
protected java.lang.ThreadLocal<XSRFToken.TokenHandler>	tokenHandlers

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, name

Fields inherited from interface services.moleculer.web.common.HttpConstants

ACCEPT, ACCEPT_ENCODING, AUTHORIZATION, CACHE_CONTROL, CHUNKED, CLOSE, CONNECT, CONNECTION, CONTENT_ENCODING, CONTENT_LENGTH, CONTENT_TYPE, CONTENT_TYPE_HTML, CONTENT_TYPE_JSON, COOKIE, DEFLATE, DELETE, ETAG, GET, GZIP, HEAD, IF_NONE_MATCH, KEEP_ALIVE, LOCATION, META_CONTENT_TYPE, META_HEADERS, META_LOCALE, META_LOCATION, META_SESSION, META_STATUS, META_TEMPLATE, NO_CACHE, OPTIONS, PATCH, POST, PROPERTY_COOKIES, PROPERTY_SESSION_ID, PROPERTY_USER, PUT, SET_COOKIE, TRACE, TRANSFER_ENCODING, WWW_AUTHENTICATE, X_FORWARDED_FOR

Constructor Summary

Constructors

Constructor and Description
XSRFToken()
XSRFToken(long maxAge)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCookieName()
java.lang.String	getHeaderName()
long	getMaxAge()
java.lang.String	getPath()
java.lang.String	getSecret()
protected XSRFToken.TokenHandler	getThreadHandler()
RequestProcessor	install(RequestProcessor next, io.datatree.Tree config)
boolean	isEnableCookie()
void	setCookieName(java.lang.String cookieName)
void	setEnableCookie(boolean enableCookie)
void	setHeaderName(java.lang.String headerName)
void	setMaxAge(long maxAge)
void	setPath(java.lang.String path)
void	setSecret(java.lang.String secret)

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName, started, stopped

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

headerName

protected java.lang.String headerName

Name of the HTTP-header.

cookieName

protected java.lang.String cookieName

Name of the HTTP-cookie.

secret

protected java.lang.String secret

Secret.

path

protected java.lang.String path

Cookie path.

maxAge

protected long maxAge

Cookie / token timeout in SECONDS.

enableCookie

protected boolean enableCookie

Enable XSRF-TOKEN cookie.

tokenHandlers

protected java.lang.ThreadLocal<XSRFToken.TokenHandler> tokenHandlers

Constructor Detail

XSRFToken

public XSRFToken()

XSRFToken

public XSRFToken(long maxAge)

Method Detail

getThreadHandler

protected XSRFToken.TokenHandler getThreadHandler()
                                           throws java.security.InvalidKeyException,
                                                  java.security.NoSuchAlgorithmException

Throws:

java.security.InvalidKeyException

java.security.NoSuchAlgorithmException

install

public RequestProcessor install(RequestProcessor next,
                                io.datatree.Tree config)

Specified by:

install in class HttpMiddleware

getCookieName

public java.lang.String getCookieName()

Returns:

the cookieName

setCookieName

public void setCookieName(java.lang.String cookieName)

Parameters:

cookieName - the cookieName to set

getPath

public java.lang.String getPath()

Returns:

the path

setPath

public void setPath(java.lang.String path)

Parameters:

path - the path to set

getMaxAge

public long getMaxAge()

Returns:

the maxAge

setMaxAge

public void setMaxAge(long maxAge)

Parameters:

maxAge - the maxAge to set

getHeaderName

public java.lang.String getHeaderName()

Returns:

the headerName

setHeaderName

public void setHeaderName(java.lang.String headerName)

Parameters:

headerName - the headerName to set

getSecret

public java.lang.String getSecret()

Returns:

the secret

setSecret

public void setSecret(java.lang.String secret)

Parameters:

secret - the secret to set

isEnableCookie

public boolean isEnableCookie()

Returns:

the enableCookie

setEnableCookie

public void setEnableCookie(boolean enableCookie)

Parameters:

enableCookie - the enableCookie to set