Package org.apache.tomcat.util.descriptor.web

Class LoginConfig

  • All Implemented Interfaces:
    java.io.Serializable
    public class LoginConfig
extends XmlEncodingBase
implements java.io.Serializable
    Representation of a login configuration element for a web application, as represented in a <login-config> element in the deployment descriptor.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      LoginConfig()
      Construct a new LoginConfig with default properties.
      LoginConfig​(java.lang.String authMethod, java.lang.String realmName, java.lang.String loginPage, java.lang.String errorPage)
      Construct a new LoginConfig with the specified properties.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getAuthMethod()
      Get the authentication method.
      java.lang.String getErrorPage()
      Get the error page URI.
      java.lang.String getLoginPage()
      Get the login page URI.
      java.lang.String getRealmName()
      Get the realm name.
      int hashCode()  
      void setAuthMethod​(java.lang.String authMethod)
      Set the authentication method.
      void setErrorPage​(java.lang.String errorPage)
      Set the error page URI.
      void setErrorPageDecoded​(java.lang.String errorPage)
      Set the already decoded error page URI.
      void setLoginPage​(java.lang.String loginPage)
      Set the login page URI.
      void setLoginPageDecoded​(java.lang.String loginPage)
      Set the already decoded login page URI.
      void setRealmName​(java.lang.String realmName)
      Set the realm name.
      java.lang.String toString()
      Return a String representation of this object.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LoginConfig

        public LoginConfig()
        Construct a new LoginConfig with default properties.

      • LoginConfig

        public LoginConfig​(java.lang.String authMethod,
                   java.lang.String realmName,
                   java.lang.String loginPage,
                   java.lang.String errorPage)
        Construct a new LoginConfig with the specified properties.
        Parameters:
        authMethod - The authentication method
        realmName - The realm name
        loginPage - The login page URI
        errorPage - The error page URI

    • Method Detail

      • getAuthMethod

        public java.lang.String getAuthMethod()
        Get the authentication method.
        Returns:
        the authMethod

      • setAuthMethod

        public void setAuthMethod​(java.lang.String authMethod)
        Set the authentication method.
        Parameters:
        authMethod - the authMethod to set

      • getErrorPage

        public java.lang.String getErrorPage()
        Get the error page URI.
        Returns:
        the errorPage

      • setErrorPage

        public void setErrorPage​(java.lang.String errorPage)
        Set the error page URI.
        Parameters:
        errorPage - the errorPage to set

      • setErrorPageDecoded

        public void setErrorPageDecoded​(java.lang.String errorPage)
        Set the already decoded error page URI.
        Parameters:
        errorPage - the decoded errorPage to set

      • getLoginPage

        public java.lang.String getLoginPage()
        Get the login page URI.
        Returns:
        the loginPage

      • setLoginPage

        public void setLoginPage​(java.lang.String loginPage)
        Set the login page URI.
        Parameters:
        loginPage - the loginPage to set

      • setLoginPageDecoded

        public void setLoginPageDecoded​(java.lang.String loginPage)
        Set the already decoded login page URI.
        Parameters:
        loginPage - the decoded loginPage to set

      • getRealmName

        public java.lang.String getRealmName()
        Get the realm name.
        Returns:
        the realmName

      • setRealmName

        public void setRealmName​(java.lang.String realmName)
        Set the realm name.
        Parameters:
        realmName - the realmName to set

      • toString

        public java.lang.String toString()
        Return a String representation of this object.
        Overrides:
        toString in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object