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

## [Groovy] Class RedirectAuthHandler

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

- All Implemented Interfaces and Traits:
    AuthHandler

      @groovy.transform.CompileStatic
      class RedirectAuthHandler
      extends java.lang.Object

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

- - ### Constructor Summary

    Constructors
    Constructor and description
    `RedirectAuthHandler (java.lang.Object delegate)`

  - ### Methods Summary

    Methods
    Type | Name and description
    --- | ---
    `AuthHandler` | `addAuthorities(java.util.Set<java.lang.String> authorities)` Add a set of required authorities for this auth handler
    `AuthHandler` | `addAuthority(java.lang.String authority)` Add a required authority for this auth handler
    `static AuthHandler` | `create(AuthProvider authProvider)` Create a handler
    `static AuthHandler` | `create(AuthProvider authProvider, java.lang.String loginRedirectURL)` Create a handler
    `static AuthHandler` | `create(AuthProvider authProvider, java.lang.String loginRedirectURL, java.lang.String returnURLParam)` Create a handler
    `java.lang.Object` | `getDelegate()`
    `void` | `handle(RoutingContext arg0)`

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class java.lang.Object` | `java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- - ### Constructor Detail

    - #### RedirectAuthHandler(java.lang.Object delegate)

  - ### Method Detail

    - #### AuthHandler addAuthorities(java.util.Set<java.lang.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(java.lang.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, java.lang.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, java.lang.String loginRedirectURL, java.lang.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

    - #### java.lang.Object getDelegate()

    - #### void handle(RoutingContext arg0)