• BlackBerry Dynamics
  • Runtime library for Android applications
  • 12.0.1.79
Cookie Interface 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 Cookie:
ClientCookie SetCookie BasicClientCookie SetCookie2 BasicClientCookie BasicClientCookie2 BasicClientCookie2 BasicClientCookie2

Description

Author
Oleg Kalnichevski
Since
4.0

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

String getName ()
 Returns the name. More...
 
String getValue ()
 Returns the value. More...
 
String getComment ()
 Returns the comment describing the purpose of this cookie, or null if no such comment has been defined. More...
 
String getCommentURL ()
 If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described by the information at this URL.
 
Date getExpiryDate ()
 Returns the expiration java.util.Date of the cookie, or null if none exists. 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...
 
String getPath ()
 Returns the path attribute of the cookie. More...
 
int[] getPorts ()
 Get the Port attribute. More...
 
boolean isSecure ()
 Indicates whether this cookie requires a secure connection. More...
 
int getVersion ()
 Returns 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...
 

Member Function Documentation

◆ getName()

String getName ( )
Returns
String name The name

Implemented in BasicClientCookie.

◆ getValue()

String getValue ( )
Returns
String value The current value.

Implemented in BasicClientCookie.

◆ getComment()

String getComment ( )
Returns
comment

Implemented in BasicClientCookie.

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

Implemented in BasicClientCookie.

◆ isPersistent()

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

Implemented in BasicClientCookie, and BasicClientCookie2.

◆ getDomain()

String getDomain ( )
Returns
the value of the domain attribute

Implemented in BasicClientCookie.

◆ getPath()

String getPath ( )
Returns
The value of the path attribute.

Implemented in BasicClientCookie.

◆ getPorts()

int [] getPorts ( )

It restricts the ports to which a cookie may be returned in a Cookie request header.

Implemented in BasicClientCookie, and BasicClientCookie2.

◆ isSecure()

boolean isSecure ( )
Returns
true if this cookie should only be sent over secure connections, false otherwise.

Implemented in BasicClientCookie.

◆ getVersion()

int getVersion ( )
Returns
the version of the cookie.

Implemented in BasicClientCookie.

◆ isExpired()

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

Implemented in BasicClientCookie, and BasicClientCookie2.