Packages

trait OAuth2Provider extends AnyRef

Provider of OAuth2 authorization.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OAuth2Provider
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def accessTokenRequest(authorization: AuthorizationResponse): HttpRequest

    Generates HTTP request for access token request.

  2. abstract def authorizationRequest(scope: List[String]): HttpRequest

    Generates HTTP request for authorization request.

  3. abstract def clientIdentifier: String

    Public client identifier as provided after registration on authorization server.

    Public client identifier as provided after registration on authorization server. It is used for generating default file name, which holds access token.

  4. abstract def name: String

    Name of the provider.

  5. abstract def refreshTokenRequest(refreshToken: String): Option[HttpRequest]

    Generates HTTP request for refresh token request.

    Generates HTTP request for refresh token request. Returns None if this operation is not supported by the provider.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. def decodeAccessTokenResponse(body: String): Either[String, AccessTokenResponse]

    Converts textual response of access token request into AccessTokenResponse.

    Converts textual response of access token request into AccessTokenResponse. Defaults to decoding from standard JSON format, can be overriden if OAuth2 server does not adhere to this standard.

    body

    response body

    returns

    decoded access token response

    See also

    https://datatracker.ietf.org/doc/html/rfc6749#section-5.1

    https://datatracker.ietf.org/doc/html/rfc6749#section-5.2

    https://datatracker.ietf.org/doc/html/rfc8628#section-3.5

  7. def decodeAuthorizationResponse(body: String): Either[String, AuthorizationResponse]

    Converts textual response of authorization request into AuthorizationResponse.

    Converts textual response of authorization request into AuthorizationResponse. Defaults to decoding from standard JSON format, can be overridden if OAuth2 server does not adhere to this standard.

    body

    response body

    returns

    decoded authorization response

    See also

    https://datatracker.ietf.org/doc/html/rfc8628#section-3.2

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped