Packages

class OAuth2Auth extends AnyRef

Factory interface for creating OAuth2 based io.vertx.scala.ext.auth.AuthProvider instances.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OAuth2Auth
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OAuth2Auth(_asJava: AnyRef)

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 asJava: AnyRef
  6. def authorizeURL(params: JsonObject): String

    Generate a redirect URL to the authN/Z backend.

    Generate a redirect URL to the authN/Z backend. It only applies to auth_code flow.

  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def decodeToken(token: String, handler: Handler[AsyncResult[AccessToken]]): OAuth2Auth

    Decode a token to a io.vertx.scala.ext.auth.oauth2.AccessToken object.

    Decode a token to a io.vertx.scala.ext.auth.oauth2.AccessToken object. This is useful to handle bearer JWT tokens.

    token

    the access token (base64 string)

    handler

    A handler to receive the event

    returns

    self

  9. def decodeTokenFuture(token: String): Future[AccessToken]

    Like decodeToken but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getFlowType(): OAuth2FlowType

    Returns the configured flow type for the Oauth2 provider.

    Returns the configured flow type for the Oauth2 provider.

    returns

    the flow type.

  15. def getScopeSeparator(): String

    Returns the scope separator.

    Returns the scope separator.

    The RFC 6749 states that a scope is expressed as a set of case-sensitive and space-delimited strings, however vendors tend not to agree on this and we see the following cases being used: space, plus sign, comma.

    returns

    what value was used in the configuration of the object, falling back to the default value which is a space.

  16. def getToken(params: JsonObject, handler: Handler[AsyncResult[AccessToken]]): Unit

    Returns the Access Token object.

    Returns the Access Token object.

    params

    - JSON with the options, each flow requires different options.

    handler

    - The handler returning the results.

  17. def getTokenFuture(params: JsonObject): Future[AccessToken]

    Like getToken but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  18. def hasJWTToken(): Boolean

    Returns true if this provider supports JWT tokens as the access_token.

    Returns true if this provider supports JWT tokens as the access_token. This is typically true if the provider implements the openid-connect protocol. This is a plain return from the config option jwtToken, which is false by default.

    This information is important to validate grants. Since pure OAuth2 should be used for authorization and when a token is requested all grants should be declared, in case of openid-connect this is not true. OpenId will issue a token and all grants will be encoded on the token itself so the requester does not need to list the required grants.

    returns

    true if openid-connect is used.

  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def introspectToken(token: String, tokenType: String, handler: Handler[AsyncResult[AccessToken]]): OAuth2Auth

    Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine meta-information about this token.

    Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine meta-information about this token.

    token

    the access token (base64 string)

    tokenType

    hint to the token type e.g.: access_token

    handler

    A handler to receive the event

    returns

    self

  21. def introspectToken(token: String, handler: Handler[AsyncResult[AccessToken]]): OAuth2Auth

    Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine meta-information about this token.

    Query an OAuth 2.0 authorization server to determine the active state of an OAuth 2.0 token and to determine meta-information about this token.

    token

    the access token (base64 string)

    handler

    A handler to receive the event

    returns

    self

  22. def introspectTokenFuture(token: String, tokenType: String): Future[AccessToken]

    Like introspectToken but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  23. def introspectTokenFuture(token: String): Future[AccessToken]

    Like introspectToken but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def loadJWK(handler: Handler[AsyncResult[Unit]]): OAuth2Auth

    Loads a JWK Set from the remote provider.

    Loads a JWK Set from the remote provider.

    When calling this method several times, the loaded JWKs are updated in the underlying JWT object.

  26. def loadJWKFuture(): Future[Unit]

    Like loadJWK but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def verifyIsUsingPassword(): Unit
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped