This interface represents a SetCookie response header sent by the origin server to the HTTP agent in order to maintain a conversational state. More...

Inheritance diagram for SetCookie:

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

void	setExpiryDate (Date expiryDate)
	Sets expiration date. More...

void	setDomain (String domain)
	Sets the domain attribute. More...

void	setPath (String path)
	Sets the path attribute. More...

void	setSecure (boolean secure)
	Sets the secure attribute of the cookie. More...

void	setVersion (int version)
	Sets the version of the cookie specification to which this cookie conforms. More...

Public Member Functions inherited from Cookie
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

◆ setComment()

void setComment ( String comment )

Parameters

comment

See also: getComment()

Implemented in BasicClientCookie.

◆ 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

expiryDate the java.util.Date after which this cookie is no longer valid.

See also: Cookie::getExpiryDate

Implemented in BasicClientCookie.

◆ setDomain()

void setDomain ( String domain )

Parameters

domain The value of the domain attribute

See also: Cookie::getDomain

Implemented in BasicClientCookie.

◆ setPath()

void setPath ( String path )

Parameters

path	The value of the path attribute

See also: Cookie::getPath

Implemented in BasicClientCookie.

◆ 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

secure The value of the secure attribute