/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.tomcat.util.descriptor.web;

import java.io.Serializable;

import org.apache.tomcat.util.buf.UDecoder;

/**
 * Representation of a login configuration element for a web application, as represented in a
 * <code>&lt;login-config&gt;</code> element in the deployment descriptor.
 */
public class LoginConfig extends XmlEncodingBase implements Serializable {


    private static final long serialVersionUID = 2L;


    // ----------------------------------------------------------- Constructors

    /**
     * Construct a new LoginConfig with default properties.
     */
    public LoginConfig() {

        super();

    }


    /**
     * Construct a new LoginConfig with the specified properties.
     *
     * @param authMethod The authentication method
     * @param realmName  The realm name
     * @param loginPage  The login page URI
     * @param errorPage  The error page URI
     */
    public LoginConfig(String authMethod, String realmName, String loginPage, String errorPage) {

        super();
        setAuthMethod(authMethod);
        setRealmName(realmName);
        setLoginPage(loginPage);
        setErrorPage(errorPage);

    }


    // ------------------------------------------------------------- Properties


    /**
     * The authentication method to use for application login. Must be BASIC, DIGEST, FORM, or CLIENT-CERT.
     */
    private String authMethod = null;

    /**
     * Get the authentication method.
     *
     * @return the authMethod
     */
    public String getAuthMethod() {
        return this.authMethod;
    }

    /**
     * Set the authentication method.
     *
     * @param authMethod the authMethod to set
     */
    public void setAuthMethod(String authMethod) {
        this.authMethod = authMethod;
    }


    /**
     * The context-relative URI of the error page for form login.
     */
    private String errorPage = null;

    /**
     * Get the error page URI.
     *
     * @return the errorPage
     */
    public String getErrorPage() {
        return this.errorPage;
    }

    /**
     * Set the error page URI.
     *
     * @param errorPage the errorPage to set
     */
    public void setErrorPage(String errorPage) {
        this.errorPage = UDecoder.URLDecode(errorPage, getCharset());
    }


    /**
     * Set the already decoded error page URI.
     *
     * @param errorPage the decoded errorPage to set
     */
    public void setErrorPageDecoded(String errorPage) {
        this.errorPage = errorPage;
    }


    /**
     * The context-relative URI of the login page for form login.
     */
    private String loginPage = null;

    /**
     * Get the login page URI.
     *
     * @return the loginPage
     */
    public String getLoginPage() {
        return this.loginPage;
    }

    /**
     * Set the login page URI.
     *
     * @param loginPage the loginPage to set
     */
    public void setLoginPage(String loginPage) {
        this.loginPage = UDecoder.URLDecode(loginPage, getCharset());
    }


    /**
     * Set the already decoded login page URI.
     *
     * @param loginPage the decoded loginPage to set
     */
    public void setLoginPageDecoded(String loginPage) {
        this.loginPage = loginPage;
    }


    /**
     * The realm name used when challenging the user for authentication credentials.
     */
    private String realmName = null;

    /**
     * Get the realm name.
     *
     * @return the realmName
     */
    public String getRealmName() {
        return this.realmName;
    }

    /**
     * Set the realm name.
     *
     * @param realmName the realmName to set
     */
    public void setRealmName(String realmName) {
        this.realmName = realmName;
    }


    // --------------------------------------------------------- Public Methods


    /**
     * Return a String representation of this object.
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder("LoginConfig[");
        sb.append("authMethod=");
        sb.append(authMethod);
        if (realmName != null) {
            sb.append(", realmName=");
            sb.append(realmName);
        }
        if (loginPage != null) {
            sb.append(", loginPage=");
            sb.append(loginPage);
        }
        if (errorPage != null) {
            sb.append(", errorPage=");
            sb.append(errorPage);
        }
        sb.append(']');
        return sb.toString();
    }


    /*
     * (non-Javadoc)
     *
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((authMethod == null) ? 0 : authMethod.hashCode());
        result = prime * result + ((errorPage == null) ? 0 : errorPage.hashCode());
        result = prime * result + ((loginPage == null) ? 0 : loginPage.hashCode());
        result = prime * result + ((realmName == null) ? 0 : realmName.hashCode());
        return result;
    }


    /*
     * (non-Javadoc)
     *
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof LoginConfig)) {
            return false;
        }
        LoginConfig other = (LoginConfig) obj;
        if (authMethod == null) {
            if (other.authMethod != null) {
                return false;
            }
        } else if (!authMethod.equals(other.authMethod)) {
            return false;
        }
        if (errorPage == null) {
            if (other.errorPage != null) {
                return false;
            }
        } else if (!errorPage.equals(other.errorPage)) {
            return false;
        }
        if (loginPage == null) {
            if (other.loginPage != null) {
                return false;
            }
        } else if (!loginPage.equals(other.loginPage)) {
            return false;
        }
        if (realmName == null) {
            return other.realmName == null;
        } else {
            return realmName.equals(other.realmName);
        }
    }


}
