trait DataHandler[U] extends AuthorizationHandler[U] with ProtectedResourceHandler[U]

Provide accessing to data storage for using OAuth 2.0.

Source
DataHandler.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DataHandler
  2. ProtectedResourceHandler
  3. AuthorizationHandler
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def createAccessToken(authInfo: AuthInfo[U]): Future[AccessToken]

    Creates a new access token by authorized information.

    Creates a new access token by authorized information.

    authInfo

    This value is already authorized by system.

    returns

    Access token returns to client.

    Definition Classes
    AuthorizationHandler
  2. abstract def deleteAuthCode(code: String): Future[Unit]

    Deletes an authorization code.

    Deletes an authorization code.

    Called when an AccessToken has been successfully issued via an authorization code.

    If you don't support Authorization Code Grant, then you don't need to implement this method.

    code

    Client-sent authorization code

    Definition Classes
    AuthorizationHandler
  3. abstract def findAccessToken(token: String): Future[Option[AccessToken]]

    Find AccessToken object by access token code.

    Find AccessToken object by access token code.

    token

    Client sends access token which is created by system.

    returns

    Return access token that matched the token.

    Definition Classes
    ProtectedResourceHandler
  4. abstract def findAuthInfoByAccessToken(accessToken: AccessToken): Future[Option[AuthInfo[U]]]

    Find authorized information by access token.

    Find authorized information by access token.

    accessToken

    This value is AccessToken.

    returns

    Return authorized information if the parameter is available.

    Definition Classes
    ProtectedResourceHandler
  5. abstract def findAuthInfoByCode(code: String): Future[Option[AuthInfo[U]]]

    Find authorized information by authorization code.

    Find authorized information by authorization code.

    If you don't support Authorization Code Grant then doesn't need implementing.

    code

    Client sends authorization code which is registered by system.

    returns

    Return authorized information that matched the code.

    Definition Classes
    AuthorizationHandler
  6. abstract def findAuthInfoByRefreshToken(refreshToken: String): Future[Option[AuthInfo[U]]]

    Find authorized information by refresh token.

    Find authorized information by refresh token.

    If you don't support Refresh Token Grant then doesn't need implementing.

    refreshToken

    Client sends refresh token which is created by system.

    returns

    Return authorized information that matched the refresh token.

    Definition Classes
    AuthorizationHandler
  7. abstract def findUser(maybeCredential: Option[ClientCredential], request: AuthorizationRequest): Future[Option[U]]

    Authenticate the user that issued the authorization request.

    Authenticate the user that issued the authorization request. Client credential, Password and Implicit Grant call this method.

    maybeCredential

    client credential parsed from request

    request

    Request sent by client.

    Definition Classes
    AuthorizationHandler
  8. abstract def getStoredAccessToken(authInfo: AuthInfo[U]): Future[Option[AccessToken]]

    Returns stored access token by authorized information.

    Returns stored access token by authorized information.

    If want to create new access token then have to return None

    authInfo

    This value is already authorized by system.

    returns

    Access token returns to client.

    Definition Classes
    AuthorizationHandler
  9. abstract def refreshAccessToken(authInfo: AuthInfo[U], refreshToken: String): Future[AccessToken]

    Creates a new access token by refreshToken.

    Creates a new access token by refreshToken.

    authInfo

    This value is already authorized by system.

    returns

    Access token returns to client.

    Definition Classes
    AuthorizationHandler
  10. abstract def validateClient(maybeCredential: Option[ClientCredential], request: AuthorizationRequest): Future[Boolean]

    Verify proper client with parameters for issue an access token.

    Verify proper client with parameters for issue an access token. Note that per the OAuth Specification, a Client may be valid if it only contains a client ID but no client secret (common with Public Clients). However, if the registered client has a client secret value the specification requires that a client secret must always be provided and verified for that client ID.

    maybeCredential

    client credential parsed from request

    request

    Request sent by client.

    returns

    true if request is a regular client, false if request is a illegal client.

    Definition Classes
    AuthorizationHandler

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from ProtectedResourceHandler[U]

Inherited from AuthorizationHandler[U]

Inherited from AnyRef

Inherited from Any

Ungrouped