Package io.vertx.mutiny.ext.web.handler

Class FormLoginHandler

java.lang.Object
io.vertx.mutiny.ext.web.handler.FormLoginHandler
All Implemented Interfaces:
MutinyDelegate, io.vertx.core.Handler<RoutingContext>, AuthenticationHandler, Consumer<RoutingContext>
public class FormLoginHandler extends Object implements AuthenticationHandler, io.vertx.core.Handler<RoutingContext>, Consumer<RoutingContext>, MutinyDelegate
Handler that handles login from a form on a custom login page.

Used in conjunction with the RedirectAuthHandler.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Tim Fox
See Also:
  • FormLoginHandler

  • Field Details

    • DEFAULT_USERNAME_PARAM

      public static final String DEFAULT_USERNAME_PARAM
      The default value of the form attribute which will contain the username
      See Also:

    • DEFAULT_PASSWORD_PARAM

      public static final String DEFAULT_PASSWORD_PARAM
      The default value of the form attribute which will contain the password
      See Also:

    • DEFAULT_RETURN_URL_PARAM

      public static final String DEFAULT_RETURN_URL_PARAM
      The default value of the session attribute which will contain the return url
      See Also:

    • __TYPE_ARG

      public static final TypeArg<FormLoginHandler> __TYPE_ARG

  • Constructor Details

    • FormLoginHandler

      public FormLoginHandler(io.vertx.ext.web.handler.FormLoginHandler delegate)
      Create a new instance of FormLoginHandler delegating to the given (non-null) instance of FormLoginHandler.

    • FormLoginHandler

      public FormLoginHandler(Object delegate)

  • Method Details

    • accept

      public void accept(RoutingContext item)
      Handle an item. This method is generated from the original method."
      Specified by:
      accept in interface AuthenticationHandler
      Specified by:
      accept in interface Consumer<RoutingContext>

    • handle

      public void handle(RoutingContext item)
      Handle an item. This method is generated from the original method."
      Specified by:
      handle in interface AuthenticationHandler
      Specified by:
      handle in interface io.vertx.core.Handler<RoutingContext>

    • getDelegate

      public io.vertx.ext.web.handler.FormLoginHandler getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface AuthenticationHandler
      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • create

      public static FormLoginHandler create(AuthenticationProvider authProvider)
      Create a handler
      Parameters:
      authProvider - the auth service to use
      Returns:
      the handler

    • create

      public static FormLoginHandler create(AuthenticationProvider authProvider, String usernameParam, String passwordParam, String returnURLParam, String directLoggedInOKURL)
      Create a handler
      Parameters:
      authProvider - the auth service to use
      usernameParam - the value of the form attribute which will contain the username
      passwordParam - the value of the form attribute which will contain the password
      returnURLParam - the value of the session attribute which will contain the return url
      directLoggedInOKURL - a url to redirect to if the user logs in directly at the url of the form login handler without being redirected here first
      Returns:
      the handler

    • setUsernameParam

      public FormLoginHandler setUsernameParam(String usernameParam)
      Set the name of the form param used to submit the username
      Parameters:
      usernameParam - the name of the param
      Returns:
      a reference to this for a fluent API

    • setPasswordParam

      public FormLoginHandler setPasswordParam(String passwordParam)
      Set the name of the form param used to submit the password
      Parameters:
      passwordParam - the name of the param
      Returns:
      a reference to this for a fluent API

    • setReturnURLParam

      public FormLoginHandler setReturnURLParam(String returnURLParam)
      Set the name of the session attrioute used to specify the return url
      Parameters:
      returnURLParam - the name of the param
      Returns:
      a reference to this for a fluent API

    • setDirectLoggedInOKURL

      public FormLoginHandler setDirectLoggedInOKURL(String directLoggedInOKURL)
      Set the url to redirect to if the user logs in directly at the url of the form login handler without being redirected here first
      Parameters:
      directLoggedInOKURL - the URL to redirect to
      Returns:
      a reference to this for a fluent API

    • newInstance

      public static FormLoginHandler newInstance(io.vertx.ext.web.handler.FormLoginHandler delegate)
      Creates a new instance of the FormLoginHandler.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object