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.

Definition Classes
AuthorizationHandler
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
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
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
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
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
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
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
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
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

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
@IntrinsicCandidate() @throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@IntrinsicCandidate()
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package provider

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

Abstract Value Members

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

abstract def deleteAuthCode(code: String): Future[Unit]

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 findUser(maybeCredential: Option[ClientCredential], request: AuthorizationRequest): 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(maybeCredential: Option[ClientCredential], request: AuthorizationRequest): 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

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(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from ProtectedResourceHandler[U]

Inherited from AuthorizationHandler[U]

Inherited from AnyRef

Inherited from Any

Ungrouped