scala-oauth2-core
API
Generated with
scala-oauth2-core/scalaoauth2.provider

scalaoauth2.provider

package scalaoauth2.provider

Members list

Packages

package scalaoauth2.provider.OAuthGrantType

Type members

Classlikes

class AccessDenied(description: String) extends OAuthError

Attributes

Source
OAuthException.scala
Supertypes
class OAuthError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
case class AccessToken(token: String, refreshToken: Option[String], scope: Option[String], lifeSeconds: Option[Long], createdAt: Date, params: Map[String, String])

Access token

Access token

Value parameters

createdAt

Access token is created date.

lifeSeconds

Life of the access token since its creation. In seconds.

params

Additional parameters to add information/restriction on given Access token.

refreshToken

Refresh token is used to re-issue access token.

scope

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

token

Access token is used to authentication.

Attributes

Source
DataHandler.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait AccessTokenFetcher

Attributes

Source
AccessTokenFetcher.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AuthHeader.type
object RequestParameter.type
object AuthHeader extends AccessTokenFetcher

Attributes

Source
AccessTokenFetcher.scala
Supertypes
class Object
trait Matchable
class Any
Self type
AuthHeader.type
case class AuthInfo[+U](user: U, clientId: Option[String], scope: Option[String], redirectUri: Option[String], codeChallenge: Option[String], codeChallengeMethod: Option[CodeChallengeMethod])

Authorized information

Authorized information

Value parameters

clientId

Using client id which is registered on system.

codeChallenge

This value is used by Authorization Code Grant for PKCE support.

codeChallengeMethod

This value is used by Authorization Code Grant for PKCE support.

redirectUri

This value is used by Authorization Code Grant.

scope

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

user

Authorized user which is registered on system.

Attributes

Source
DataHandler.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class AuthorizationCode extends GrantHandler

Attributes

Source
GrantHandler.scala
Supertypes
trait GrantHandler
class Object
trait Matchable
class Any
case class AuthorizationCodeRequest(request: AuthorizationRequest) extends AuthorizationRequest

Attributes

Source
AuthorizationRequest.scala
Supertypes
trait Serializable
trait Product
trait Equals
class RequestBase
class Object
trait Matchable
class Any
Show all
trait AuthorizationHandler[U]

Provide Authorization phases support for using OAuth 2.0.

Provide Authorization phases support for using OAuth 2.0.

=== [Authorization phases] ===

==== Authorization Code Grant ====

  • validateClient(request)

  • findAuthInfoByCode(code)

  • deleteAuthCode(code)

  • getStoredAccessToken(authInfo)

  • refreshAccessToken(authInfo, token)

  • createAccessToken(authInfo)

==== Refresh Token Grant ====

  • validateClient(clientCredential, grantType)

  • findAuthInfoByRefreshToken(refreshToken)

  • refreshAccessToken(authInfo, refreshToken)

==== Resource Owner Password Credentials Grant ====

  • validateClient(request)

  • findUser(request)

  • getStoredAccessToken(authInfo)

  • refreshAccessToken(authInfo, token)

  • createAccessToken(authInfo)

==== Client Credentials Grant ====

  • validateClient(request)

  • findUser(request)

  • getStoredAccessToken(authInfo)

  • refreshAccessToken(authInfo, token)

  • createAccessToken(authInfo)

==== Implicit Grant ====

  • validateClient(request)

  • findUser(request)

  • getStoredAccessToken(authInfo)

  • createAccessToken(authInfo)

Attributes

Source
AuthorizationHandler.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait DataHandler[U]
class AuthorizationRequest(headers: Map[String, Seq[String]], params: Map[String, Seq[String]]) extends RequestBase

Attributes

Source
AuthorizationRequest.scala
Supertypes
class RequestBase
class Object
trait Matchable
class Any
Known subtypes
case class ClientCredential(clientId: String, clientSecret: Option[String])

Attributes

Source
AuthorizationRequest.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class ClientCredentials extends GrantHandler

Attributes

Source
GrantHandler.scala
Supertypes
trait GrantHandler
class Object
trait Matchable
class Any
case class ClientCredentialsRequest(request: AuthorizationRequest) extends AuthorizationRequest

Attributes

Source
AuthorizationRequest.scala
Supertypes
trait Serializable
trait Product
trait Equals
class RequestBase
class Object
trait Matchable
class Any
Show all
sealed trait CodeChallengeMethod

Attributes

Companion
object
Source
DataHandler.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Plain.type
object S256.type
object CodeChallengeMethod

Attributes

Companion
trait
Source
DataHandler.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait DataHandler[U] extends AuthorizationHandler[U], ProtectedResourceHandler[U]

Provide accessing to data storage for using OAuth 2.0.

Provide accessing to data storage for using OAuth 2.0.

Attributes

Source
DataHandler.scala
Supertypes
class Object
trait Matchable
class Any
class ExpiredToken() extends OAuthError

Attributes

