AuthConfigImpl

Type Members

type Authority = Authentication.Role.Value

A type that is defined by every action for authorization.
A type that is defined by every action for authorization. This sample uses the following trait:
sealed trait Role case object Administrator extends Role case object NormalUser extends Role

Definition Classes
AuthConfigImpl → AuthConfig
type Id = String

A type that is used to identify a user.
A type that is used to identify a user. String, Int, Long and so on.

Definition Classes
AuthConfigImpl → AuthConfig
type User = Account

A type that represents a user in your application.
A type that represents a user in your application. User, Account and so on.

Definition Classes
AuthConfigImpl → AuthConfig

Abstract Value Members

abstract def resolveUser(id: Id)(implicit ctx: ExecutionContext): Future[Option[User]]

A function that returns a User object from an Id.
A function that returns a User object from an Id. You can alter the procedure to suit your application.

Definition Classes
AuthConfigImpl → AuthConfig

Concrete 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 authenticationFailed(request: RequestHeader)(implicit ctx: ExecutionContext): Future[Result]

If the user is not logged in and tries to access a protected resource then redirct them as follows:
If the user is not logged in and tries to access a protected resource then redirct them as follows:

Definition Classes
AuthConfigImpl → AuthConfig
def authorizationFailed(request: RequestHeader, user: User, authority: Option[Authority])(implicit context: ExecutionContext): Future[Result]

If authorization failed (usually incorrect password) redirect the user as follows:
If authorization failed (usually incorrect password) redirect the user as follows:

Definition Classes
AuthConfigImpl → AuthConfig
def authorize(user: User, authority: Authority)(implicit ctx: ExecutionContext): Future[Boolean]

A function that determines what Authority a user has.
A function that determines what Authority a user has. You should alter this procedure to suit your application.

Definition Classes
AuthConfigImpl → AuthConfig
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
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
lazy val idContainer: AsyncIdContainer[Id]

Definition Classes
AuthConfig
val idTag: ClassTag[Id]

A ClassTag is used to retrieve an id from the Cache API.
A ClassTag is used to retrieve an id from the Cache API. Use something like this:

Definition Classes
AuthConfigImpl → AuthConfig
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def loginSucceeded(request: RequestHeader)(implicit ctx: ExecutionContext): Future[Result]

Where to redirect the user after a successful login.
Where to redirect the user after a successful login.

Definition Classes
AuthConfigImpl → AuthConfig
def logoutSucceeded(request: RequestHeader)(implicit ctx: ExecutionContext): Future[Result]

Where to redirect the user after logging out
Where to redirect the user after logging out

Definition Classes
AuthConfigImpl → AuthConfig
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val sessionTimeoutInSeconds: Int

The session timeout in seconds
The session timeout in seconds

Definition Classes
AuthConfigImpl → AuthConfig
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
lazy val tokenAccessor: CookieTokenAccessor

(Optional) You can custom SessionID Token handler.
(Optional) You can custom SessionID Token handler. Default implemntation use Cookie.

Definition Classes
AuthConfigImpl → AuthConfig
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( ... )

Deprecated Value Members

final lazy val cookieDomainOption: Option[String]

Definition Classes
AuthConfig
Annotations
@deprecated
Deprecated
(Since version 0.13.1) it will be deleted since 0.14.0. use CookieTokenAccessor constructor
final lazy val cookieHttpOnlyOption: Boolean

Definition Classes
AuthConfig
Annotations
@deprecated
Deprecated
(Since version 0.13.1) it will be deleted since 0.14.0. use CookieTokenAccessor constructor
final lazy val cookieName: String

Definition Classes
AuthConfig
Annotations
@deprecated
Deprecated
(Since version 0.13.1) it will be deleted since 0.14.x. use CookieTokenAccessor constructor
final lazy val cookiePathOption: String

Definition Classes
AuthConfig
Annotations
@deprecated
Deprecated
(Since version 0.13.1) it will be deleted since 0.14.0. use CookieTokenAccessor constructor
final lazy val cookieSecureOption: Boolean

Definition Classes
AuthConfig
Annotations
@deprecated
Deprecated
(Since version 0.13.1) it will be deleted since 0.14.0. use CookieTokenAccessor constructor
final lazy val isTransientCookie: Boolean

Definition Classes
AuthConfig
Annotations
@deprecated
Deprecated
(Since version 0.13.1) it will be deleted since 0.14.0. use CookieTokenAccessor constructor

Related Doc: package controllers

trait AuthConfigImpl extends AuthConfig

Type Members

type Authority = Authentication.Role.Value

type Id = String

type User = Account

Abstract Value Members

abstract def resolveUser(id: Id)(implicit ctx: ExecutionContext): Future[Option[User]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def authenticationFailed(request: RequestHeader)(implicit ctx: ExecutionContext): Future[Result]

def authorizationFailed(request: RequestHeader, user: User, authority: Option[Authority])(implicit context: ExecutionContext): Future[Result]

def authorize(user: User, authority: Authority)(implicit ctx: ExecutionContext): Future[Boolean]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

lazy val idContainer: AsyncIdContainer[Id]

val idTag: ClassTag[Id]

final def isInstanceOf[T0]: Boolean

def loginSucceeded(request: RequestHeader)(implicit ctx: ExecutionContext): Future[Result]

def logoutSucceeded(request: RequestHeader)(implicit ctx: ExecutionContext): Future[Result]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val sessionTimeoutInSeconds: Int

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

def toString(): String

lazy val tokenAccessor: CookieTokenAccessor

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

final lazy val cookieDomainOption: Option[String]

final lazy val cookieHttpOnlyOption: Boolean

final lazy val cookieName: String

final lazy val cookiePathOption: String

final lazy val cookieSecureOption: Boolean

final lazy val isTransientCookie: Boolean

Inherited from AuthConfig

Inherited from AnyRef

Inherited from Any

Ungrouped