• BlackBerry Dynamics
  • Runtime library for Android applications
  • 12.0.1.79
BasicClientCookie Class Reference

HTTP "magic-cookie" represents a piece of state information that the HTTP agent and the target server can exchange to maintain a session. More...

Inheritance diagram for BasicClientCookie:
SetCookie ClientCookie Cookie Cookie BasicClientCookie2

Description

Author
B.C. Holmes
Park, Sung-Gu
Doug Sale
Rod Waldhoff
dIon Gillard
Sean C. Sullivan
John Evans
Marc A. Saegesser
Oleg Kalnichevski
Mike Bowler
Version
Revision
659191

Notice

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...
 

Constructor & Destructor Documentation

◆ BasicClientCookie()

BasicClientCookie ( final String  name,
final String  value 
)

The value may be null.

Parameters
nameThe name.
valueThe value.

Member Function Documentation

◆ getName()

String getName ( )
Returns
String name The name

Implements Cookie.

◆ getValue()

String getValue ( )
Returns
String value The current value.

Implements Cookie.

◆ setValue()

void setValue ( final String  value)
Parameters
value

Implements SetCookie.

◆ getComment()

String getComment ( )
Returns
comment
See also
setComment(String)

Implements Cookie.

◆ setComment()

void setComment ( String  comment)
Parameters
comment
See also
getComment()

Implements SetCookie.

◆ getCommentURL()

String getCommentURL ( )

Cookies prior to RFC2965 do not set this attribute

Implements Cookie.

Reimplemented in BasicClientCookie2.

◆ getExpiryDate()

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.

Returns
Expiration java.util.Date, or null.
See also
setExpiryDate(java.util.Date)

Implements Cookie.

◆ setExpiryDate()

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.

Parameters
expiryDatethe java.util.Date after which this cookie is no longer valid.
See also
getExpiryDate

Implements SetCookie.

◆ isPersistent()

boolean isPersistent ( )
Returns
false if the cookie should be discarded at the end of the "session"; true otherwise

Implements Cookie.

Reimplemented in BasicClientCookie2.

◆ getDomain()

String getDomain ( )
Returns
the value of the domain attribute
See also
setDomain(java.lang.String)

Implements Cookie.

◆ setDomain()

void setDomain ( String  domain)
Parameters
domainThe value of the domain attribute
See also
getDomain

Implements SetCookie.

◆ getPath()

String getPath ( )
Returns
The value of the path attribute.
See also
setPath(java.lang.String)

Implements Cookie.

◆ getOriginalCookieValue()

String getOriginalCookieValue ( )
Returns
The value of the Cookie string.
See also
setOriginalCookieValue(java.lang.String)

◆ setOriginalCookieValue()

void setOriginalCookieValue ( String  value)
Parameters
valueThe value of the Cookie string.
See also
getOriginalCookieValue()

◆ setPath()

void setPath ( String  path)
Parameters
pathThe value of the path attribute
See also
getPath

Implements SetCookie.

◆ isSecure()

boolean isSecure ( )
Returns
true if this cookie should only be sent over secure connections.
See also
setSecure(boolean)

Implements Cookie.

◆ setSecure()

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.

Parameters
secureThe value of the secure attribute
See also
isSecure()

Implements SetCookie.

◆ getPorts()

int [] getPorts ( )

Cookies prior to RFC2965 do not set this attribute

Implements Cookie.

Reimplemented in BasicClientCookie2.

◆ getVersion()

int getVersion ( )
Returns
the version of the cookie.
See also
setVersion(int)

Implements Cookie.

◆ setVersion()

void setVersion ( int  version)
Parameters
versionthe version of the cookie.
See also
getVersion

Implements SetCookie.

◆ isExpired()

boolean isExpired ( final Date  date)
Parameters
dateCurrent time
Returns
true if the cookie has expired.

Implements Cookie.

Reimplemented in BasicClientCookie2.