AuthorizedActionFunction

Instance Constructors

new AuthorizedActionFunction(handler: ProtectedResourceHandler[U])(implicit ctx: ExecutionContext)

Type Members

class Status extends Result

Definition Classes
Results

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
val Accepted: Status

Definition Classes
Results
val BadGateway: Status

Definition Classes
Results
val BadRequest: Status

Definition Classes
Results
val Conflict: Status

Definition Classes
Results
val Created: Status

Definition Classes
Results
val EntityTooLarge: Status

Definition Classes
Results
val ExpectationFailed: Status

Definition Classes
Results
val FailedDependency: Status

Definition Classes
Results
val Forbidden: Status

Definition Classes
Results
def Found(url: String): Result

Definition Classes
Results
val GatewayTimeout: Status

Definition Classes
Results
val Gone: Status

Definition Classes
Results
val HttpVersionNotSupported: Status

Definition Classes
Results
val InsufficientStorage: Status

Definition Classes
Results
val InternalServerError: Status

Definition Classes
Results
val Locked: Status

Definition Classes
Results
val MethodNotAllowed: Status

Definition Classes
Results
def MovedPermanently(url: String): Result

Definition Classes
Results
val MultiStatus: Status

Definition Classes
Results
val NoContent: Result

Definition Classes
Results
val NonAuthoritativeInformation: Status

Definition Classes
Results
val NotAcceptable: Status

Definition Classes
Results
val NotFound: Status

Definition Classes
Results
val NotImplemented: Status

Definition Classes
Results
val NotModified: Result

Definition Classes
Results
val Ok: Status

Definition Classes
Results
val PartialContent: Status

Definition Classes
Results
val PaymentRequired: Status

Definition Classes
Results
val PreconditionFailed: Status

Definition Classes
Results
def Redirect(call: Call, status: Int): Result

Definition Classes
Results
def Redirect(call: Call): Result

Definition Classes
Results
def Redirect(url: String, queryString: Map[String, Seq[String]], status: Int): Result

Definition Classes
Results
def Redirect(url: String, status: Int): Result

Definition Classes
Results
val RequestTimeout: Status

Definition Classes
Results
val ResetContent: Result

Definition Classes
Results
def SeeOther(url: String): Result

Definition Classes
Results
val ServiceUnavailable: Status

Definition Classes
Results
def Status(code: Int): Status

Definition Classes
Results
def TemporaryRedirect(url: String): Result

Definition Classes
Results
val TooManyRequest: Status

Definition Classes
Results
val Unauthorized: Status

Definition Classes
Results
val UnprocessableEntity: Status

Definition Classes
Results
val UnsupportedMediaType: Status

Definition Classes
Results
val UriTooLong: Status

Definition Classes
Results
def andThen[Q[_]](other: ActionFunction[[A]AuthInfoRequest[A, U], Q]): ActionFunction[Request, Q]

Definition Classes
ActionFunction
final def asInstanceOf[T0]: T0

Definition Classes
Any
def authorize[A, U](handler: ProtectedResourceHandler[U])(callback: (AuthInfo[U]) ⇒ Future[Result])(implicit request: Request[A], ctx: ExecutionContext): Future[Result]

Authorize to already created access token in ProtectedResourceHandler process and return the response to client.
Authorize to already created access token in ProtectedResourceHandler process and return the response to client.
A
play.api.mvc.Request has type.
U
set the type in AuthorizationHandler.
handler
Implemented ProtectedResourceHandler for authenticate to your system.
callback
Callback is called when authentication is successful.
request
Playframework is provided HTTP request interface.
ctx
This contxt is used by ProtectedResource.
returns
Authentication is successful then the response use your API result. Authentication is failed then return BadRequest or Unauthorized status to client with cause into the JSON.

Definition Classes
OAuth2Provider
def chunk(trailers: Option[Iteratee[Array[Byte], Seq[(String, String)]]]): Enumeratee[Array[Byte], Array[Byte]]

Definition Classes
Results
def chunk: Enumeratee[Array[Byte], Array[Byte]]

Definition Classes
Results
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def compose(other: ActionBuilder[Request]): ActionBuilder[[A]AuthInfoRequest[A, U]]

Definition Classes
ActionFunction
def compose[Q[_]](other: ActionFunction[Q, Request]): ActionFunction[Q, [A]AuthInfoRequest[A, U]]

Definition Classes
ActionFunction
def dechunk: Enumeratee[Array[Byte], Array[Byte]]

Definition Classes
Results
def dechunkWithTrailers: Enumeratee[Array[Byte], Either[Array[Byte], Seq[(String, String)]]]

Definition Classes
Results
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def executionContext: ExecutionContext

Attributes
protected
Definition Classes
ActionFunction
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val handler: ProtectedResourceHandler[U]
def invokeBlock[A](request: Request[A], block: (AuthInfoRequest[A, U]) ⇒ Future[Result]): Future[Result]

Definition Classes
AuthorizedActionFunction → ActionFunction
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def issueAccessToken[A, U](handler: AuthorizationHandler[U])(implicit request: Request[A], ctx: ExecutionContext): Future[Result]

Issue access token in AuthorizationHandler process and return the response to client.
Issue access token in AuthorizationHandler process and return the response to client.
A
play.api.mvc.Request has type.
U
set the type in AuthorizationHandler.
handler
Implemented AuthorizationHandler for register access token to your system.
request
Playframework is provided HTTP request interface.
ctx
This context is used by TokenEndPoint.
returns
Request is successful then return JSON to client in OAuth 2.0 format. Request is failed then return BadRequest or Unauthorized status to client with cause into the JSON.

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
implicit def play2oauthRequest[A](request: Request[A]): AuthorizationRequest

Definition Classes
OAuth2BaseProvider
implicit def play2oauthRequest(request: RequestHeader): AuthorizationRequest

Definition Classes
OAuth2BaseProvider
implicit def play2protectedResourceRequest[A](request: Request[A]): ProtectedResourceRequest

Definition Classes
OAuth2BaseProvider
implicit def play2protectedResourceRequest(request: RequestHeader): ProtectedResourceRequest

Definition Classes
OAuth2BaseProvider
val protectedResource: ProtectedResource

Definition Classes
OAuth2BaseProvider
def responseAccessToken(r: GrantHandlerResult): Map[String, JsValue]

Attributes
protected[scalaoauth2]
Definition Classes
OAuth2BaseProvider
def responseOAuthErrorHeader(e: OAuthError): (String, String)

Attributes
protected[scalaoauth2]
Definition Classes
OAuth2BaseProvider
def responseOAuthErrorJson(e: OAuthError): JsValue

Attributes
protected[scalaoauth2]
Definition Classes
OAuth2BaseProvider
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toOAuthErrorString(e: OAuthError): String

Attributes
protected
Definition Classes
OAuth2BaseProvider
val tokenEndpoint: TokenEndpoint

Definition Classes
OAuth2BaseProvider
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 provider

case class AuthorizedActionFunction[U](handler: ProtectedResourceHandler[U])(implicit ctx: ExecutionContext) extends ActionFunction[Request, [A]AuthInfoRequest[A, U]] with OAuth2Provider with Product with Serializable

Instance Constructors

new AuthorizedActionFunction(handler: ProtectedResourceHandler[U])(implicit ctx: ExecutionContext)

Type Members

class Status extends Result

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val Accepted: Status

val BadGateway: Status

val BadRequest: Status

val Conflict: Status

val Created: Status

val EntityTooLarge: Status

val ExpectationFailed: Status

val FailedDependency: Status

val Forbidden: Status

def Found(url: String): Result

val GatewayTimeout: Status

val Gone: Status

val HttpVersionNotSupported: Status

val InsufficientStorage: Status

val InternalServerError: Status

val Locked: Status

val MethodNotAllowed: Status

def MovedPermanently(url: String): Result

val MultiStatus: Status

val NoContent: Result

val NonAuthoritativeInformation: Status

val NotAcceptable: Status

val NotFound: Status

val NotImplemented: Status

val NotModified: Result

val Ok: Status

val PartialContent: Status

val PaymentRequired: Status

val PreconditionFailed: Status

def Redirect(call: Call, status: Int): Result

def Redirect(call: Call): Result

def Redirect(url: String, queryString: Map[String, Seq[String]], status: Int): Result

def Redirect(url: String, status: Int): Result

val RequestTimeout: Status

val ResetContent: Result

def SeeOther(url: String): Result

val ServiceUnavailable: Status

def Status(code: Int): Status

def TemporaryRedirect(url: String): Result

val TooManyRequest: Status

val Unauthorized: Status

val UnprocessableEntity: Status

val UnsupportedMediaType: Status

val UriTooLong: Status

def andThen[Q[_]](other: ActionFunction[[A]AuthInfoRequest[A, U], Q]): ActionFunction[Request, Q]

final def asInstanceOf[T0]: T0

def authorize[A, U](handler: ProtectedResourceHandler[U])(callback: (AuthInfo[U]) ⇒ Future[Result])(implicit request: Request[A], ctx: ExecutionContext): Future[Result]

def chunk(trailers: Option[Iteratee[Array[Byte], Seq[(String, String)]]]): Enumeratee[Array[Byte], Array[Byte]]

def chunk: Enumeratee[Array[Byte], Array[Byte]]

def clone(): AnyRef

def compose(other: ActionBuilder[Request]): ActionBuilder[[A]AuthInfoRequest[A, U]]

def compose[Q[_]](other: ActionFunction[Q, Request]): ActionFunction[Q, [A]AuthInfoRequest[A, U]]

def dechunk: Enumeratee[Array[Byte], Array[Byte]]

def dechunkWithTrailers: Enumeratee[Array[Byte], Either[Array[Byte], Seq[(String, String)]]]

final def eq(arg0: AnyRef): Boolean

def executionContext: ExecutionContext

def finalize(): Unit

final def getClass(): Class[_]

val handler: ProtectedResourceHandler[U]

def invokeBlock[A](request: Request[A], block: (AuthInfoRequest[A, U]) ⇒ Future[Result]): Future[Result]

final def isInstanceOf[T0]: Boolean

def issueAccessToken[A, U](handler: AuthorizationHandler[U])(implicit request: Request[A], ctx: ExecutionContext): Future[Result]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit def play2oauthRequest[A](request: Request[A]): AuthorizationRequest

implicit def play2oauthRequest(request: RequestHeader): AuthorizationRequest

implicit def play2protectedResourceRequest[A](request: Request[A]): ProtectedResourceRequest

implicit def play2protectedResourceRequest(request: RequestHeader): ProtectedResourceRequest