Authenticator

Abstract Value Members

abstract def authenticateWithOpenID(openid: String, callback: Call, axRequired: Seq[(String, String)] = Seq.empty, axOptional: Seq[(String, String)] = Seq.empty, realm: Option[String] = None)(implicit request: Request[AnyContent]): Future[Result]

Authenticate a principal using its openid
Authenticate a principal using its openid
The future this function return might fail if the openid authentication process fails at retrieving the redirect URL. You should handle this failure properly.
abstract def authenticateWithPassword(name: String, pass: String)(res: (Option[Principal]) ⇒ Future[(Boolean, Result)])(implicit request: Request[AnyContent]): Future[Result]

Authenticate a principal using its username and password
Authenticate a principal using its username and password
When the authentication try is evaluated the res function is called with either the now authenticated Principal or None.
```
authenticator.authenticateWithPassword("user", "password") {
  case Some(princ) ￢ﾇﾒ Future.successful((true, Ok("You are now logged in.")))
  case None ￢ﾇﾒ Future.successful((false, Ok("Authentication failure.")))
}
```
The boolean return value of res can be used to prevent a login even though the credentials are correct which might be of use for deactivating accounts.
abstract def openIDCallback(res: (Option[Principal], Option[String], Map[String, String]) ⇒ Future[(Boolean, Result)])(implicit request: Request[AnyContent]): Future[Result]

Callback for openid
Callback for openid
If the openID is valid and a principal is found a Some[Principal] and Some[String] (the valid openID) is passed to res. If the openID is valid but no principal can be found None and Some[String] is passed to res. If the openID is invalid None and None is passed to res. The third parameter contains a map of the exchange attributes.
The boolean return value of res can be used to prevent a login even though the credentials are correct.
When the principal is not existing but the openID is valid res should trigger some kind of application specific registration process.
abstract def principal()(implicit request: Request[AnyContent]): Future[Option[Principal]]

Get the currently authed principal
abstract def principals: PrincipalController

Controller to retrieve, save, and create principals
Controller to retrieve, save, and create principals
This controller is used to manage creation of principal objects.
abstract def unauthenticate(result: Result)(implicit request: Request[AnyContent]): Future[Result]

Unauthenticate a principal

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 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
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 authenticator

trait Authenticator extends AnyRef

Abstract Value Members

abstract def authenticateWithOpenID(openid: String, callback: Call, axRequired: Seq[(String, String)] = Seq.empty, axOptional: Seq[(String, String)] = Seq.empty, realm: Option[String] = None)(implicit request: Request[AnyContent]): Future[Result]

abstract def authenticateWithPassword(name: String, pass: String)(res: (Option[Principal]) ⇒ Future[(Boolean, Result)])(implicit request: Request[AnyContent]): Future[Result]

abstract def openIDCallback(res: (Option[Principal], Option[String], Map[String, String]) ⇒ Future[(Boolean, Result)])(implicit request: Request[AnyContent]): Future[Result]

abstract def principal()(implicit request: Request[AnyContent]): Future[Option[Principal]]

abstract def principals: PrincipalController

abstract def unauthenticate(result: Result)(implicit request: Request[AnyContent]): Future[Result]

Concrete 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 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