DataHandler

Abstract Value Members

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.
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.
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.
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.
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.
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.
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.
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.
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.
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.

Concrete 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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def isAccessTokenExpired(accessToken: AccessToken): Boolean

Check expiration.
Check expiration.
accessToken
accessToken
returns
true if accessToken expired
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

trait DataHandler[U] extends AnyRef

[Authorization phases]

Authorization Code Grant

Refresh Token Grant

Resource Owner Password Credentials Grant

Client Credentials Grant

[Access to Protected Resource phase]

Abstract Value Members

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

abstract def findAccessToken(token: String): Future[Option[AccessToken]]

abstract def findAuthInfoByAccessToken(accessToken: AccessToken): Future[Option[AuthInfo[U]]]

abstract def findAuthInfoByCode(code: String): Future[Option[AuthInfo[U]]]

abstract def findAuthInfoByRefreshToken(refreshToken: String): Future[Option[AuthInfo[U]]]

abstract def findClientUser(clientCredential: ClientCredential, scope: Option[String]): Future[Option[U]]

abstract def findUser(username: String, password: String): Future[Option[U]]

abstract def getStoredAccessToken(authInfo: AuthInfo[U]): Future[Option[AccessToken]]

abstract def refreshAccessToken(authInfo: AuthInfo[U], refreshToken: String): Future[AccessToken]

abstract def validateClient(clientCredential: ClientCredential, grantType: String): Future[Boolean]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def isAccessTokenExpired(accessToken: AccessToken): Boolean

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped