Package org.apache.catalina.core
Class ApplicationSessionCookieConfig
- java.lang.Object
-
- org.apache.catalina.core.ApplicationSessionCookieConfig
-
- All Implemented Interfaces:
SessionCookieConfig
public class ApplicationSessionCookieConfig extends Object implements SessionCookieConfig
-
-
Constructor Summary
Constructors Constructor Description ApplicationSessionCookieConfig(StandardContext context)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CookiecreateSessionCookie(Context context, String sessionId, boolean secure)Creates a new session cookie for the given session IDStringgetAttribute(String name)Obtain the value for a sesison cookie given attribute.Map<String,String>getAttributes()Obtain the Map of attributes and values (excluding version) for this session cookie.StringgetComment()With the adoption of support for RFC 6265, this method should no longer be used.StringgetDomain()Obtain the domain to use for session cookies.intgetMaxAge()Obtain the maximum age to set for a session cookie.StringgetName()Obtain the name to use for the session cookies.StringgetPath()Obtain the path to use for session cookies.booleanisHttpOnly()Will 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)If called, this method has no effect.voidsetDomain(String domain)Sets the domain for the session cookievoidsetHttpOnly(boolean httpOnly)Sets the httpOnly flag for the session cookie.voidsetMaxAge(int maxAge)Sets the maximum age.voidsetName(String name)Sets the session cookie name.voidsetPath(String path)Sets the path of the session cookie.voidsetSecure(boolean secure)Sets the secure flag for the session cookie.
-
-
-
Constructor Detail
-
ApplicationSessionCookieConfig
public ApplicationSessionCookieConfig(StandardContext context)
-
-
Method Detail
-
getComment
public String getComment()
Description copied from interface:jakarta.servlet.SessionCookieConfigWith the adoption of support for RFC 6265, this method should no longer be used.- Specified by:
getCommentin interfaceSessionCookieConfig- Returns:
- always
null
-
getDomain
public String getDomain()
Description copied from interface:jakarta.servlet.SessionCookieConfigObtain the domain to use for session cookies.- Specified by:
getDomainin interfaceSessionCookieConfig- Returns:
- the domain to use for session cookies.
-
getMaxAge
public int getMaxAge()
Description copied from interface:jakarta.servlet.SessionCookieConfigObtain the maximum age to set for a session cookie.- Specified by:
getMaxAgein interfaceSessionCookieConfig- Returns:
- the maximum age in seconds
-
getName
public String getName()
Description copied from interface:jakarta.servlet.SessionCookieConfigObtain the name to use for the session cookies.- Specified by:
getNamein interfaceSessionCookieConfig- Returns:
- the name to use for session cookies.
-
getPath
public String getPath()
Description copied from interface:jakarta.servlet.SessionCookieConfigObtain the path to use for session cookies. This is normally the context path.- Specified by:
getPathin interfaceSessionCookieConfig- Returns:
- The path to use for session cookies.
-
isHttpOnly
public boolean isHttpOnly()
Description copied from interface:jakarta.servlet.SessionCookieConfigWill session cookies be created with the httpOnly flag set?- Specified by:
isHttpOnlyin interfaceSessionCookieConfig- Returns:
trueif the flag should be set, otherwisefalse
-
isSecure
public boolean isSecure()
Description copied from interface:jakarta.servlet.SessionCookieConfigWill session cookies be created with the secure flag set?- Specified by:
isSecurein interfaceSessionCookieConfig- Returns:
trueif the flag should be set, otherwisefalse
-
setComment
public void setComment(String comment)
Description copied from interface:jakarta.servlet.SessionCookieConfigIf called, this method has no effect.- Specified by:
setCommentin interfaceSessionCookieConfig- Parameters:
comment- Ignore
-
setDomain
public void setDomain(String domain)
Description copied from interface:jakarta.servlet.SessionCookieConfigSets the domain for the session cookie- Specified by:
setDomainin interfaceSessionCookieConfig- Parameters:
domain- The session cookie domain
-
setHttpOnly
public void setHttpOnly(boolean httpOnly)
Description copied from interface:jakarta.servlet.SessionCookieConfigSets the httpOnly flag for the session cookie.- Specified by:
setHttpOnlyin interfaceSessionCookieConfig- Parameters:
httpOnly- The httpOnly setting to use for session cookies
-
setMaxAge
public void setMaxAge(int maxAge)
Description copied from interface:jakarta.servlet.SessionCookieConfigSets the maximum age.- Specified by:
setMaxAgein interfaceSessionCookieConfig- Parameters:
maxAge- the maximum age to set
-
setName
public void setName(String name)
Description copied from interface:jakarta.servlet.SessionCookieConfigSets the session cookie name.- Specified by:
setNamein interfaceSessionCookieConfig- Parameters:
name- The name of the session cookie
-
setPath
public void setPath(String path)
Description copied from interface:jakarta.servlet.SessionCookieConfigSets the path of the session cookie.- Specified by:
setPathin interfaceSessionCookieConfig- Parameters:
path- The session cookie path
-
setSecure
public void setSecure(boolean secure)
Description copied from interface:jakarta.servlet.SessionCookieConfigSets the secure flag for the session cookie.- Specified by:
setSecurein interfaceSessionCookieConfig- Parameters:
secure- The secure setting to use for session cookies
-
setAttribute
public void setAttribute(String name, String value)
Description copied from interface:jakarta.servlet.SessionCookieConfigSets 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.- Specified by:
setAttributein interfaceSessionCookieConfig- Parameters:
name- Name of attribute to setvalue- Value of attribute
-
getAttribute
public String getAttribute(String name)
Description copied from interface:jakarta.servlet.SessionCookieConfigObtain 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.- Specified by:
getAttributein interfaceSessionCookieConfig- Parameters:
name- Name of attribute to return- Returns:
- Value of specified attribute
-
getAttributes
public Map<String,String> getAttributes()
Description copied from interface:jakarta.servlet.SessionCookieConfigObtain the Map of attributes and values (excluding version) for this session cookie.- Specified by:
getAttributesin interfaceSessionCookieConfig- Returns:
- A read-only Map of attributes to values, excluding version.
-
createSessionCookie
public static Cookie createSessionCookie(Context context, String sessionId, boolean secure)
Creates a new session cookie for the given session ID- Parameters:
context- The Context for the web applicationsessionId- The ID of the session for which the cookie will be createdsecure- Should session cookie be configured as secure- Returns:
- the cookie for the session
-
-