Package javax.servlet
Interface SessionCookieConfig
- All Known Implementing Classes:
SessionHandler.CookieConfig
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 Summary
Modifier and TypeMethodDescriptionintgetName()getPath()booleanbooleanisSecure()voidsetComment(String comment) Sets the comment for the session cookievoidSets 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
-
setName
Sets the session cookie name.- Parameters:
name- The name of the session cookie- Throws:
IllegalStateException- if the associated ServletContext has already been initialised
-
getName
String getName() -
setDomain
Sets the domain for the session cookie- Parameters:
domain- The session cookie domain- Throws:
IllegalStateException- if the associated ServletContext has already been initialised
-
getDomain
String getDomain() -
setPath
Sets the path of the session cookie.- Parameters:
path- The session cookie path- Throws:
IllegalStateException- if the associated ServletContext has already been initialised
-
getPath
String getPath() -
setComment
Sets the comment for the session cookie- Parameters:
comment- The session cookie comment- Throws:
IllegalStateException- if the associated ServletContext has already been initialised
-
getComment
String getComment() -
setHttpOnly
void 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
-
isHttpOnly
boolean isHttpOnly() -
setSecure
void 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
-
isSecure
boolean isSecure() -
setMaxAge
void setMaxAge(int MaxAge) Sets the maximum age.- Parameters:
MaxAge- the maximum age to set- Throws:
IllegalStateException- if the associated ServletContext has already been initialised
-
getMaxAge
int getMaxAge()
-