org.glassfish.grizzly.servlet.SessionCookieConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grizzly-http-all Show documentation
The newest version!
/*
 * Copyright (c) 2022 Contributors to the Eclipse Foundation
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.grizzly.servlet;

import java.util.Collections;
import java.util.Map;
import java.util.TreeMap;

import org.glassfish.grizzly.http.server.Constants;


/**
 * Class that may be used to configure various properties of cookies used for session tracking purposes.
 */
public class SessionCookieConfig implements jakarta.servlet.SessionCookieConfig {

    private static final int DEFAULT_MAX_AGE = -1;
    private static final boolean DEFAULT_HTTP_ONLY = true;
    private static final boolean DEFAULT_SECURE = false;
    private static final String DEFAULT_NAME = "JSESSIONID";

    private String name = DEFAULT_NAME;

    private final Map attributes = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
    private final WebappContext ctx;

    /**
     * Constructor
     */
    public SessionCookieConfig(WebappContext ctx) {
        this.ctx = ctx;
    }

    /**
     * @param name the cookie name to use
     *
     * @throws IllegalStateException if the ServletContext from which this SessionCookieConfig was
     * acquired has already been initialized
     */
    @Override
    public void setName(String name) {
        if (ctx.deployed) {
            throw new IllegalStateException("WebappContext has already been deployed");
        }
        this.name = name;
    }

    /**
     * @return the cookie name set via {@link #setName}, or JSESSIONID if {@link #setName} was never called
     */
    @Override
    public String getName() {
        return name;
    }

    /**
     * @param domain the cookie domain to use
     *
     * @throws IllegalStateException if the ServletContext from which this SessionCookieConfig was
     * acquired has already been initialized
     */
    @Override
    public void setDomain(String domain) {
        if (ctx.deployed) {
            throw new IllegalStateException("WebappContext has already been deployed");
        }
        setAttribute(Constants.COOKIE_DOMAIN_ATTR, domain);
    }

    /**
     * @return the cookie domain set via {@link #setDomain}, or null if {@link #setDomain} was never called
     */
    @Override
    public String getDomain() {
        return getAttribute(Constants.COOKIE_DOMAIN_ATTR);
    }

    /**
     * @param path the cookie path to use
     *
     * @throws IllegalStateException if the ServletContext from which this SessionCookieConfig was
     * acquired has already been initialized
     */
    @Override
    public void setPath(String path) {
        if (ctx.deployed) {
            throw new IllegalStateException("WebappContext has already been deployed");
        }
        setAttribute(Constants.COOKIE_PATH_ATTR, path);
    }

    /**
     * @return the cookie path set via {@link #setPath}, or the context path of the ServletContext from which this
     * SessionCookieConfig was acquired if {@link #setPath} was never called
     */
    @Override
    public String getPath() {
        return getAttribute(Constants.COOKIE_PATH_ATTR);
    }

    /**
     * @param comment the cookie comment to use
     *
     * @throws IllegalStateException if the ServletContext from which this SessionCookieConfig was
     * acquired has already been initialized
     * @deprecated
     */
    @Deprecated
    @Override
    public void setComment(String comment) {
        if (ctx.deployed) {
            throw new IllegalStateException("WebappContext has already been deployed");
        }
        setAttribute(Constants.COOKIE_COMMENT_ATTR, comment);
    }

    /**
     * @return the cookie comment set via {@link #setComment}, or null if {@link #setComment} was never called
     * @deprecated
     */
    @Deprecated
    @Override
    public String getComment() {
        return getAttribute(Constants.COOKIE_COMMENT_ATTR);
    }

    /**
     * @param httpOnly true if the session tracking cookies created on behalf of the ServletContext from which this
     * SessionCookieConfig was acquired shall be marked as HttpOnly, false otherwise
     *
     * @throws IllegalStateException if the ServletContext from which this SessionCookieConfig was
     * acquired has already been initialized
     */
    @Override
    public void setHttpOnly(boolean httpOnly) {
        if (ctx.deployed) {
            throw new IllegalStateException("WebappContext has already been deployed");
        }
        setAttribute(Constants.COOKIE_HTTP_ONLY_ATTR, String.valueOf(httpOnly));
    }

    /**
     * @return true if the session tracking cookies created on behalf of the ServletContext from which this
     * SessionCookieConfig was acquired will be marked as HttpOnly, false otherwise
     */
    @Override
    public boolean isHttpOnly() {
        String value = getAttribute(Constants.COOKIE_HTTP_ONLY_ATTR);
        return value == null ? DEFAULT_HTTP_ONLY : Boolean.parseBoolean(value);
    }

    /**
     * @param secure true if the session tracking cookies created on behalf of the ServletContext from which this
     * SessionCookieConfig was acquired shall be marked as secure even if the request that initiated the
     * corresponding session is using plain HTTP instead of HTTPS, and false if they shall be marked as secure only
     * if the request that initiated the corresponding session was also secure
     *
     * @throws IllegalStateException if the ServletContext from which this SessionCookieConfig was
     * acquired has already been initialized
     */
    @Override
    public void setSecure(boolean secure) {
        if (ctx.deployed) {
            throw new IllegalStateException("WebappContext has already been deployed");
        }
        setAttribute(Constants.COOKIE_SECURE_ATTR, String.valueOf(secure));
    }

    /**
     * @return true if the session tracking cookies created on behalf of the ServletContext from which this
     * SessionCookieConfig was acquired will be marked as secure even if the request that initiated the
     * corresponding session is using plain HTTP instead of HTTPS, and false if they will be marked as secure only if
     * the request that initiated the corresponding session was also secure
     */
    @Override
    public boolean isSecure() {
        String value = getAttribute(Constants.COOKIE_SECURE_ATTR);
        return value == null ? DEFAULT_SECURE : Boolean.parseBoolean(value);
    }

    @Override
    public void setMaxAge(int maxAge) {
        if (ctx.deployed) {
            throw new IllegalStateException("WebappContext has already been deployed");
        }
        setAttribute(Constants.COOKIE_MAX_AGE_ATTR, String.valueOf(maxAge));
    }

    @Override
    public int getMaxAge() {
        String value = getAttribute(Constants.COOKIE_MAX_AGE_ATTR);
        return value == null ? DEFAULT_MAX_AGE : Integer.parseInt(value);
    }

    @Override
    public void setAttribute(String name, String value) {
        this.attributes.put(name, value);
    }

    @Override
    public String getAttribute(String name) {
        return this.attributes.get(name);
    }

    @Override
    public Map getAttributes() {
        return Collections.unmodifiableMap(this.attributes);
    }
}