Class FormLoginHandler

    • Field Detail

      • DEFAULT_USERNAME_PARAM

        public static final String DEFAULT_USERNAME_PARAM
        The default value of the form attribute which will contain the username
        See Also:
        Constant Field Values
      • DEFAULT_PASSWORD_PARAM

        public static final String DEFAULT_PASSWORD_PARAM
        The default value of the form attribute which will contain the password
        See Also:
        Constant Field Values
      • 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:
        Constant Field Values
    • Constructor Detail

      • FormLoginHandler

        public FormLoginHandler​(io.vertx.ext.web.handler.FormLoginHandler delegate)
      • FormLoginHandler

        public FormLoginHandler​(Object delegate)
    • Method Detail

      • getDelegate

        public io.vertx.ext.web.handler.FormLoginHandler getDelegate()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • create

        public static FormLoginHandler create​(AuthenticationProvider authProvider,
                                              String usernameParam,
                                              String passwordParam,
                                              String returnURLParam,
                                              String directLoggedInOKURL)
        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)
        Parameters:
        usernameParam - the name of the param
        Returns:
        a reference to this for a fluent API
      • setPasswordParam

        public FormLoginHandler setPasswordParam​(String passwordParam)
        Parameters:
        passwordParam - the name of the param
        Returns:
        a reference to this for a fluent API
      • setReturnURLParam

        public FormLoginHandler setReturnURLParam​(String returnURLParam)
        Parameters:
        returnURLParam - the name of the param
        Returns:
        a reference to this for a fluent API
      • setDirectLoggedInOKURL

        public FormLoginHandler setDirectLoggedInOKURL​(String directLoggedInOKURL)
        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 arg)