HTTP "magic-cookie" represents a piece of state information that the HTTP agent and the target server can exchange to maintain a session. More...
The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.
/* * Copyright (C) 2006 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */
Public Member Functions | |
BasicClientCookie (final String name, final String value) | |
Default Constructor taking a name and a value. More... | |
String | getName () |
Returns the name. More... | |
String | getValue () |
Returns the value. More... | |
void | setValue (final String value) |
Sets the value. More... | |
String | getComment () |
Returns the comment describing the purpose of this cookie, or null if no such comment has been defined. More... | |
void | setComment (String comment) |
If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described using this comment. More... | |
String | getCommentURL () |
Returns null. More... | |
Date | getExpiryDate () |
Returns the expiration java.util.Date of the cookie, or null if none exists. More... | |
void | setExpiryDate (Date expiryDate) |
Sets expiration date. More... | |
boolean | isPersistent () |
Returns false if the cookie should be discarded at the end of the "session"; true otherwise. More... | |
String | getDomain () |
Returns domain attribute of the cookie. More... | |
void | setDomain (String domain) |
Sets the domain attribute. More... | |
String | getPath () |
Returns the path attribute of the cookie. More... | |
String | getOriginalCookieValue () |
Gets the Cookie as string with attributes. More... | |
void | setOriginalCookieValue (String value) |
Sets the Cookie as string with attributes. More... | |
void | setPath (String path) |
Sets the path attribute. More... | |
boolean | isSecure () |
void | setSecure (boolean secure) |
Sets the secure attribute of the cookie. More... | |
int[] | getPorts () |
Returns null. More... | |
int | getVersion () |
Returns the version of the cookie specification to which this cookie conforms. More... | |
void | setVersion (int version) |
Sets the version of the cookie specification to which this cookie conforms. More... | |
boolean | isExpired (final Date date) |
Returns true if this cookie has expired. More... | |
BasicClientCookie | ( | final String | name, |
final String | value | ||
) |
The value may be null.
name | The name. |
value | The value. |
String getName | ( | ) |
Implements Cookie.
String getValue | ( | ) |
Implements Cookie.
void setValue | ( | final String | value | ) |
value |
Implements SetCookie.
String getComment | ( | ) |
void setComment | ( | String | comment | ) |
String getCommentURL | ( | ) |
Cookies prior to RFC2965 do not set this attribute
Implements Cookie.
Reimplemented in BasicClientCookie2.
Date getExpiryDate | ( | ) |
Note: the object returned by this method is considered immutable. Changing it (e.g. using setTime()) could result in undefined behaviour. Do so at your peril.
null
.Implements Cookie.
void setExpiryDate | ( | Date | expiryDate | ) |
Note: the object returned by this method is considered immutable. Changing it (e.g. using setTime()) could result in undefined behaviour. Do so at your peril.
expiryDate | the java.util.Date after which this cookie is no longer valid. |
Implements SetCookie.
boolean isPersistent | ( | ) |
false
if the cookie should be discarded at the end of the "session"; true
otherwise Implements Cookie.
Reimplemented in BasicClientCookie2.
String getDomain | ( | ) |
void setDomain | ( | String | domain | ) |
String getPath | ( | ) |
String getOriginalCookieValue | ( | ) |
void setOriginalCookieValue | ( | String | value | ) |
value | The value of the Cookie string. |
void setPath | ( | String | path | ) |
boolean isSecure | ( | ) |
true
if this cookie should only be sent over secure connections. Implements Cookie.
void setSecure | ( | boolean | secure | ) |
When true
the cookie should only be sent using a secure protocol (https). This should only be set when the cookie's originating server used a secure protocol to set the cookie's value.
secure | The value of the secure attribute |
Implements SetCookie.
int [] getPorts | ( | ) |
Cookies prior to RFC2965 do not set this attribute
Implements Cookie.
Reimplemented in BasicClientCookie2.
int getVersion | ( | ) |
void setVersion | ( | int | version | ) |
boolean isExpired | ( | final Date | date | ) |
date | Current time |
true
if the cookie has expired. Implements Cookie.
Reimplemented in BasicClientCookie2.