Package: io.vertx.groovy.ext.web.handler

## [Groovy] Class RedirectAuthHandler

- io.vertx.groovy.ext.web.handler.RedirectAuthHandler

- All Implemented Interfaces and Traits:
    AuthHandler

      @CompileStatic
      class RedirectAuthHandler

  An auth handler that's used to handle auth by redirecting user to a custom login page.

- - ### Constructor Summary

    Constructors
    Constructor and description
    `RedirectAuthHandler (Object delegate)`

  - ### Methods Summary

    Methods
    Type | Name 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
    `static AuthHandler` | `create(AuthProvider authProvider)` Create a handler
    `static AuthHandler` | `create(AuthProvider authProvider, String loginRedirectURL)` Create a handler
    `static AuthHandler` | `create(AuthProvider authProvider, String loginRedirectURL, String returnURLParam)` Create a handler
    `Object` | `getDelegate()`
    `void` | `handle(RoutingContext arg0)`

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class Object` | `wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- - ### Constructor Detail

    - #### RedirectAuthHandler(Object delegate)

  - ### Method Detail

    - #### AuthHandler addAuthorities(Set<String> authorities)

      Add a set of required authorities for this auth handler

      Returns:
        a reference to this, so the API can be used fluently
      Parameters:
        `authorities` - the set of authorities

    - #### AuthHandler addAuthority(String authority)

      Add a required authority for this auth handler

      Returns:
        a reference to this, so the API can be used fluently
      Parameters:
        `authority` - the authority

    - #### static AuthHandler create(AuthProvider authProvider)

      Create a handler

      Returns:
        the handler
      Parameters:
        `authProvider` - the auth service to use

    - #### static AuthHandler create(AuthProvider authProvider, String loginRedirectURL)

      Create a handler

      Returns:
        the handler
      Parameters:
        `authProvider` - the auth service to use
        `loginRedirectURL` - the url to redirect the user to

    - #### static AuthHandler create(AuthProvider authProvider, String loginRedirectURL, String returnURLParam)

      Create a handler

      Returns:
        the handler
      Parameters:
        `authProvider` - the auth service to use
        `loginRedirectURL` - the url to redirect the user to
        `returnURLParam` - the name of param used to store return url information in session

    - #### Object getDelegate()

    - #### void handle(RoutingContext arg0)