vertx / io.vertx.rxjava.ext.web.handler / OAuth2AuthHandler

# OAuth2AuthHandler

`open class OAuth2AuthHandler : AuthHandler, Handler<RoutingContext>`

An auth handler that provides OAuth2 Authentication support. This handler is suitable for AuthCode flows. NOTE: This class has been automatically generated from the io.vertx.ext.web.handler.OAuth2AuthHandler non RX-ified interface using Vert.x codegen.

### Constructors

<init> | `OAuth2AuthHandler(delegate: OAuth2AuthHandler)`

### Properties

__TYPE_ARG | `static val __TYPE_ARG: TypeArg<OAuth2AuthHandler>`

### Functions

addAuthorities | `open fun addAuthorities(authorities: MutableSet<String>): AuthHandler` Add a set of required authorities for this auth handler
addAuthority | `open fun addAuthority(authority: String): AuthHandler` Add a required authority for this auth handler
authorize | `open fun authorize(user: User, handler: Handler<AsyncResult<Void>>): Unit` Authorizes the given user against all added authorities.
create | `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.
equals | `open fun equals(other: Any?): Boolean`
extraParams | `open fun extraParams(extraParams: JsonObject): OAuth2AuthHandler` Extra parameters needed to be passed while requesting a token.
getDelegate | `open fun getDelegate(): OAuth2AuthHandler`
handle | `open fun handle(arg0: RoutingContext): Unit`
hashCode | `open fun hashCode(): Int`
newInstance | `open static fun newInstance(arg: OAuth2AuthHandler): OAuth2AuthHandler`
parseCredentials | `open 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.
rxAuthorize | `open fun rxAuthorize(user: User): Single<Void>` Authorizes the given user against all added authorities.
rxParseCredentials | `open fun rxParseCredentials(context: RoutingContext): Single<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.
setupCallback | `open fun setupCallback(route: Route): OAuth2AuthHandler` add the callback handler to a given route.
toString | `open fun toString(): String`