io.vertx.reactivex.ext.web.handler

## Class OAuth2AuthHandler

- java.lang.Object
- - io.vertx.reactivex.ext.web.handler.OAuth2AuthHandler

- All Implemented Interfaces:
    Handler<RoutingContext>, AuthHandler

      public class OAuth2AuthHandler
      extends Object
      implements 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 `original` non RX-ified interface using Vert.x codegen.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static io.vertx.lang.rx.TypeArg<OAuth2AuthHandler>` | `__TYPE_ARG`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `OAuth2AuthHandler(OAuth2AuthHandler delegate)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `AuthHandler` | `addAuthorities(Set<String> authorities)` Add a set of required authorities for this auth handler
    `AuthHandler` | `addAuthority(String authority)` Add a required authority for this auth handler
    `void` | `authorize(User user, Handler<AsyncResult<Void>> handler)` Authorizes the given user against all added authorities.
    `static OAuth2AuthHandler` | `create(OAuth2Auth authProvider)` Create a OAuth2 auth handler without host pinning.
    `static OAuth2AuthHandler` | `create(OAuth2Auth authProvider, String callbackURL)` Create a OAuth2 auth handler with host pinning
    `boolean` | `equals(Object o)`
    `OAuth2AuthHandler` | `extraParams(JsonObject extraParams)` Extra parameters needed to be passed while requesting a token.
    `OAuth2AuthHandler` | `getDelegate()`
    `void` | `handle(RoutingContext event)` Something has happened, so handle it.
    `int` | `hashCode()`
    `static OAuth2AuthHandler` | `newInstance(OAuth2AuthHandler arg)`
    `void` | `parseCredentials(RoutingContext context, Handler<AsyncResult<JsonObject>> handler)` Parses the credentials from the request into a JsonObject.
    `Completable` | `rxAuthorize(User user)` Authorizes the given user against all added authorities.
    `Single<JsonObject>` | `rxParseCredentials(RoutingContext context)` Parses the credentials from the request into a JsonObject.
    `OAuth2AuthHandler` | `setupCallback(Route route)` add the callback handler to a given route.
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface io.vertx.reactivex.ext.web.handler.AuthHandler

      `newInstance`

- - ### Field Detail

    - #### __TYPE_ARG

          public static final io.vertx.lang.rx.TypeArg<OAuth2AuthHandler> __TYPE_ARG

  - ### Constructor Detail

    - #### OAuth2AuthHandler

          public OAuth2AuthHandler(OAuth2AuthHandler delegate)

  - ### Method Detail

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

    - #### equals

          public boolean equals(Object o)

      Overrides:
        `equals` in class `Object`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

    - #### getDelegate

          public OAuth2AuthHandler getDelegate()

      Specified by:
        `getDelegate` in interface `AuthHandler`

    - #### handle

          public void handle(RoutingContext event)

      Something has happened, so handle it.
      Specified by:
        `handle` in interface `Handler<RoutingContext>`
      Specified by:
        `handle` in interface `AuthHandler`
      Parameters:
        `event` - the event to handle

    - #### addAuthority

          public AuthHandler addAuthority(String authority)

      Add a required authority for this auth handler
      Specified by:
        `addAuthority` in interface `AuthHandler`
      Parameters:
        `authority` - the authority
      Returns:
        a reference to this, so the API can be used fluently

    - #### addAuthorities

          public AuthHandler addAuthorities(Set<String> authorities)

      Add a set of required authorities for this auth handler
      Specified by:
        `addAuthorities` in interface `AuthHandler`
      Parameters:
        `authorities` - the set of authorities
      Returns:
        a reference to this, so the API can be used fluently

    - #### parseCredentials

          public void parseCredentials(RoutingContext context,
                                       Handler<AsyncResult<JsonObject>> handler)

      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.
      Specified by:
        `parseCredentials` in interface `AuthHandler`
      Parameters:
        `context` - the routing context
        `handler` - the handler to be called once the information is available.

    - #### rxParseCredentials

          public Single<JsonObject> rxParseCredentials(RoutingContext context)

      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.
      Parameters:
        `context` - the routing context
      Returns:

    - #### authorize

          public void authorize(User user,
                                Handler<AsyncResult<Void>> handler)

      Authorizes the given user against all added authorities.
      Specified by:
        `authorize` in interface `AuthHandler`
      Parameters:
        `user` - a user.
        `handler` - the handler for the result.

    - #### rxAuthorize

          public Completable rxAuthorize(User user)

      Authorizes the given user against all added authorities.
      Parameters:
        `user` - a user.
      Returns:

    - #### create

          public static OAuth2AuthHandler create(OAuth2Auth authProvider,
                                                 String callbackURL)

      Create a OAuth2 auth handler with host pinning
      Parameters:
        `authProvider` - the auth provider to use
        `callbackURL` - the callback URL you entered in your provider admin console, usually it should be something like: `https://myserver:8888/callback`
      Returns:
        the auth handler

    - #### create

          public static OAuth2AuthHandler create(OAuth2Auth authProvider)

      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.
      Parameters:
        `authProvider` - the auth provider to use
      Returns:
        the auth handler

    - #### extraParams

          public OAuth2AuthHandler extraParams(JsonObject extraParams)

      Extra parameters needed to be passed while requesting a token.
      Parameters:
        `extraParams` - extra optional parameters.
      Returns:
        self

    - #### setupCallback

          public OAuth2AuthHandler setupCallback(Route route)

      add the callback handler to a given route.
      Parameters:
        `route` - a given route e.g.: `/callback`
      Returns:
        self

    - #### newInstance

          public static OAuth2AuthHandler newInstance(OAuth2AuthHandler arg)

Copyright © 2019 Eclipse. All rights reserved.