class OAuth2AuthHandler extends AuthHandler with Handler[RoutingContext]
An auth handler that provides OAuth2 Authentication support. This handler is suitable for AuthCode flows.
- Alphabetic
- By Inheritance
- OAuth2AuthHandler
- AuthHandler
- Handler
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new OAuth2AuthHandler(_asJava: AnyRef)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
- OAuth2AuthHandler → AuthHandler
-
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
- OAuth2AuthHandler → AuthHandler
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asJava: AnyRef
- Definition Classes
- OAuth2AuthHandler → AuthHandler
-
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
- OAuth2AuthHandler → AuthHandler
-
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
- OAuth2AuthHandler → AuthHandler
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
handle(arg0: RoutingContext): Unit
- Definition Classes
- OAuth2AuthHandler → AuthHandler → Handler
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
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
- OAuth2AuthHandler → AuthHandler
-
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
- OAuth2AuthHandler → AuthHandler
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )