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

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

mobile/android/thirdparty/ch/boye/httpclientandroidlib/cookie/CookieSpec.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.List;
michael@0	31
michael@0	32	import ch.boye.httpclientandroidlib.Header;
michael@0	33
michael@0	34	/**
michael@0	35	* Defines the cookie management specification.
michael@0	36	* <p>Cookie management specification must define
michael@0	37	* <ul>
michael@0	38	* <li> rules of parsing "Set-Cookie" header
michael@0	39	* <li> rules of validation of parsed cookies
michael@0	40	* <li> formatting of "Cookie" header
michael@0	41	* </ul>
michael@0	42	* for a given host, port and path of origin
michael@0	43	*
michael@0	44	*
michael@0	45	* @since 4.0
michael@0	46	*/
michael@0	47	public interface CookieSpec {
michael@0	48
michael@0	49	/**
michael@0	50	* Returns version of the state management this cookie specification
michael@0	51	* conforms to.
michael@0	52	*
michael@0	53	* @return version of the state management specification
michael@0	54	*/
michael@0	55	int getVersion();
michael@0	56
michael@0	57	/**
michael@0	58	* Parse the <tt>"Set-Cookie"</tt> Header into an array of Cookies.
michael@0	59	*
michael@0	60	* <p>This method will not perform the validation of the resultant
michael@0	61	* {@link Cookie}s</p>
michael@0	62	*
michael@0	63	* @see #validate
michael@0	64	*
michael@0	65	* @param header the <tt>Set-Cookie</tt> received from the server
michael@0	66	* @param origin details of the cookie origin
michael@0	67	* @return an array of <tt>Cookie</tt>s parsed from the header
michael@0	68	* @throws MalformedCookieException if an exception occurs during parsing
michael@0	69	*/
michael@0	70	List<Cookie> parse(Header header, CookieOrigin origin) throws MalformedCookieException;
michael@0	71
michael@0	72	/**
michael@0	73	* Validate the cookie according to validation rules defined by the
michael@0	74	* cookie specification.
michael@0	75	*
michael@0	76	* @param cookie the Cookie to validate
michael@0	77	* @param origin details of the cookie origin
michael@0	78	* @throws MalformedCookieException if the cookie is invalid
michael@0	79	*/
michael@0	80	void validate(Cookie cookie, CookieOrigin origin) throws MalformedCookieException;
michael@0	81
michael@0	82	/**
michael@0	83	* Determines if a Cookie matches the target location.
michael@0	84	*
michael@0	85	* @param cookie the Cookie to be matched
michael@0	86	* @param origin the target to test against
michael@0	87	*
michael@0	88	* @return <tt>true</tt> if the cookie should be submitted with a request
michael@0	89	* with given attributes, <tt>false</tt> otherwise.
michael@0	90	*/
michael@0	91	boolean match(Cookie cookie, CookieOrigin origin);
michael@0	92
michael@0	93	/**
michael@0	94	* Create <tt>"Cookie"</tt> headers for an array of Cookies.
michael@0	95	*
michael@0	96	* @param cookies the Cookies format into a Cookie header
michael@0	97	* @return a Header for the given Cookies.
michael@0	98	* @throws IllegalArgumentException if an input parameter is illegal
michael@0	99	*/
michael@0	100	List<Header> formatCookies(List<Cookie> cookies);
michael@0	101
michael@0	102	/**
michael@0	103	* Returns a request header identifying what version of the state management
michael@0	104	* specification is understood. May be <code>null</code> if the cookie
michael@0	105	* specification does not support <tt>Cookie2</tt> header.
michael@0	106	*/
michael@0	107	Header getVersionHeader();
michael@0	108
michael@0	109	}