provider

Type Members

1. class AccessDenied extends OAuthError

   

2. case class AccessToken(token: String, refreshToken: Option[String], scope: Option[String], expiresIn: Option[Long], createdAt: Date) extends Product with Serializable

   

   Access token

   Access token

   token

   Access token is used to authentication.

   refreshToken

   Refresh token is used to re-issue access token.

   scope

   Inform the client of the scope of the access token issued.

   expiresIn

   Expiration date of access token. Unit is seconds.

   createdAt

   Access token is created date.

3. trait AccessTokenFetcher extends AnyRef

   

4. case class AccessTokenRequest[U](clientId: String, clientSecret: String, user: U) extends Product with Serializable

   

5. case class AuthInfo[U](user: U, clientId: String, scope: Option[String], redirectUri: Option[String]) extends Product with Serializable

   

   Authorized information

   Authorized information

   user

   Authorized user which is registered on system.

   clientId

   Using client id which is registered on system.

   scope

   Inform the client of the scope of the access token issued.

   redirectUri

   This value is used by Authorization Code Grant.

6. class AuthorizationCode extends GrantHandler

   

7. case class AuthorizationRequest(headers: Map[String, Seq[String]], params: Map[String, Seq[String]]) extends RequestBase with Product with Serializable

   

8. case class ClientCredential(clientId: String, clientSecret: String) extends Product with Serializable

   

9. trait ClientCredentialFetcher extends AnyRef

   

10. class ClientCredentials extends GrantHandler

    

11. trait DataHandler[U] extends AnyRef

    

    Provide accessing to data storage for using OAuth 2.

    Provide accessing to data storage for using OAuth 2.0.

    [Authorization phases]

    Authorization Code Grant

    • validateClient(clientId, clientSecret, grantType)
    • findAuthInfoByCode(code)
    • getStoredAccessToken(authInfo)
    • isAccessTokenExpired(token)
    • refreshAccessToken(authInfo, token)
    • createAccessToken(authInfo)

    Refresh Token Grant

    • validateClient(clientId, clientSecret, grantType)
    • findAuthInfoByRefreshToken(refreshToken)
    • refreshAccessToken(authInfo, refreshToken)

    Resource Owner Password Credentials Grant

    • validateClient(clientId, clientSecret, grantType)
    • findUser(username, password)
    • getStoredAccessToken(authInfo)
    • isAccessTokenExpired(token)
    • refreshAccessToken(authInfo, token)
    • createAccessToken(authInfo)

    Client Credentials Grant

    • validateClient(clientId, clientSecret, grantType)
    • findClientUser(clientId, clientSecret)
    • getStoredAccessToken(authInfo)
    • isAccessTokenExpired(token)
    • refreshAccessToken(authInfo, token)
    • createAccessToken(authInfo)

    [Access to Protected Resource phase]

    • findAccessToken(token)
    • isAccessTokenExpired(token)
    • findAuthInfoByAccessToken(token)

12. class ExpiredToken extends OAuthError

    

13. case class FetchResult(token: String, params: Map[String, String]) extends Product with Serializable

    

14. trait GrantHandler extends AnyRef

    

15. case class GrantHandlerResult(tokenType: String, accessToken: String, expiresIn: Option[Long], refreshToken: Option[String], scope: Option[String]) extends Product with Serializable

    

16. class InsufficientScope extends OAuthError

    

17. class InvalidClient extends OAuthError

    

18. class InvalidGrant extends OAuthError

    

19. class InvalidRequest extends OAuthError

    

20. class InvalidScope extends OAuthError

    

21. class InvalidToken extends OAuthError

    

22. abstract class OAuthError extends Exception

    

23. class Password extends GrantHandler

    

24. trait ProtectedResource extends AnyRef

    

25. case class ProtectedResourceRequest(headers: Map[String, Seq[String]], params: Map[String, Seq[String]]) extends RequestBase with Product with Serializable

    

26. class RedirectUriMismatch extends OAuthError

    

27. class RefreshToken extends GrantHandler

    

28. class RequestBase extends AnyRef

    

29. class TokenEndpoint extends AnyRef

    

30. class UnauthorizedClient extends OAuthError

    

31. class UnsupportedGrantType extends OAuthError

    

32. class UnsupportedResponseType extends OAuthError