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 Modifier and Type Method Description String
getComment()
String
getDomain()
int
getMaxAge()
String
getName()
String
getPath()
boolean
isHttpOnly()
boolean
isSecure()
void
setComment(String comment)
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 the ServletContext from which this SessionCookieConfig 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)
, or JSESSIONID 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 the ServletContext from which this SessionCookieConfig 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)
, or null 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 the ServletContext from which this SessionCookieConfig 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 the ServletContext from which this SessionCookieConfig was acquired ifsetPath(java.lang.String)
was never called
-
setComment
public void setComment(String comment)
- Specified by:
setComment
in interfacejakarta.servlet.SessionCookieConfig
- Parameters:
comment
- the cookie comment to use- Throws:
IllegalStateException
- if the ServletContext from which this SessionCookieConfig was acquired has already been initialized
-
getComment
public String getComment()
- Specified by:
getComment
in interfacejakarta.servlet.SessionCookieConfig
- Returns:
- the cookie comment set via
setComment(java.lang.String)
, or null 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 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
-
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 this SessionCookieConfig 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 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
-
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 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
-
setMaxAge
public void setMaxAge(int maxAge)
- Specified by:
setMaxAge
in interfacejakarta.servlet.SessionCookieConfig
-
getMaxAge
public int getMaxAge()
- Specified by:
getMaxAge
in interfacejakarta.servlet.SessionCookieConfig
-
-