javax.servlet.SessionCookieConfig Maven / Gradle / Ivy
/*
* Copyright (c) 2017, 2018 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 javax.servlet;
/**
* Class that may be used to configure various properties of cookies
* used for session tracking purposes.
*
* An instance of this class is acquired by a call to
* {@link ServletContext#getSessionCookieConfig}.
*
* @since Servlet 3.0
*/
public interface SessionCookieConfig {
/**
* Sets the name that will be assigned to any session tracking
* cookies created on behalf of the application represented by the
* ServletContext from which this SessionCookieConfig
* was acquired.
*
*
NOTE: Changing the name of session tracking cookies may break
* other tiers (for example, a load balancing frontend) that assume
* the cookie name to be equal to the default JSESSIONID,
* and therefore should only be done cautiously.
*
* @param name the cookie name to use
*
* @throws IllegalStateException if the ServletContext
* from which this SessionCookieConfig was acquired has
* already been initialized
*/
public void setName(String name);
/**
* Gets the name that will be assigned to any session tracking
* cookies created on behalf of the application represented by the
* ServletContext from which this SessionCookieConfig
* was acquired.
*
*
By default, JSESSIONID will be used as the cookie name.
*
* @return the cookie name set via {@link #setName}, or
* null if {@link #setName} was never called
*
* @see javax.servlet.http.Cookie#getName()
*/
public String getName();
/**
* Sets the domain name that will be assigned to any session tracking
* cookies created on behalf of the application represented by the
* ServletContext from which this SessionCookieConfig
* was acquired.
*
* @param domain the cookie domain to use
*
* @throws IllegalStateException if the ServletContext
* from which this SessionCookieConfig was acquired has
* already been initialized
*
* @see javax.servlet.http.Cookie#setDomain(String)
*/
public void setDomain(String domain);
/**
* Gets the domain name that will be assigned to any session tracking
* cookies created on behalf of the application represented by the
* ServletContext from which this SessionCookieConfig
* was acquired.
*
* @return the cookie domain set via {@link #setDomain}, or
* null if {@link #setDomain} was never called
*
* @see javax.servlet.http.Cookie#getDomain()
*/
public String getDomain();
/**
* Sets the path that will be assigned to any session tracking
* cookies created on behalf of the application represented by the
* ServletContext from which this SessionCookieConfig
* was acquired.
*
* @param path the cookie path to use
*
* @throws IllegalStateException if the ServletContext
* from which this SessionCookieConfig was acquired has
* already been initialized
*
* @see javax.servlet.http.Cookie#setPath(String)
*/
public void setPath(String path);
/**
* Gets the path that will be assigned to any session tracking
* cookies created on behalf of the application represented by the
* ServletContext from which this SessionCookieConfig
* was acquired.
*
*
By default, the context path of the ServletContext
* from which this SessionCookieConfig was acquired will
* be used.
*
* @return the cookie path set via {@link #setPath}, or null
* if {@link #setPath} was never called
*
* @see javax.servlet.http.Cookie#getPath()
*/
public String getPath();
/**
* Sets the comment that will be assigned to any session tracking
* cookies created on behalf of the application represented by the
* ServletContext from which this SessionCookieConfig
* was acquired.
*
*
As a side effect of this call, the session tracking cookies
* will be marked with a Version attribute equal to
* 1.
*
* @param comment the cookie comment to use
*
* @throws IllegalStateException if the ServletContext
* from which this SessionCookieConfig was acquired has
* already been initialized
*
* @see javax.servlet.http.Cookie#setComment(String)
* @see javax.servlet.http.Cookie#getVersion
*/
public void setComment(String comment);
/**
* Gets the comment that will be assigned to any session tracking
* cookies created on behalf of the application represented by the
* ServletContext from which this SessionCookieConfig
* was acquired.
*
* @return the cookie comment set via {@link #setComment}, or
* null if {@link #setComment} was never called
*
* @see javax.servlet.http.Cookie#getComment()
*/
public String getComment();
/**
* Marks or unmarks the session tracking cookies created on behalf
* of the application represented by the ServletContext from
* which this SessionCookieConfig was acquired as
* HttpOnly.
*
*
A cookie is marked as HttpOnly by adding the
* HttpOnly attribute to it. HttpOnly cookies are
* not supposed to be exposed to client-side scripting code, and may
* therefore help mitigate certain kinds of cross-site scripting
* attacks.
*
* @param httpOnly true if the session tracking cookies created
* on behalf of the application represented by 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
*
* @see javax.servlet.http.Cookie#setHttpOnly(boolean)
*/
public void setHttpOnly(boolean httpOnly);
/**
* Checks if the session tracking cookies created on behalf of the
* application represented by the ServletContext from which
* this SessionCookieConfig was acquired will be marked as
* HttpOnly.
*
* @return true if the session tracking cookies created on behalf of
* the application represented by the ServletContext from
* which this SessionCookieConfig was acquired will be marked
* as HttpOnly, false otherwise
*
* @see javax.servlet.http.Cookie#isHttpOnly()
*/
public boolean isHttpOnly();
/**
* Marks or unmarks the session tracking cookies created on behalf of
* the application represented by the ServletContext from which
* this SessionCookieConfig was acquired as secure.
*
*
One use case for marking a session tracking cookie as
* secure, even though the request that initiated the session
* came over HTTP, is to support a topology where the web container is
* front-ended by an SSL offloading load balancer.
* In this case, the traffic between the client and the load balancer
* will be over HTTPS, whereas the traffic between the load balancer
* and the web container will be over HTTP.
*
* @param secure true if the session tracking cookies created on
* behalf of the application represented by 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
*
* @see javax.servlet.http.Cookie#setSecure(boolean)
* @see ServletRequest#isSecure()
*/
public void setSecure(boolean secure);
/**
* Checks if the session tracking cookies created on behalf of the
* application represented by 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.
*
* @return true if the session tracking cookies created on behalf of the
* application represented by 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
*
* @see javax.servlet.http.Cookie#getSecure()
* @see ServletRequest#isSecure()
*/
public boolean isSecure();
/**
* Sets the lifetime (in seconds) for the session tracking cookies
* created on behalf of the application represented by the
* ServletContext from which this SessionCookieConfig
* was acquired.
*
* @param maxAge the lifetime (in seconds) of the session tracking
* cookies created on behalf of the application represented by the
* ServletContext from which this SessionCookieConfig
* was acquired.
*
* @throws IllegalStateException if the ServletContext
* from which this SessionCookieConfig was acquired has
* already been initialized
*
* @see javax.servlet.http.Cookie#setMaxAge
*/
public void setMaxAge(int maxAge);
/**
* Gets the lifetime (in seconds) of the session tracking cookies
* created on behalf of the application represented by the
* ServletContext from which this SessionCookieConfig
* was acquired.
*
*
By default, -1 is returned.
*
* @return the lifetime (in seconds) of the session tracking
* cookies created on behalf of the application represented by the
* ServletContext from which this SessionCookieConfig
* was acquired, or -1 (the default)
*
* @see javax.servlet.http.Cookie#getMaxAge
*/
public int getMaxAge();
}