Source
OAuthException.scala
Supertypes
class OAuthError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
case class FetchResult(token: String, params: Map[String, String])

Attributes

Source
AccessTokenFetcher.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait GrantHandler

Attributes

Source
GrantHandler.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Implicit
class Password
class RefreshToken
case class GrantHandlerResult[U](authInfo: AuthInfo[U], tokenType: String, accessToken: String, expiresIn: Option[Long], refreshToken: Option[String], scope: Option[String], params: Map[String, String])

Attributes

Source
GrantHandler.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class Implicit extends GrantHandler

Attributes

Source
GrantHandler.scala
Supertypes
trait GrantHandler
class Object
trait Matchable
class Any
case class ImplicitRequest(request: AuthorizationRequest) extends AuthorizationRequest

Attributes

Source
AuthorizationRequest.scala
Supertypes
trait Serializable
trait Product
trait Equals
class RequestBase
class Object
trait Matchable
class Any
Show all
class InsufficientScope(description: String) extends OAuthError

Attributes

Source
OAuthException.scala
Supertypes
class OAuthError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
class InvalidClient(description: String) extends OAuthError

Attributes

Source
OAuthException.scala
Supertypes
class OAuthError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
class InvalidGrant(description: String) extends OAuthError

Attributes

Source
OAuthException.scala
Supertypes
class OAuthError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
class InvalidRequest(description: String) extends OAuthError

Attributes

Source
OAuthException.scala
Supertypes
class OAuthError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
class InvalidScope(description: String) extends OAuthError

Attributes

Source
OAuthException.scala
Supertypes
class OAuthError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
class InvalidToken(description: String) extends OAuthError

Attributes

Source
OAuthException.scala
Supertypes
class OAuthError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
abstract class OAuthError(val statusCode: Int, val description: String) extends Exception

Attributes

Source
OAuthException.scala
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class AccessDenied
class ExpiredToken
class InvalidGrant
class InvalidScope
class InvalidToken
Show all
class Password extends GrantHandler

Attributes

Source
GrantHandler.scala
Supertypes
trait GrantHandler
class Object
trait Matchable
class Any
case class PasswordRequest(request: AuthorizationRequest) extends AuthorizationRequest

Attributes

Source
AuthorizationRequest.scala
Supertypes
trait Serializable
trait Product
trait Equals
class RequestBase
class Object
trait Matchable
class Any
Show all
case object Plain extends CodeChallengeMethod

Attributes

Source
DataHandler.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Plain.type
trait ProtectedResource

Attributes

Companion
object
Source
ProtectedResource.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ProtectedResource.type
object ProtectedResource extends ProtectedResource

Attributes

Companion
trait
Source
ProtectedResource.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait ProtectedResourceHandler[+U]

Provide access to Protected Resource phase support for using OAuth 2.0.

Provide access to Protected Resource phase support for using OAuth 2.0.

=== [Access to Protected Resource phase] ===

  • findAccessToken(token)
  • findAuthInfoByAccessToken(token)

Attributes

Source
ProtectedResourceHandler.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait DataHandler[U]
class ProtectedResourceRequest(headers: Map[String, Seq[String]], params: Map[String, Seq[String]]) extends RequestBase

Attributes

Source
ProtectedResourceRequest.scala
Supertypes
class RequestBase
class Object
trait Matchable
class Any
class RedirectUriMismatch(description: String) extends OAuthError

Attributes

Source
OAuthException.scala
Supertypes
class OAuthError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
class RefreshToken extends GrantHandler

Attributes

Source
GrantHandler.scala
Supertypes
trait GrantHandler
class Object
trait Matchable
class Any
case class RefreshTokenRequest(request: AuthorizationRequest) extends AuthorizationRequest

Attributes

Source
AuthorizationRequest.scala
Supertypes
trait Serializable
trait Product
trait Equals
class RequestBase
class Object
trait Matchable
class Any
Show all
class RequestBase(val headers: TreeMap[String, Seq[String]], val params: Map[String, Seq[String]])

Attributes

Source
RequestBase.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
Show all
object RequestParameter extends AccessTokenFetcher

Attributes

Source
AccessTokenFetcher.scala
Supertypes
class Object
trait Matchable
class Any
Self type
case object S256 extends CodeChallengeMethod

Attributes

Source
DataHandler.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
S256.type
trait TokenEndpoint

Attributes

Companion
object
Source
TokenEndpoint.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object TokenEndpoint.type
object TokenEndpoint extends TokenEndpoint

Attributes

Companion
trait
Source
TokenEndpoint.scala
Supertypes
class Object
trait Matchable
class Any
Self type
class UnauthorizedClient(description: String) extends OAuthError

Attributes

Source
OAuthException.scala
Supertypes
class OAuthError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
class UnsupportedGrantType(description: String) extends OAuthError

Attributes

Source
OAuthException.scala
Supertypes
class OAuthError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
class UnsupportedResponseType(description: String) extends OAuthError

Attributes

Source
OAuthException.scala
Supertypes
class OAuthError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Generated with