scalaoauth2.provider

DataHandler

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

Provide accessing to data storage for using OAuth 2.0.

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
Learn more about member selection
Visibility
  1. Public
  2. All

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 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
  3. 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
  4. 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
  5. 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
  6. abstract def findClientUser(clientCredential: ClientCredential, scope: Option[String]): Future[Option[U]]

    Find user by clientId and clientSecret.

    Find user by clientId and clientSecret.

    If you don't support Client Credentials Grant then doesn't need implementing.

    clientCredential

    Client sends clientId and clientSecret which are registered by application.

    returns

    Return user that matched both values.

    Definition Classes
    AuthorizationHandler
  7. abstract def findUser(username: String, password: String): Future[Option[U]]

    Find userId with username and password these are used on your system.

    Find userId with username and password these are used on your system. If you don't support Resource Owner Password Credentials Grant then doesn't need implementing.

    username

    Client sends this value which is used on your system.

    password

    Client sends this value which is used on your system.

    returns

    Including UserId to Option if could find the user, None if couldn't find.

    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(clientCredential: ClientCredential, grantType: String): Future[Boolean]

    Verify proper client with parameters for issue an access token.

    Verify proper client with parameters for issue an access token.

    clientCredential

    Client sends clientId and clientSecret which are registered by application.

    grantType

    Client sends this value which is registered by application.

    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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

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

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

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

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

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

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

    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ProtectedResourceHandler[U]

Inherited from AuthorizationHandler[U]

Inherited from AnyRef

Inherited from Any

Ungrouped