com.plumtree.server
Interface IPTCookieInfo

public interface IPTCookieInfo

Used to forward a Single Sign-On cookie.

Author:

JosephS

See Also:

IPTSSOInfo

Method Summary

java.lang.String	GetCookieDomain() Cookie should be forward to URLs in this domain.
com.plumtree.openfoundation.util.XPDateTime	GetCookieExpirationDate() Get the expiration date and time of the cookie.
java.lang.String	GetCookieName() Get the name of the cookie.
java.lang.String	GetCookiePath() Cookie should be forward to URLs within this path.
java.lang.String	GetCookieValue() Get the value of the cookie.
boolean	IsSecureCookie() A secure cookie must be sent over SSL, it is never sent to http:// URLs.
void	PutCookieInfo(java.lang.String bstrCookieName, java.lang.String bstrCookieValue, com.plumtree.openfoundation.util.XPDateTime dtExpires, java.lang.String bstrPath, java.lang.String bstrDomain, boolean bSecure) Set all the properties in one call.

Method Detail

PutCookieInfo

void PutCookieInfo(java.lang.String bstrCookieName,
                   java.lang.String bstrCookieValue,
                   com.plumtree.openfoundation.util.XPDateTime dtExpires,
                   java.lang.String bstrPath,
                   java.lang.String bstrDomain,
                   boolean bSecure)

Set all the properties in one call.

Parameters:

bstrCookieName - the name of the cookie.

bstrCookieValue - the value of the cookie.

dtExpires - expiration date and time.

bstrPath - the cookie path.

bstrDomain - the cookie domain.

bSecure - true if cookie is secure (must be sent over SSL).

GetCookieName

java.lang.String GetCookieName()

Get the name of the cookie.

Returns:

The name.

GetCookieValue

java.lang.String GetCookieValue()

Get the value of the cookie.

Returns:

The value.

GetCookieExpirationDate

com.plumtree.openfoundation.util.XPDateTime GetCookieExpirationDate()

Get the expiration date and time of the cookie.

Returns:

Expiration date and time.

GetCookiePath

java.lang.String GetCookiePath()

Cookie should be forward to URLs within this path.

Returns:

The cookie path.

GetCookieDomain

java.lang.String GetCookieDomain()

Cookie should be forward to URLs in this domain.

Returns:

The cookie domain.

IsSecureCookie

boolean IsSecureCookie()

A secure cookie must be sent over SSL, it is never sent to http:// URLs.

Returns:

True if cookie is secure, false otherwise.