/**
 * This file Copyright (c) 2008-2010 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package info.magnolia.module.cache;

import java.util.Map;

/**
 * A cache key which will also store the SSL state. When certain pages should
 * only be available over https this allows the redirect from http to https to
 * be stored in the cache too (different replies for http and https).
 * @author will
 */
public class SSLAwareCacheKey extends DefaultCacheKey {

    private static final long serialVersionUID = -341220817226954562L;
    private Boolean isSecure;

    public SSLAwareCacheKey(String uri, String serverName, String locale, Map<String, String> params, boolean isSecure) {
        super(uri, serverName, locale, params);
        this.isSecure = isSecure;
    }

    @Override
    public int hashCode() {
        return super.hashCode() + (isSecure == null ? 33 : isSecure.hashCode());
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null || !(obj instanceof SSLAwareCacheKey)) {
            return false;
        }
        SSLAwareCacheKey that = (SSLAwareCacheKey) obj;
        return (this.getUri() == null) ? that.getUri() == null : this.getUri().equals(that.getUri())
                && (this.isSecure == null ? that.isSecure == null : this.isSecure.equals(that.isSecure))
                && (this.getDomain() == null ? that.getDomain() == null : this.getDomain().equals(that.getDomain()))
                && (this.getLocale() == null ? that.getLocale() == null : this.getLocale().equals(that.getLocale()))
                && (this.getParams() == null ? that.getParams() == null : this.getParams().equals(that.getParams()));
    }

    // generated toString() method
    @Override
    public String toString() {
        return "ProtocolAwareCacheKey{"
                + "uri='" + getUri() + '\''
                + ", serverName='" + getDomain() + '\''
                + ", locale='" + getLocale() + '\''
                + ", params=" + getParams()
                + ", secure='" + isSecure + "'"
                + '}';
    }

}