io.knotx.server.handler.csrf

Class CSRFOptions

java.lang.Object

io.knotx.server.handler.csrf.CSRFOptions

public class CSRFOptions
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CSRFOptions() Default constructor
CSRFOptions(CSRFOptions other) Copy constructor
CSRFOptions(io.vertx.core.json.JsonObject json) Create an settings from JSON

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCookieName()
java.lang.String	getCookiePath()
java.lang.String	getHeaderName()
java.lang.String	getSecret()
long	getTimeout()
CSRFOptions	setCookieName(java.lang.String cookieName) Set the name of the CSRF cookie
CSRFOptions	setCookiePath(java.lang.String cookiePath) Set of the path of the CSRF cookie
CSRFOptions	setHeaderName(java.lang.String headerName) Set the CSRF token header name
CSRFOptions	setSecret(java.lang.String secret) Set the secret used to generate CSRF token
CSRFOptions	setTimeout(long timeout) Set the timeout of the CSRF token
io.vertx.core.json.JsonObject	toJson() Convert to JSON

Methods inherited from class java.lang.Object

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

Constructor Detail

CSRFOptions

public CSRFOptions()

Default constructor

CSRFOptions

public CSRFOptions(CSRFOptions other)

Copy constructor

Parameters:

other - the instance to copy

CSRFOptions

public CSRFOptions(io.vertx.core.json.JsonObject json)

Create an settings from JSON

Parameters:

json - the JSON

Method Detail

toJson

public io.vertx.core.json.JsonObject toJson()

Convert to JSON

Returns:

the JSON

getCookieName

public java.lang.String getCookieName()

Returns:

name of the CSRF cookie

setCookieName

public CSRFOptions setCookieName(java.lang.String cookieName)

Set the name of the CSRF cookie

Parameters:

cookieName - name of the cookie

Returns:

reference to this, so the API can be used fluently

getCookiePath

public java.lang.String getCookiePath()

Returns:

path of the CSRF cookie

setCookiePath

public CSRFOptions setCookiePath(java.lang.String cookiePath)

Set of the path of the CSRF cookie

Parameters:

cookiePath - path of the cookie, e.g. '/'

Returns:

reference to this, so the API can be used fluently

getHeaderName

public java.lang.String getHeaderName()

Returns:

CSRF token header name

setHeaderName

public CSRFOptions setHeaderName(java.lang.String headerName)

Set the CSRF token header name

Parameters:

headerName - header name

Returns:

reference to this, so the API can be used fluently

getSecret

public java.lang.String getSecret()

Returns:

secret used to generate CSRF token

setSecret

public CSRFOptions setSecret(java.lang.String secret)

Set the secret used to generate CSRF token

Parameters:

secret - a secret String

Returns:

reference to this, so the API can be used fluently

getTimeout

public long getTimeout()

Returns:

timeout of the CSRF token

setTimeout

public CSRFOptions setTimeout(long timeout)

Set the timeout of the CSRF token

Parameters:

timeout - a token timeout

Returns:

reference to this, so the API can be used fluently