interface OAuth2AuthHandler : AuthHandler
An auth handler that provides OAuth2 Authentication support. This handler is suitable for AuthCode flows.
Author
Paulo Lopes
open static fun create(authProvider: OAuth2Auth, callbackURL: String): OAuth2AuthHandler
Create a OAuth2 auth handler with host pinning open static fun create(authProvider: OAuth2Auth): OAuth2AuthHandler
Create a OAuth2 auth handler without host pinning. Most providers will not look to the redirect url but always redirect to the preconfigured callback. So this factory does not provide a callback url. |
|
abstract fun extraParams(extraParams: JsonObject): OAuth2AuthHandler
Extra parameters needed to be passed while requesting a token. |
|
abstract fun setupCallback(route: Route): OAuth2AuthHandler
add the callback handler to a given route. |
abstract fun addAuthorities(authorities: MutableSet<String>): AuthHandler
Add a set of required authorities for this auth handler |
|
abstract fun addAuthority(authority: String): AuthHandler
Add a required authority for this auth handler |
|
abstract fun authorize(user: User, handler: Handler<AsyncResult<Void>>): Unit
Authorizes the given user against all added authorities. |
|
abstract fun parseCredentials(context: RoutingContext, handler: Handler<AsyncResult<JsonObject>>): Unit
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. |