/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2014 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed 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 io.undertow.server.handlers;

import java.util.Date;
import java.util.Map;

/**
 * A HTTP cookie.
 *
 * @see io.undertow.server.Connectors
 * @author Stuart Douglas
 */
public interface Cookie extends Comparable {

    String COOKIE_COMMENT_ATTR = "Comment";
    String COOKIE_DOMAIN_ATTR = "Domain";
    String COOKIE_MAX_AGE_ATTR = "Max-Age";
    String COOKIE_PATH_ATTR = "Path";
    String COOKIE_SECURE_ATTR = "Secure";
    String COOKIE_HTTP_ONLY_ATTR = "HttpOnly";
    String COOKIE_SAME_SITE_ATTR = "SameSite";
    String COOKIE_DISCARD_ATTR = "Discard";
    String COOKIE_EXPIRES_ATTR = "Expires";

    String getName();

    String getValue();

    Cookie setValue(String value);

    String getPath();

    Cookie setPath(String path);

    String getDomain();

    Cookie setDomain(String domain);

    Integer getMaxAge();

    Cookie setMaxAge(Integer maxAge);

    boolean isDiscard();

    Cookie setDiscard(boolean discard);

    boolean isSecure();

    Cookie setSecure(boolean secure);

    int getVersion();

    Cookie setVersion(int version);

    boolean isHttpOnly();

    Cookie setHttpOnly(boolean httpOnly);

    Date getExpires();

    Cookie setExpires(Date expires);

    String getComment();

    Cookie setComment(String comment);

    default boolean isSameSite() {
        return false;
    }

    @Deprecated(forRemoval = true)
    default Cookie setSameSite(final boolean sameSite) {
        throw new UnsupportedOperationException("Not implemented");
    }

    default String getSameSiteMode() {
        return null;
    }

    default Cookie setSameSiteMode(final String mode) {
        throw new UnsupportedOperationException("Not implemented");
    }

    /**
     * Returns the attribute associated with the name or {@code null} if no attribute is associated with the name.
     *
     * @param name the name of the attribute
     *
     * @return the value or {@code null} if not found
     */
    default String getAttribute(final String name) {
        throw new UnsupportedOperationException("Not implemented");
    }

    /**
     * Sets an attribute for the cookie. If the value is {@code null}, the attribute is removed. If the value is not
     * {@code null}, the attribute is added to the attributes for this cookie.
     * If name match pre-existing attribute, like "{@link Cookie#COOKIE_PATH_ATTR}" it will override that value
     *
     * @param name  the name of the attribute
     * @param value the value of the attribute or {@code null} to remove it
     *
     * @return this cookie
     */
    default Cookie setAttribute(final String name, final String value) {
        throw new UnsupportedOperationException("Not implemented");
    }

    /**
     * Returns an unmodifiable map of the attributes associated with this cookie.
     *
     * @return an unmodifiable map of the attributes
     */
    default Map<String, String> getAttributes() {
        throw new UnsupportedOperationException("Not implemented");
    }

    @Override
    default int compareTo(final Object other) {
        final Cookie o = (Cookie) other;
        int retVal = 0;

        // compare names
        if (getName() == null && o.getName() != null) return -1;
        if (getName() != null && o.getName() == null) return 1;
        retVal = (getName() == null && o.getName() == null) ? 0 : getName().compareTo(o.getName());
        if (retVal != 0) return retVal;

        // compare paths
        if (getPath() == null && o.getPath() != null) return -1;
        if (getPath() != null && o.getPath() == null) return 1;
        retVal = (getPath() == null && o.getPath() == null) ? 0 : getPath().compareTo(o.getPath());
        if (retVal != 0) return retVal;

        // compare domains
        if (getDomain() == null && o.getDomain() != null) return -1;
        if (getDomain() != null && o.getDomain() == null) return 1;
        retVal = (getDomain() == null && o.getDomain() == null) ? 0 : getDomain().compareTo(o.getDomain());
        if (retVal != 0) return retVal;

        return 0; // equal
    }

}
