• file
• revisions
• annotate
• diff
• comparison
• raw

mobile/android/thirdparty/ch/boye/httpclientandroidlib/cookie/Cookie.java@fc2d59ddac77 (annotated)

mobile/android/thirdparty/ch/boye/httpclientandroidlib/cookie/Cookie.java

Wed, 31 Dec 2014 07:22:50 +0100

author

Michael Schloh von Bennewitz <michael@schloh.com>

date

Wed, 31 Dec 2014 07:22:50 +0100

branch

TOR_BUG_3246

changeset 4

fc2d59ddac77

permissions

-rw-r--r--

Correct previous dual key logic pending first delivery installment.

michael@0	1	/*
michael@0	2	* ====================================================================
michael@0	3	* Licensed to the Apache Software Foundation (ASF) under one
michael@0	4	* or more contributor license agreements. See the NOTICE file
michael@0	5	* distributed with this work for additional information
michael@0	6	* regarding copyright ownership. The ASF licenses this file
michael@0	7	* to you under the Apache License, Version 2.0 (the
michael@0	8	* "License"); you may not use this file except in compliance
michael@0	9	* with the License. You may obtain a copy of the License at
michael@0	10	*
michael@0	11	* http://www.apache.org/licenses/LICENSE-2.0
michael@0	12	*
michael@0	13	* Unless required by applicable law or agreed to in writing,
michael@0	14	* software distributed under the License is distributed on an
michael@0	15	* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0	16	* KIND, either express or implied. See the License for the
michael@0	17	* specific language governing permissions and limitations
michael@0	18	* under the License.
michael@0	19	* ====================================================================
michael@0	20	*
michael@0	21	* This software consists of voluntary contributions made by many
michael@0	22	* individuals on behalf of the Apache Software Foundation. For more
michael@0	23	* information on the Apache Software Foundation, please see
michael@0	24	* <http://www.apache.org/>.
michael@0	25	*
michael@0	26	*/
michael@0	27
michael@0	28	package ch.boye.httpclientandroidlib.cookie;
michael@0	29
michael@0	30	import java.util.Date;
michael@0	31
michael@0	32	/**
michael@0	33	* Cookie interface represents a token or short packet of state information
michael@0	34	* (also referred to as "magic-cookie") that the HTTP agent and the target
michael@0	35	* server can exchange to maintain a session. In its simples form an HTTP
michael@0	36	* cookie is merely a name / value pair.
michael@0	37	*
michael@0	38	* @since 4.0
michael@0	39	*/
michael@0	40	public interface Cookie {
michael@0	41
michael@0	42	/**
michael@0	43	* Returns the name.
michael@0	44	*
michael@0	45	* @return String name The name
michael@0	46	*/
michael@0	47	String getName();
michael@0	48
michael@0	49	/**
michael@0	50	* Returns the value.
michael@0	51	*
michael@0	52	* @return String value The current value.
michael@0	53	*/
michael@0	54	String getValue();
michael@0	55
michael@0	56	/**
michael@0	57	* Returns the comment describing the purpose of this cookie, or
michael@0	58	* <tt>null</tt> if no such comment has been defined.
michael@0	59	*
michael@0	60	* @return comment
michael@0	61	*/
michael@0	62	String getComment();
michael@0	63
michael@0	64	/**
michael@0	65	* If a user agent (web browser) presents this cookie to a user, the
michael@0	66	* cookie's purpose will be described by the information at this URL.
michael@0	67	*/
michael@0	68	String getCommentURL();
michael@0	69
michael@0	70	/**
michael@0	71	* Returns the expiration {@link Date} of the cookie, or <tt>null</tt>
michael@0	72	* if none exists.
michael@0	73	* <p><strong>Note:</strong> the object returned by this method is
michael@0	74	* considered immutable. Changing it (e.g. using setTime()) could result
michael@0	75	* in undefined behaviour. Do so at your peril. </p>
michael@0	76	* @return Expiration {@link Date}, or <tt>null</tt>.
michael@0	77	*/
michael@0	78	Date getExpiryDate();
michael@0	79
michael@0	80	/**
michael@0	81	* Returns <tt>false</tt> if the cookie should be discarded at the end
michael@0	82	* of the "session"; <tt>true</tt> otherwise.
michael@0	83	*
michael@0	84	* @return <tt>false</tt> if the cookie should be discarded at the end
michael@0	85	* of the "session"; <tt>true</tt> otherwise
michael@0	86	*/
michael@0	87	boolean isPersistent();
michael@0	88
michael@0	89	/**
michael@0	90	* Returns domain attribute of the cookie. The value of the Domain
michael@0	91	* attribute specifies the domain for which the cookie is valid.
michael@0	92	*
michael@0	93	* @return the value of the domain attribute.
michael@0	94	*/
michael@0	95	String getDomain();
michael@0	96
michael@0	97	/**
michael@0	98	* Returns the path attribute of the cookie. The value of the Path
michael@0	99	* attribute specifies the subset of URLs on the origin server to which
michael@0	100	* this cookie applies.
michael@0	101	*
michael@0	102	* @return The value of the path attribute.
michael@0	103	*/
michael@0	104	String getPath();
michael@0	105
michael@0	106	/**
michael@0	107	* Get the Port attribute. It restricts the ports to which a cookie
michael@0	108	* may be returned in a Cookie request header.
michael@0	109	*/
michael@0	110	int[] getPorts();
michael@0	111
michael@0	112	/**
michael@0	113	* Indicates whether this cookie requires a secure connection.
michael@0	114	*
michael@0	115	* @return <code>true</code> if this cookie should only be sent
michael@0	116	* over secure connections, <code>false</code> otherwise.
michael@0	117	*/
michael@0	118	boolean isSecure();
michael@0	119
michael@0	120	/**
michael@0	121	* Returns the version of the cookie specification to which this
michael@0	122	* cookie conforms.
michael@0	123	*
michael@0	124	* @return the version of the cookie.
michael@0	125	*/
michael@0	126	int getVersion();
michael@0	127
michael@0	128	/**
michael@0	129	* Returns true if this cookie has expired.
michael@0	130	* @param date Current time
michael@0	131	*
michael@0	132	* @return <tt>true</tt> if the cookie has expired.
michael@0	133	*/
michael@0	134	boolean isExpired(final Date date);
michael@0	135
michael@0	136	}
michael@0	137