javax.mvc.security

Interface Csrf

public interface Csrf

Cross Site Request Forgery (CSRF) interface with access to the CSRF header name and the CSRF token value. Implementations of this interface are injectable and accessible from EL via the MvcContext class as mvc.encoders. It is RECOMMENDED for instances of this class to be in session scope.

Since:

1.0

Author:

Santiago Pericas-Geertsen

See Also:

CsrfValid

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Csrf.CsrfOptions Options for property CSRF_PROTECTION.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CSRF_PROTECTION Property that can be used to globally enable CSRF protection for an application.

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name of the CSRF header.
String	getToken() Returns the value of the CSRF token.

Field Detail

CSRF_PROTECTION

static final String CSRF_PROTECTION

Property that can be used to globally enable CSRF protection for an application. Values of this property must be of type Csrf.CsrfOptions.

See Also:

Application.getProperties(), Constant Field Values

Method Detail

getName

String getName()

Returns the name of the CSRF header. This header is typically a constant.

Returns:

name of CSRF header.

getToken

String getToken()

Returns the value of the CSRF token.

Returns:

value of CSRF token.