Class/Object

com.gu.googleauth

AuthAction

Related Docs: object AuthAction | package googleauth

Permalink

class AuthAction[A] extends ActionBuilder[UserIdentityRequest, A] with ActionRefiner[Request, UserIdentityRequest] with UserIdentifier

This action ensures that the user is authenticated and their token is valid. Is a user is not logged in or their token has expired then they will be authenticated.

The AuthenticatedRequest will always have an identity.

Linear Supertypes
UserIdentifier, ActionRefiner[Request, UserIdentityRequest], ActionBuilder[UserIdentityRequest, A], ActionFunction[Request, UserIdentityRequest], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AuthAction
  2. UserIdentifier
  3. ActionRefiner
  4. ActionBuilder
  5. ActionFunction
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AuthAction(authConfig: GoogleAuthConfig, loginTarget: Call, bodyParser: BodyParser[A])(implicit executionContext: ExecutionContext)

    Permalink

    loginTarget

    The target that should be redirected to in order to carry out authentication

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def andThen[Q[_]](other: ActionFunction[UserIdentityRequest, Q]): ActionBuilder[Q, A]

    Permalink
    Definition Classes
    ActionBuilder → ActionFunction

  5. final def apply(block: ⇒ Result): Action[AnyContent]

    Permalink
    Definition Classes
    ActionBuilder

  6. final def apply(block: (UserIdentityRequest[A]) ⇒ Result): Action[A]

    Permalink
    Definition Classes
    ActionBuilder

  7. final def apply[A](bodyParser: BodyParser[A]): ActionBuilder[UserIdentityRequest, A]

    Permalink
    Definition Classes
    ActionBuilder

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  9. final def async[A](bodyParser: BodyParser[A])(block: (UserIdentityRequest[A]) ⇒ Future[Result]): Action[A]

    Permalink
    Definition Classes
    ActionBuilder

  10. final def async(block: (UserIdentityRequest[A]) ⇒ Future[Result]): Action[A]

    Permalink
    Definition Classes
    ActionBuilder

  11. final def async(block: ⇒ Future[Result]): Action[AnyContent]

    Permalink
    Definition Classes
    ActionBuilder

  12. val authConfig: GoogleAuthConfig

    Permalink

    The configuration to use for these actions

    The configuration to use for these actions

    Definition Classes
    AuthAction → UserIdentifier

  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  14. def compose[B](other: ActionBuilder[Request, B]): ActionBuilder[UserIdentityRequest, B]

    Permalink
    Definition Classes
    ActionFunction

  15. def compose[Q[_]](other: ActionFunction[Q, Request]): ActionFunction[Q, UserIdentityRequest]

    Permalink
    Definition Classes
    ActionFunction

  16. def composeAction[A](action: Action[A]): Action[A]

    Permalink
    Attributes
    protected
    Definition Classes
    ActionBuilder

  17. def composeParser[A](bodyParser: BodyParser[A]): BodyParser[A]

    Permalink
    Attributes
    protected
    Definition Classes
    ActionBuilder

  18. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  19. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  20. implicit val executionContext: ExecutionContext

    Permalink
    Definition Classes
    AuthAction → ActionFunction

  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  22. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def invokeBlock[A](request: Request[A], block: (UserIdentityRequest[A]) ⇒ Future[Result]): Future[Result]

    Permalink
    Definition Classes
    ActionRefiner → ActionFunction

  25. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  29. def parser: BodyParser[A]

    Permalink
    Definition Classes
    AuthAction → ActionBuilder

  30. def refine[A](request: Request[A]): Future[Either[Result, UserIdentityRequest[A]]]

    Permalink
    Attributes
    protected
    Definition Classes
    AuthAction → ActionRefiner

  31. def sendForAuth[A](request: RequestHeader)(implicit ec: ExecutionContext): Result

    Permalink

    Helper method that deals with sending a client for authentication.

    Helper method that deals with sending a client for authentication. Typically this should store the target URL and redirect to the loginTarget. There shouldn't really be any need to override this.

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

    Permalink
    Definition Classes
    AnyRef

  33. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  34. def userIdentity(request: RequestHeader): Option[UserIdentity]

    Permalink

    Helper method that deals with getting a user identity from a request and establishing validity

    Helper method that deals with getting a user identity from a request and establishing validity

    Definition Classes
    UserIdentifier

  35. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from UserIdentifier

Inherited from ActionRefiner[Request, UserIdentityRequest]

Inherited from ActionBuilder[UserIdentityRequest, A]

Inherited from ActionFunction[Request, UserIdentityRequest]

Inherited from AnyRef

Inherited from Any

Ungrouped