CookieTokenAccessor

Instance Constructors

new CookieTokenAccessor(config: Configuration, signer: CookieSigner)

config
An application configuration to supply custom settings for issued cookies, such as security settings, expiration, domain, etc.
signer
Requires a CookieSigner to sign the tokens.

Annotations
@Inject()

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def delete(result: Result)(implicit request: RequestHeader): Result

Removes any issued AuthenticityToken or SignedToken from a Result.
Removes any issued AuthenticityToken or SignedToken from a Result.
result
The Result to remove all issued tokens from.
returns
A new Result without any issued tokens.

Definition Classes
CookieTokenAccessor → TokenAccessor
val domain: Option[String]

Attributes
protected
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def extract(request: RequestHeader): Option[AuthenticityToken]

Attempts to extract an AuthenticityToken from a RequestHeader.
Attempts to extract an AuthenticityToken from a RequestHeader.
request
The RequestHeader to extract the token from.
returns
An AuthenticityToken if the request contains a token with a valid signature. Otherwise, None.

Definition Classes
CookieTokenAccessor → TokenAccessor
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
val httpOnly: Boolean

Attributes
protected
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val maxAge: Option[Int]

Attributes
protected
val name: String

Attributes
protected
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val path: String

Attributes
protected
def put(token: AuthenticityToken)(result: Result)(implicit request: RequestHeader): Result

Puts an AuthenticityToken into a Result to return to a user.
Puts an AuthenticityToken into a Result to return to a user.
token
The AuthenticityToken to be issued to a user.
returns
A Result containing a SignedToken or AuthenticityToken.

Definition Classes
CookieTokenAccessor → TokenAccessor
def safeEquals(a: String, b: String): Boolean

Attributes
protected
Definition Classes
TokenAccessor
val secure: Boolean

Attributes
protected
def sign(token: AuthenticityToken): SignedToken

Signs an AuthenticityToken and concatenates it with its signature.
Signs an AuthenticityToken and concatenates it with its signature. ("$${signature}$${token}") The resulting SignedToken is meant to be issued to a user (e.g., within a cookie).
token
The AuthenticityToken to sign.
returns
The signature of the AuthenticityToken concatenated with the token itself.

Attributes
protected
Definition Classes
TokenAccessor
val signer: CookieSigner

Requires a CookieSigner to sign the tokens.
Requires a CookieSigner to sign the tokens.

Definition Classes
CookieTokenAccessor → TokenAccessor
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def verifyHmac(token: SignedToken): Option[AuthenticityToken]

Verifies that a SignedToken token is valid by comparing the stored signature in the SignedToken to the signature of the raw AuthenticityToken that is part of the SignedToken.
Verifies that a SignedToken token is valid by comparing the stored signature in the SignedToken to the signature of the raw AuthenticityToken that is part of the SignedToken. In order for any SignedToken to be valid, it must be issued via the TokenAccessor#sign method.
token
The SignedToken to validate.
returns
The contained AuthenticityToken if the signature is valid, otherwise None.

Attributes
protected
Definition Classes
TokenAccessor
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package sentry

class CookieTokenAccessor extends TokenAccessor

Instance Constructors

new CookieTokenAccessor(config: Configuration, signer: CookieSigner)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def delete(result: Result)(implicit request: RequestHeader): Result

val domain: Option[String]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def extract(request: RequestHeader): Option[AuthenticityToken]

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

val httpOnly: Boolean

final def isInstanceOf[T0]: Boolean

val maxAge: Option[Int]

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val path: String

def put(token: AuthenticityToken)(result: Result)(implicit request: RequestHeader): Result

def safeEquals(a: String, b: String): Boolean

val secure: Boolean

def sign(token: AuthenticityToken): SignedToken

val signer: CookieSigner

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def verifyHmac(token: SignedToken): Option[AuthenticityToken]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from TokenAccessor

Inherited from AnyRef

Inherited from Any

Ungrouped