Login

The Login component provides the user's first entry point into Play Sentry via your application.

It is up to your application to decide when a user is to be logged-in (i.e. provides the correct credentials to a login form of some kind), and from there your controller can use this component to create a session for that user by their ID. To use it, you simply inject Login into your controller, and call gotoLoginSucceeded(userId) when you want to grant a session to a user linked to a particular userId.

@Singleton
class Application @Inject() (login: Login[MyEnv], userService: UserService) extends InjectedController {
    def login = Action.async(parse.urlEncodedForm) { implicit request =>
        // logic to determine to handle user name and password..
        gotoLoginSucceeded(userId)
    }
}

E: The environment type of your application.

Linear Supertypes

AnyRef, Any

Instance Constructors

new Login(config: AuthConfig[E], idContainer: IdContainer[E.Id], tokenAccessor: TokenAccessor)

config
Requires an AuthConfig to determine the default Result to return to the user once logged-in.
idContainer
The IdContainer that will store the session server-side.
tokenAccessor
The TokenAccessor that will store the session client-side.

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( ... )
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 gotoLoginSucceeded(userId: E.Id, result: ⇒ Future[Result])(implicit request: RequestHeader, ctx: ExecutionContext): Future[Result]

Creates a new session for a user, and allows a custom result (different than from the AuthConfig) to be returned to them once the session has been created.
Creates a new session for a user, and allows a custom result (different than from the AuthConfig) to be returned to them once the session has been created.
userId
The ID of the user to grant the session to.
result
The Result to return to the user once their session is created.
returns
The given Result with an AuthenticityToken included.
def gotoLoginSucceeded(userId: E.Id)(implicit request: RequestHeader, ctx: ExecutionContext): Future[Result]

Creates a new session for a user.
Creates a new session for a user.
userId
The ID of the user to grant the session to.
returns
The default Result defined in the AuthConfig when the user is logged-in, with an AuthenticityToken included.
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 Login[E <: Env] extends AnyRef

Instance Constructors

new Login(config: AuthConfig[E], idContainer: IdContainer[E.Id], tokenAccessor: TokenAccessor)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def gotoLoginSucceeded(userId: E.Id, result: ⇒ Future[Result])(implicit request: RequestHeader, ctx: ExecutionContext): Future[Result]

def gotoLoginSucceeded(userId: E.Id)(implicit request: RequestHeader, ctx: ExecutionContext): Future[Result]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped