class OAuth2AuthHandler extends AuthHandler with Handler[RoutingContext]

An auth handler that provides OAuth2 Authentication support. This handler is suitable for AuthCode flows.

Linear Supertypes
AuthHandler, Handler[RoutingContext], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OAuth2AuthHandler
  2. AuthHandler
  3. Handler
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OAuth2AuthHandler(_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. def addAuthorities(authorities: Set[String]): AuthHandler

    Add a set of required authorities for this auth handler * @param authorities the set of authorities

    Add a set of required authorities for this auth handler * @param authorities the set of authorities

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    OAuth2AuthHandlerAuthHandler
  5. def addAuthority(authority: String): AuthHandler

    Add a required authority for this auth handler * @param authority the authority

    Add a required authority for this auth handler * @param authority the authority

    returns

    a reference to this, so the API can be used fluently

    Definition Classes
    OAuth2AuthHandlerAuthHandler
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def asJava: AnyRef
    Definition Classes
    OAuth2AuthHandlerAuthHandler
  8. def authorize(user: User, handler: Handler[AsyncResult[Unit]]): Unit

    Authorizes the given user against all added authorities.

    Authorizes the given user against all added authorities. * @param user a user.

    handler

    the handler for the result.

    Definition Classes
    OAuth2AuthHandlerAuthHandler
  9. def authorizeFuture(user: User): Future[Unit]

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

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

    Definition Classes
    OAuth2AuthHandlerAuthHandler
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def extraParams(extraParams: JsonObject): OAuth2AuthHandler

    Extra parameters needed to be passed while requesting a token.

    Extra parameters needed to be passed while requesting a token. * @param extraParams extra optional parameters.

    returns

    self

  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def handle(arg0: RoutingContext): Unit
    Definition Classes
    OAuth2AuthHandlerAuthHandler → Handler
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def parseCredentials(context: RoutingContext, handler: Handler[AsyncResult[JsonObject]]): Unit

    Parses the credentials from the request into a JsonObject.

    Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects. * @param context the routing context

    handler

    the handler to be called once the information is available.

    Definition Classes
    OAuth2AuthHandlerAuthHandler
  23. def parseCredentialsFuture(context: RoutingContext): Future[JsonObject]

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

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

    Definition Classes
    OAuth2AuthHandlerAuthHandler
  24. def setupCallback(route: Route): OAuth2AuthHandler

    add the callback handler to a given route.

    add the callback handler to a given route. * @param route a given route e.g.: /callback

    returns

    self

  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AuthHandler

Inherited from Handler[RoutingContext]

Inherited from AnyRef

Inherited from Any

Ungrouped