Trait

scalaoauth2.provider

OAuth2AsyncProvider

Related Doc: package provider

Permalink

trait OAuth2AsyncProvider extends OAuth2Provider

OAuth2AsyncProvider supports issue access token and authorize in asynchronous.

Create controller for issue access token
Annotations
@deprecated
Deprecated

(Since version 0.12.0) Use OAuth2Provider

Examples:
  1. import scalaoauth2.provider._
    object BookController extends Controller with OAuth2AsyncProvider {
      def list = Action.async { implicit request =>
        authorize(new MyDataHandler()) { authInfo =>
          val user = authInfo.user // User is defined on your system
          // access resource for the user
        }
      }
    }
  2. ,
  3. POST /oauth2/access_token controllers.OAuth2Controller.accessToken
    Authorized
  4. ,
  5. object OAuth2Controller extends Controller with OAuth2AsyncProvider {
      def accessToken = Action.async { implicit request =>
        issueAccessToken(new MyDataHandler())
      }
    }
    Register routes
Linear Supertypes
OAuth2Provider, OAuth2BaseProvider, Results, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. OAuth2AsyncProvider
  2. OAuth2Provider
  3. OAuth2BaseProvider
  4. Results
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. class Status extends Result

    Permalink
    Definition Classes
    Results

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

    Permalink
    Definition Classes
    Results
  5. val BadGateway: Status

    Permalink
    Definition Classes
    Results
  6. val BadRequest: Status

    Permalink
    Definition Classes
    Results
  7. val Conflict: Status

    Permalink
    Definition Classes
    Results
  8. val Created: Status

    Permalink
    Definition Classes
    Results
  9. val EntityTooLarge: Status

    Permalink
    Definition Classes
    Results
  10. val ExpectationFailed: Status

    Permalink
    Definition Classes
    Results
  11. val FailedDependency: Status

    Permalink
    Definition Classes
    Results
  12. val Forbidden: Status

    Permalink
    Definition Classes
    Results
  13. def Found(url: String): Result

    Permalink
    Definition Classes
    Results
  14. val GatewayTimeout: Status

    Permalink
    Definition Classes
    Results
  15. val Gone: Status

    Permalink
    Definition Classes
    Results
  16. val HttpVersionNotSupported: Status

    Permalink
    Definition Classes
    Results
  17. val InsufficientStorage: Status

    Permalink
    Definition Classes
    Results
  18. val InternalServerError: Status

    Permalink
    Definition Classes
    Results
  19. val Locked: Status

    Permalink
    Definition Classes
    Results
  20. val MethodNotAllowed: Status

    Permalink
    Definition Classes
    Results
  21. def MovedPermanently(url: String): Result

    Permalink
    Definition Classes
    Results
  22. val MultiStatus: Status

    Permalink
    Definition Classes
    Results
  23. val NoContent: Result

    Permalink
    Definition Classes
    Results
  24. val NonAuthoritativeInformation: Status

    Permalink
    Definition Classes
    Results
  25. val NotAcceptable: Status

    Permalink
    Definition Classes
    Results
  26. val NotFound: Status

    Permalink
    Definition Classes
    Results
  27. val NotImplemented: Status

    Permalink
    Definition Classes
    Results
  28. val NotModified: Result

    Permalink
    Definition Classes
    Results
  29. val Ok: Status

    Permalink
    Definition Classes
    Results
  30. val PartialContent: Status

    Permalink
    Definition Classes
    Results
  31. val PaymentRequired: Status

    Permalink
    Definition Classes
    Results
  32. def PermanentRedirect(url: String): Result

    Permalink
    Definition Classes
    Results
  33. val PreconditionFailed: Status

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

    Permalink
    Definition Classes
    Results
  35. def Redirect(call: Call): Result

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

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

    Permalink
    Definition Classes
    Results
  38. val RequestTimeout: Status

    Permalink
    Definition Classes
    Results
  39. val ResetContent: Result

    Permalink
    Definition Classes
    Results
  40. def SeeOther(url: String): Result

    Permalink
    Definition Classes
    Results
  41. val ServiceUnavailable: Status

    Permalink
    Definition Classes
    Results
  42. def Status(code: Int): Status

    Permalink
    Definition Classes
    Results
  43. def TemporaryRedirect(url: String): Result

    Permalink
    Definition Classes
    Results
  44. val TooManyRequests: Status

    Permalink
    Definition Classes
    Results
  45. val Unauthorized: Status

    Permalink
    Definition Classes
    Results
  46. val UnprocessableEntity: Status

    Permalink
    Definition Classes
    Results
  47. val UnsupportedMediaType: Status

    Permalink
    Definition Classes
    Results
  48. val UriTooLong: Status

    Permalink
    Definition Classes
    Results
  49. final def asInstanceOf[T0]: T0

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

    Permalink

    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
  51. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  53. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  54. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  56. def hashCode(): Int

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

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

    Permalink

    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
  59. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  60. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  61. final def notifyAll(): Unit

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

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

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

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

    Permalink
    Definition Classes
    OAuth2BaseProvider
  66. val protectedResource: ProtectedResource

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  71. def toOAuthErrorString(e: OAuthError): String

    Permalink
    Attributes
    protected
    Definition Classes
    OAuth2BaseProvider
  72. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  73. val tokenEndpoint: TokenEndpoint

    Permalink
    Definition Classes
    OAuth2BaseProvider
  74. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  76. final def wait(arg0: Long): Unit

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

Deprecated Value Members

  1. val TooManyRequest: Status

    Permalink
    Definition Classes
    Results
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Use TooManyRequests instead

Inherited from OAuth2Provider

Inherited from OAuth2BaseProvider

Inherited from Results

Inherited from AnyRef

Inherited from Any

Ungrouped