• BlackBerry Dynamics
  • Runtime library for Android applications
  • 12.0.1.79
BasicClientCookie2 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 as specified by RFC2965. More...

Inheritance diagram for BasicClientCookie2:
BasicClientCookie SetCookie2 SetCookie ClientCookie SetCookie Cookie Cookie Cookie

Description

Author
Oleg Kalnichevski

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

 BasicClientCookie2 (final String name, final String value)
 Default Constructor taking a name and a value. More...
 
int[] getPorts ()
 Returns null. More...
 
void setPorts (final int[] ports)
 Sets the Port attribute. More...
 
String getCommentURL ()
 Returns null. More...
 
void setCommentURL (final String commentURL)
 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.
 
void setDiscard (boolean discard)
 Set the Discard attribute. More...
 
boolean isPersistent ()
 Returns false if the cookie should be discarded at the end of the "session"; true otherwise. More...
 
boolean isExpired (final Date date)
 Returns true if this cookie has expired. More...
 

Constructor & Destructor Documentation

◆ BasicClientCookie2()

BasicClientCookie2 ( final String  name,
final String  value 
)

The value may be null.

Parameters
nameThe name.
valueThe value.

Member Function Documentation

◆ getPorts()

int [] getPorts ( )

Cookies prior to RFC2965 do not set this attribute

Reimplemented from BasicClientCookie.

◆ setPorts()

void setPorts ( final int[]  ports)

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

Implements SetCookie2.

◆ getCommentURL()

String getCommentURL ( )

Cookies prior to RFC2965 do not set this attribute

Reimplemented from BasicClientCookie.

◆ setDiscard()

void setDiscard ( boolean  discard)

Note: Discard attribute overrides Max-age.

See also
isPersistent()

Implements SetCookie2.

◆ isPersistent()

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

Reimplemented from BasicClientCookie.

◆ isExpired()

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

Reimplemented from BasicClientCookie.