org.fenixedu.bennu.spring.security

Class CSRFToken

java.lang.Object

org.fenixedu.bennu.spring.security.CSRFToken

All Implemented Interfaces:

Serializable

public class CSRFToken
extends Object
implements Serializable

Representation of a token that is used to prevent CSRF attacks.

Author:

João Carvalho (joao.pedro.carvalho@tecnico.ulisboa.pt)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CSRFToken(String token) Constructs a new token with the given value, and default values for both headerName and parameterName.
CSRFToken(String headerName, String parameterName, String token) Constructs a new token with the given Header Name, Parameter Name and Value.

Method Summary

Modifier and Type	Method and Description
String	getHeaderName() Returns the name of the header that is expected to contain the CSRF token.
String	getParameterName() Returns the name of the form parameter that is expected to contain the CSRF token.
String	getToken() Returns the value of this token.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSRFToken

public CSRFToken(String token)

Constructs a new token with the given value, and default values for both headerName and parameterName.

Parameters:

token - The value of newly created token

CSRFToken

public CSRFToken(String headerName,
                 String parameterName,
                 String token)

Constructs a new token with the given Header Name, Parameter Name and Value.

Parameters:

headerName - The name of the header that is expected to contain the CSRF token

parameterName - The name of the form parameter that is expected to contain the CSRF token

token - The value of newly created token

Method Detail

getHeaderName

public String getHeaderName()

Returns the name of the header that is expected to contain the CSRF token.

Returns:

The CSRF Token header name

getParameterName

public String getParameterName()

Returns the name of the form parameter that is expected to contain the CSRF token.

Returns:

The CSRF Token parameter name

getToken

public String getToken()

Returns the value of this token.

Returns:

A string containing the value of this token