DataHandler

Abstract Value Members

abstract def createOrUpdateAccessToken(authInfo: AuthInfo[U]): AccessToken

Create or update access token by authorized information.
Create or update access token by authorized information.
authInfo
This value is created by createOrUpdateAuthInfo method.
returns
Access token return to client.
abstract def createOrUpdateAuthInfo(user: U, clientId: String, scope: Option[String]): Option[AuthInfo[U]]

Create or update authorized information by userId, clientId and scope.
Create or update authorized information by userId, clientId and scope.
Returning None when create access token then response will be invalid grant. This method also is called at the time of refresh token, it can safely return None.
user
DataHandler got this value by authentication.
clientId
Client send this value which is registered by application.
scope
Client request scope value. If client doesn't request then it will be None.
returns
created or updated authorize information. Return None if you want to strictly verify the scope.
abstract def findAccessToken(token: String): Option[AccessToken]

Find AccessToken object by access token code.
Find AccessToken object by access token code.
token
Client send access token which is created by system.
returns
Return access token that matched the token.
abstract def findAuthInfoByCode(code: String): 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 send authorization code which is registered by system.
returns
Return authorized information that matched the code.
abstract def findAuthInfoById(authId: String): Option[AuthInfo[U]]

Find authorized information by the primary key.
Find authorized information by the primary key. The value is associated with AccessToken.
authId
This value is passed from AccessToken.
returns
Return authorized information if the parameter is available.
abstract def findAuthInfoByRefreshToken(refreshToken: String): 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 send refresh token which is created by system.
returns
Return authorized information that matched the refresh token.
abstract def findClientUser(clientId: String, clientSecret: String): Option[U]

Find userId by clientId and clientSecret.
Find userId by clientId and clientSecret.
If you don't support Client Credentials Grant then doesn't need implementing.
clientId
Client send this value which is registered by application.
clientSecret
Client send this value which is registered by application.
returns
Return user that matched both values.
abstract def findUser(username: String, password: String): 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 send this value which is used on your system.
password
Client send 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 validateClient(clientId: String, clientSecret: String, grantType: String): Boolean

Verify proper client with parameters for issue an access token.
Verify proper client with parameters for issue an access token.
clientId
Client send this value which is registered by application.
clientSecret
Client send this value which is registered by application.
grantType
Client send 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: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
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
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 createOrUpdateAccessToken(authInfo: AuthInfo[U]): AccessToken

abstract def createOrUpdateAuthInfo(user: U, clientId: String, scope: Option[String]): Option[AuthInfo[U]]

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

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

abstract def findAuthInfoById(authId: String): Option[AuthInfo[U]]

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

abstract def findClientUser(clientId: String, clientSecret: String): Option[U]

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

abstract def validateClient(clientId: String, clientSecret: String, grantType: String): Boolean

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

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

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