Package org.apache.catalina.core

Class ApplicationSessionCookieConfig

java.lang.Object

org.apache.catalina.core.ApplicationSessionCookieConfig

All Implemented Interfaces:

javax.servlet.SessionCookieConfig

public class ApplicationSessionCookieConfig
extends java.lang.Object
implements javax.servlet.SessionCookieConfig

Constructor Summary

Constructors

Constructor	Description
ApplicationSessionCookieConfig(StandardContext context)

Method Summary

Modifier and Type	Method	Description
static javax.servlet.http.Cookie	createSessionCookie(Context context, java.lang.String sessionId, boolean secure)	Creates a new session cookie for the given session ID
java.lang.String	getComment()
java.lang.String	getDomain()
int	getMaxAge()
java.lang.String	getName()
java.lang.String	getPath()
boolean	isHttpOnly()
boolean	isSecure()
void	setComment(java.lang.String comment)	Sets the comment for the session cookie
void	setDomain(java.lang.String domain)	Sets the domain for the session cookie
void	setHttpOnly(boolean httpOnly)	Sets the httpOnly flag for the session cookie.
void	setMaxAge(int maxAge)	Sets the maximum age.
void	setName(java.lang.String name)	Sets the session cookie name.
void	setPath(java.lang.String path)	Sets the path of the session cookie.
void	setSecure(boolean secure)	Sets the secure flag for the session cookie.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationSessionCookieConfig

public ApplicationSessionCookieConfig(StandardContext context)

Method Detail

getComment

public java.lang.String getComment()

Specified by:

getComment in interface javax.servlet.SessionCookieConfig

getDomain

public java.lang.String getDomain()

Specified by:

getDomain in interface javax.servlet.SessionCookieConfig

getMaxAge

public int getMaxAge()

Specified by:

getMaxAge in interface javax.servlet.SessionCookieConfig

getName

public java.lang.String getName()

Specified by:

getName in interface javax.servlet.SessionCookieConfig

getPath

public java.lang.String getPath()

Specified by:

getPath in interface javax.servlet.SessionCookieConfig

isHttpOnly

public boolean isHttpOnly()

Specified by:

isHttpOnly in interface javax.servlet.SessionCookieConfig

isSecure

public boolean isSecure()

Specified by:

isSecure in interface javax.servlet.SessionCookieConfig

setComment

public void setComment(java.lang.String comment)

Description copied from interface: javax.servlet.SessionCookieConfig

Sets the comment for the session cookie

Specified by:

setComment in interface javax.servlet.SessionCookieConfig

Parameters:

comment - The session cookie comment

setDomain

public void setDomain(java.lang.String domain)

Description copied from interface: javax.servlet.SessionCookieConfig

Sets the domain for the session cookie

Specified by:

setDomain in interface javax.servlet.SessionCookieConfig

Parameters:

domain - The session cookie domain

setHttpOnly

public void setHttpOnly(boolean httpOnly)

Description copied from interface: javax.servlet.SessionCookieConfig

Sets the httpOnly flag for the session cookie.

Specified by:

setHttpOnly in interface javax.servlet.SessionCookieConfig

Parameters:

httpOnly - The httpOnly setting to use for session cookies

setMaxAge

public void setMaxAge(int maxAge)

Description copied from interface: javax.servlet.SessionCookieConfig

Sets the maximum age.

Specified by:

setMaxAge in interface javax.servlet.SessionCookieConfig

Parameters:

maxAge - the maximum age to set

setName

public void setName(java.lang.String name)

Description copied from interface: javax.servlet.SessionCookieConfig

Sets the session cookie name.

Specified by:

setName in interface javax.servlet.SessionCookieConfig

Parameters:

name - The name of the session cookie

setPath

public void setPath(java.lang.String path)

Description copied from interface: javax.servlet.SessionCookieConfig

Sets the path of the session cookie.

Specified by:

setPath in interface javax.servlet.SessionCookieConfig

Parameters:

path - The session cookie path

setSecure

public void setSecure(boolean secure)

Description copied from interface: javax.servlet.SessionCookieConfig

Sets the secure flag for the session cookie.

Specified by:

setSecure in interface javax.servlet.SessionCookieConfig

Parameters:

secure - The secure setting to use for session cookies

createSessionCookie

public static javax.servlet.http.Cookie createSessionCookie(Context context,
                                                            java.lang.String sessionId,
                                                            boolean secure)

Creates a new session cookie for the given session ID

Parameters:

context - The Context for the web application

sessionId - The ID of the session for which the cookie will be created

secure - Should session cookie be configured as secure

Returns:

the cookie for the session