io.knotx.server.configuration

Class KnotxCSRFOptions

java.lang.Object

io.knotx.server.configuration.KnotxCSRFOptions

public class KnotxCSRFOptions
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getCookieName()
String	getCookiePath()
String	getHeaderName()
String	getSecret()
long	getTimeout()
KnotxCSRFOptions	setCookieName(String cookieName) Set the name of the CSRF cookie
KnotxCSRFOptions	setCookiePath(String cookiePath) Set of the path of the CSRF cookie
KnotxCSRFOptions	setHeaderName(String headerName) Set the CSRF token header name
KnotxCSRFOptions	setSecret(String secret) Set the secret used to generate CSRF token
KnotxCSRFOptions	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

KnotxCSRFOptions

public KnotxCSRFOptions()

Default constructor

KnotxCSRFOptions

public KnotxCSRFOptions(KnotxCSRFOptions other)

Copy constructor

Parameters:

other - the instance to copy

KnotxCSRFOptions

public KnotxCSRFOptions(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 String getCookieName()

Returns:

name of the CSRF cookie

setCookieName

public KnotxCSRFOptions setCookieName(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 String getCookiePath()

Returns:

path of the CSRF cookie

setCookiePath

public KnotxCSRFOptions setCookiePath(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 String getHeaderName()

Returns:

CSRF token header name

setHeaderName

public KnotxCSRFOptions setHeaderName(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 String getSecret()

Returns:

secret used to generate CSRF token

setSecret

public KnotxCSRFOptions setSecret(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 KnotxCSRFOptions 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