Package jakarta.servlet
Interface SessionCookieConfig
public interface SessionCookieConfig
Configures the session cookies used by the web application associated with the ServletContext from which this
 SessionCookieConfig was obtained.
- Since:
- Servlet 3.0
- 
Method SummaryModifier and TypeMethodDescriptiongetAttribute(String name) Obtain the value for a sesison cookie given attribute.Obtain the Map of attributes and values (excluding version) for this session cookie.Deprecated, for removal: This API element is subject to removal in a future version.This is no longer required with RFC 6265Obtain the domain to use for session cookies.intObtain the maximum age to set for a session cookie.getName()Obtain the name to use for the session cookies.getPath()Obtain the path to use for session cookies.booleanWill session cookies be created with the httpOnly flag set?booleanisSecure()Will session cookies be created with the secure flag set?voidsetAttribute(String name, String value) Sets the value for the given session cookie attribute.voidsetComment(String comment) Deprecated, for removal: This API element is subject to removal in a future version.This is no longer required with RFC 6265voidSets the domain for the session cookievoidsetHttpOnly(boolean httpOnly) Sets the httpOnly flag for the session cookie.voidsetMaxAge(int MaxAge) Sets the maximum age.voidSets the session cookie name.voidSets the path of the session cookie.voidsetSecure(boolean secure) Sets the secure flag for the session cookie.
- 
Method Details- 
setNameSets the session cookie name.- Parameters:
- name- The name of the session cookie
- Throws:
- IllegalStateException- if the associated ServletContext has already been initialised
 
- 
getNameString getName()Obtain the name to use for the session cookies.- Returns:
- the name to use for session cookies.
 
- 
setDomainSets the domain for the session cookie- Parameters:
- domain- The session cookie domain
- Throws:
- IllegalStateException- if the associated ServletContext has already been initialised
 
- 
getDomainString getDomain()Obtain the domain to use for session cookies.- Returns:
- the domain to use for session cookies.
 
- 
setPathSets the path of the session cookie.- Parameters:
- path- The session cookie path
- Throws:
- IllegalStateException- if the associated ServletContext has already been initialised
 
- 
getPathString getPath()Obtain the path to use for session cookies. This is normally the context path.- Returns:
- The path to use for session cookies.
 
- 
setCommentDeprecated, for removal: This API element is subject to removal in a future version.This is no longer required with RFC 6265If called, this method has no effect.- Parameters:
- comment- Ignore
- Throws:
- IllegalStateException- if the associated ServletContext has already been initialised
 
- 
getCommentDeprecated, for removal: This API element is subject to removal in a future version.This is no longer required with RFC 6265With the adoption of support for RFC 6265, this method should no longer be used.- Returns:
- always null
 
- 
setHttpOnlyvoid setHttpOnly(boolean httpOnly) Sets the httpOnly flag for the session cookie.- Parameters:
- httpOnly- The httpOnly setting to use for session cookies
- Throws:
- IllegalStateException- if the associated ServletContext has already been initialised
 
- 
isHttpOnlyboolean isHttpOnly()Will session cookies be created with the httpOnly flag set?- Returns:
- trueif the flag should be set, otherwise- false
 
- 
setSecurevoid setSecure(boolean secure) Sets the secure flag for the session cookie.- Parameters:
- secure- The secure setting to use for session cookies
- Throws:
- IllegalStateException- if the associated ServletContext has already been initialised
 
- 
isSecureboolean isSecure()Will session cookies be created with the secure flag set?- Returns:
- trueif the flag should be set, otherwise- false
 
- 
setMaxAgevoid setMaxAge(int MaxAge) Sets the maximum age.- Parameters:
- MaxAge- the maximum age to set
- Throws:
- IllegalStateException- if the associated ServletContext has already been initialised
 
- 
getMaxAgeint getMaxAge()Obtain the maximum age to set for a session cookie.- Returns:
- the maximum age in seconds
 
- 
setAttributeSets the value for the given session cookie attribute. When a value is set via this method, the value returned by the attribute specific getter (if any) must be consistent with the value set via this method.- Parameters:
- name- Name of attribute to set
- value- Value of attribute
- Throws:
- IllegalStateException- if the associated ServletContext has already been initialised
- IllegalArgumentException- 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.
- Since:
- Servlet 6.0
 
- 
getAttributeObtain the value for a sesison cookie given attribute. Values returned from this method must be consistent with the values set and returned by the attribute specific getters and setters in this class.- Parameters:
- name- Name of attribute to return
- Returns:
- Value of specified attribute
- Since:
- Servlet 6.0
 
- 
getAttributesObtain the Map of attributes and values (excluding version) for this session cookie.- Returns:
- A read-only Map of attributes to values, excluding version.
- Since:
- Servlet 6.0
 
 
-