|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.openfoundation.web.XPCookie
public class XPCookie
XPCookie wraps the Cookie object.
Constructor Summary | |
---|---|
XPCookie(Cookie cookie)
Constructor that wraps the Cookie. |
|
XPCookie(java.lang.String name,
java.lang.String _value)
Constructor that creates a cookie using the name and value. |
Method Summary | |
---|---|
java.lang.String |
GetDomain()
Returns the domain to which the cookie is associated. |
int |
GetExpires()
Returns the maximum age of the cookie, specified in seconds. |
java.lang.String |
GetName()
Returns the name of the cookie. |
java.lang.String |
GetPath()
Returns the path on the server to which the browser returns this cookie. |
boolean |
GetSecure()
Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol. |
Cookie |
GetUnderlyingObject()
This retunrs underlying Cookie object. |
java.lang.String |
GetValue()
Returns the value of the cookie. |
void |
SetDeleteCookie()
Deletes the cookie. |
void |
SetDomain(java.lang.String domain)
Specifies the domain within which this cookie should be presented. |
void |
SetExpires(int expiry)
Deprecated. As of XDK 2.4.5.0. This method has inconsistent behavior in java and .NET Use SetExpireTime(), SetDeleteCookie() and SetExpireWhenBrowserCloses() instead. |
void |
SetExpireTime(int numSecToExpire)
Sets the time in seconds that the cookie will expire from the current time. |
void |
SetExpireWhenBrowserExits()
Sets the cookie to expire and be deleted when a browser exists. |
void |
SetPath(java.lang.String path)
Specifies a path for the cookie to which the client should return the cookie. |
void |
SetSecure(boolean secure)
Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL. |
void |
SetValue(java.lang.String _value)
Assigns a new value to a cookie after the cookie is created. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XPCookie(Cookie cookie)
cookie
- to wrapped into XPCookie.public XPCookie(java.lang.String name, java.lang.String _value)
name
- - Name of the cookie_value
- - Value of the cookieMethod Detail |
---|
public java.lang.String GetDomain()
public void SetDomain(java.lang.String domain)
domain
- - a String containing the domain name within which this cookie is visiblepublic java.lang.String GetName()
public java.lang.String GetPath()
public void SetPath(java.lang.String path)
path
- - a String specifying a path; if empty string or null, will set the value to null.
e.g. /portal50public boolean GetSecure()
public void SetSecure(boolean secure)
secure
- - if true, sends the cookie from the browser to the server using only when using a secure protocol; if false, sent on any protocolpublic void SetExpires(int expiry)
expiry
- - an integer specifying the maximum age of the cookie in seconds;
if negative, means the cookie is not stored; if zero, deletes the cookiepublic void SetExpireTime(int numSecToExpire)
numSecToExpire
- - number of seconds that the cookie will expire from the
current time; if 0, deletes the cookie
XPIllegalArgumentException
- if the number of second specified is negativepublic void SetDeleteCookie()
public void SetExpireWhenBrowserExits()
public int GetExpires()
public java.lang.String GetValue()
public void SetValue(java.lang.String _value)
_value
- - a String specifying the new valuepublic Cookie GetUnderlyingObject()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |