Package org.apache.catalina.core
Class SessionCookieConfigImpl
- java.lang.Object
-
- org.apache.catalina.core.SessionCookieConfigImpl
-
- All Implemented Interfaces:
jakarta.servlet.SessionCookieConfig
- Direct Known Subclasses:
WebSessionCookieConfig
public class SessionCookieConfigImpl extends Object implements jakarta.servlet.SessionCookieConfig
Class that may be used to configure various properties of cookies used for session tracking purposes.
-
-
Constructor Summary
Constructors Constructor Description SessionCookieConfigImpl(StandardContext ctx)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
getAttribute(String name)
Get the value for a given session cookie attribute.Map<String,String>
getAttributes()
Get all the session cookie attributes in case insensitive orderString
getComment()
Deprecated.String
getDomain()
int
getMaxAge()
String
getName()
String
getPath()
boolean
isHttpOnly()
boolean
isSecure()
void
setAttribute(String name, String value)
Sets the value for the given session cookie attribute.void
setComment(String comment)
Deprecated.void
setDomain(String domain)
void
setHttpOnly(boolean httpOnly)
void
setMaxAge(int maxAge)
void
setName(String name)
void
setPath(String path)
void
setSecure(boolean secure)
-
-
-
Constructor Detail
-
SessionCookieConfigImpl
public SessionCookieConfigImpl(StandardContext ctx)
Constructor
-
-
Method Detail
-
setName
public void setName(String name)
- Specified by:
setName
in interfacejakarta.servlet.SessionCookieConfig
- Parameters:
name
- the cookie name to use- Throws:
IllegalStateException
- if theServletContext
from which thisSessionCookieConfig
was acquired has already been initialized
-
getName
public String getName()
- Specified by:
getName
in interfacejakarta.servlet.SessionCookieConfig
- Returns:
- the cookie name set via
setName(java.lang.String)
, orJSESSIONID
ifsetName(java.lang.String)
was never called
-
setDomain
public void setDomain(String domain)
- Specified by:
setDomain
in interfacejakarta.servlet.SessionCookieConfig
- Parameters:
domain
- the cookie domain to use- Throws:
IllegalStateException
- if theServletContext
from which thisSessionCookieConfig
was acquired has already been initialized
-
getDomain
public String getDomain()
- Specified by:
getDomain
in interfacejakarta.servlet.SessionCookieConfig
- Returns:
- the cookie domain set via
setDomain(java.lang.String)
, ornull
ifsetDomain(java.lang.String)
was never called
-
setPath
public void setPath(String path)
- Specified by:
setPath
in interfacejakarta.servlet.SessionCookieConfig
- Parameters:
path
- the cookie path to use- Throws:
IllegalStateException
- if theServletContext
from which thisSessionCookieConfig
was acquired has already been initialized
-
getPath
public String getPath()
- Specified by:
getPath
in interfacejakarta.servlet.SessionCookieConfig
- Returns:
- the cookie path set via
setPath(java.lang.String)
, or the context path of theServletContext
from which thisSessionCookieConfig
was acquired ifsetPath(java.lang.String)
was never called
-
setComment
@Deprecated public void setComment(String comment)
Deprecated.- Specified by:
setComment
in interfacejakarta.servlet.SessionCookieConfig
- Parameters:
comment
- the cookie comment to use- Throws:
IllegalStateException
- if theServletContext
from which thisSessionCookieConfig
was acquired has already been initialized
-
getComment
@Deprecated public String getComment()
Deprecated.- Specified by:
getComment
in interfacejakarta.servlet.SessionCookieConfig
- Returns:
- the cookie comment set via
setComment(java.lang.String)
, ornull
ifsetComment(java.lang.String)
was never called
-
setHttpOnly
public void setHttpOnly(boolean httpOnly)
- Specified by:
setHttpOnly
in interfacejakarta.servlet.SessionCookieConfig
- Parameters:
httpOnly
- true if the session tracking cookies created on behalf of theServletContext
from which thisSessionCookieConfig
was acquired shall be marked as HttpOnly, false otherwise- Throws:
IllegalStateException
- if theServletContext
from which thisSessionCookieConfig
was acquired has already been initialized
-
isHttpOnly
public boolean isHttpOnly()
- Specified by:
isHttpOnly
in interfacejakarta.servlet.SessionCookieConfig
- Returns:
- true if the session tracking cookies created on behalf of the
ServletContext
from which thisSessionCookieConfig
was acquired will be marked as HttpOnly, false otherwise
-
setSecure
public void setSecure(boolean secure)
- Specified by:
setSecure
in interfacejakarta.servlet.SessionCookieConfig
- Parameters:
secure
- true if the session tracking cookies created on behalf of theServletContext
from which thisSessionCookieConfig
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 theServletContext
from which thisSessionCookieConfig
was acquired has already been initialized
-
isSecure
public boolean isSecure()
- Specified by:
isSecure
in interfacejakarta.servlet.SessionCookieConfig
- Returns:
- true if the session tracking cookies created on behalf of the
ServletContext
from which thisSessionCookieConfig
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
-
setMaxAge
public void setMaxAge(int maxAge)
- Specified by:
setMaxAge
in interfacejakarta.servlet.SessionCookieConfig
-
getMaxAge
public int getMaxAge()
- Specified by:
getMaxAge
in interfacejakarta.servlet.SessionCookieConfig
-
setAttribute
public void setAttribute(String name, String value)
Sets the value for the given session cookie attribute.- Specified by:
setAttribute
in interfacejakarta.servlet.SessionCookieConfig
- Parameters:
name
- Name of attribute to set, case insensitivevalue
- Value of attribute- Throws:
IllegalStateException
- if the associated ServletContext has already been initializedIllegalArgumentException
- If the attribute name is null or contains any characters not permitted for use in Cookie names.NumberFormatException
- If the attribute is known to be numerical but the provided value cannot be parsed to a number.
-
getAttribute
public String getAttribute(String name)
Get the value for a given session cookie attribute.- Specified by:
getAttribute
in interfacejakarta.servlet.SessionCookieConfig
- Parameters:
name
- Name of attribute- Returns:
- Value of specified attribute
-
-