You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ol...@apache.org on 2008/01/21 13:04:32 UTC
svn commit: r613865 - in /httpcomponents/httpclient/trunk: ./
module-client/src/main/java/org/apache/http/client/params/
module-client/src/main/java/org/apache/http/impl/client/
module-client/src/main/java/org/apache/http/impl/cookie/ module-client/src...
Author: olegk
Date: Mon Jan 21 04:04:30 2008
New Revision: 613865
URL: http://svn.apache.org/viewvc?rev=613865&view=rev
Log:
HTTPCLIENT-667:
* Completed 'best match' cookie spec implementation
* Added test coverage
* Made the 'best match' cookie policy default
Added:
httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieBestMatchSpec.java (with props)
Modified:
httpcomponents/httpclient/trunk/RELEASE_NOTES.txt
httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/params/CookiePolicy.java
httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/params/HttpClientParams.java
httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/client/DefaultHttpClient.java
httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/cookie/BestMatchSpec.java
httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestAllCookieImpl.java
httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieRFC2109Spec.java
Modified: httpcomponents/httpclient/trunk/RELEASE_NOTES.txt
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/RELEASE_NOTES.txt?rev=613865&r1=613864&r2=613865&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/RELEASE_NOTES.txt (original)
+++ httpcomponents/httpclient/trunk/RELEASE_NOTES.txt Mon Jan 21 04:04:30 2008
@@ -1,6 +1,13 @@
Changes since 4.0 Alpha 2
-------------------
+* [HTTPCLIENT-667] Added 'Meta' cookie specification that selects a cookie policy
+ depending on the format of the cookie(s). It is no longer necessary to know
+ beforehand what kind of HTTP cookie support the target host provides.
+ HttpClient is now able to pick up either a lenient or a strict cookie policy
+ depending on the compliance level of the target server.
+ Contributed by Oleg Kalnichevski <olegk at apache.org>
+
* [HTTPCLIENT-729] Move HttpRoute and related classes to routing package.
Contributed by Roland Weber <rolandw at apache.org>
Modified: httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/params/CookiePolicy.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/params/CookiePolicy.java?rev=613865&r1=613864&r2=613865&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/params/CookiePolicy.java (original)
+++ httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/params/CookiePolicy.java Mon Jan 21 04:04:30 2008
@@ -54,6 +54,11 @@
*/
public static final String RFC_2965 = "rfc2965";
+ /**
+ * The default 'best match' policy.
+ */
+ public static final String BEST_MATCH = "best-match";
+
private CookiePolicy() {
super();
}
Modified: httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/params/HttpClientParams.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/params/HttpClientParams.java?rev=613865&r1=613864&r2=613865&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/params/HttpClientParams.java (original)
+++ httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/params/HttpClientParams.java Mon Jan 21 04:04:30 2008
@@ -145,7 +145,7 @@
String cookiePolicy = (String)
params.getParameter(ClientPNames.COOKIE_POLICY);
if (cookiePolicy == null) {
- return CookiePolicy.BROWSER_COMPATIBILITY;
+ return CookiePolicy.BEST_MATCH;
}
return cookiePolicy;
}
Modified: httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/client/DefaultHttpClient.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/client/DefaultHttpClient.java?rev=613865&r1=613864&r2=613865&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/client/DefaultHttpClient.java (original)
+++ httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/client/DefaultHttpClient.java Mon Jan 21 04:04:30 2008
@@ -61,6 +61,7 @@
import org.apache.http.impl.auth.DigestSchemeFactory;
import org.apache.http.impl.conn.DefaultHttpRoutePlanner;
import org.apache.http.impl.conn.SingleClientConnManager;
+import org.apache.http.impl.cookie.BestMatchSpecFactory;
import org.apache.http.impl.cookie.BrowserCompatSpecFactory;
import org.apache.http.impl.cookie.NetscapeDraftSpecFactory;
import org.apache.http.impl.cookie.RFC2109SpecFactory;
@@ -198,6 +199,9 @@
protected CookieSpecRegistry createCookieSpecRegistry() {
CookieSpecRegistry registry = new CookieSpecRegistry();
+ registry.register(
+ CookiePolicy.BEST_MATCH,
+ new BestMatchSpecFactory());
registry.register(
CookiePolicy.BROWSER_COMPATIBILITY,
new BrowserCompatSpecFactory());
Modified: httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/cookie/BestMatchSpec.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/cookie/BestMatchSpec.java?rev=613865&r1=613864&r2=613865&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/cookie/BestMatchSpec.java (original)
+++ httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/cookie/BestMatchSpec.java Mon Jan 21 04:04:30 2008
@@ -104,7 +104,7 @@
if (helem.getParameterByName("version") != null) {
versioned = true;
}
- if (helem.getParameterByName("expiry") != null) {
+ if (helem.getParameterByName("expires") != null) {
netscape = true;
}
}
@@ -158,9 +158,9 @@
if (cookies == null) {
throw new IllegalArgumentException("List of cookie may not be null");
}
- int version = 0;
+ int version = Integer.MAX_VALUE;
for (Cookie cookie: cookies) {
- if (cookie.getVersion() > version) {
+ if (cookie.getVersion() < version) {
version = cookie.getVersion();
}
}
Modified: httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestAllCookieImpl.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestAllCookieImpl.java?rev=613865&r1=613864&r2=613865&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestAllCookieImpl.java (original)
+++ httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestAllCookieImpl.java Mon Jan 21 04:04:30 2008
@@ -52,6 +52,7 @@
suite.addTest(TestCookieNetscapeDraft.suite());
suite.addTest(TestCookieRFC2109Spec.suite());
suite.addTest(TestCookieRFC2965Spec.suite());
+ suite.addTest(TestCookieBestMatchSpec.suite());
return suite;
}
Added: httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieBestMatchSpec.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieBestMatchSpec.java?rev=613865&view=auto
==============================================================================
--- httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieBestMatchSpec.java (added)
+++ httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieBestMatchSpec.java Mon Jan 21 04:04:30 2008
@@ -0,0 +1,256 @@
+/*
+ * $HeadURL:$
+ * $Revision:$
+ * $Date:$
+ * ====================================================================
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation. For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+
+package org.apache.http.impl.cookie;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import junit.framework.Test;
+import junit.framework.TestCase;
+import junit.framework.TestSuite;
+
+import org.apache.http.Header;
+import org.apache.http.cookie.ClientCookie;
+import org.apache.http.cookie.Cookie;
+import org.apache.http.cookie.CookieOrigin;
+import org.apache.http.cookie.CookieSpec;
+import org.apache.http.cookie.MalformedCookieException;
+import org.apache.http.message.BasicHeader;
+
+/**
+ * Test cases for 'best match' cookie policy
+ *
+ * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
+ *
+ * @version $Revision:$
+ */
+public class TestCookieBestMatchSpec extends TestCase {
+
+ // ------------------------------------------------------------ Constructor
+
+ public TestCookieBestMatchSpec(String name) {
+ super(name);
+ }
+
+ // ------------------------------------------------------- TestCase Methods
+
+ public static Test suite() {
+ return new TestSuite(TestCookieBestMatchSpec.class);
+ }
+
+ public void testCookieBrowserCompatParsing() throws Exception {
+ CookieSpec cookiespec = new BestMatchSpec();
+ CookieOrigin origin = new CookieOrigin("a.b.domain.com", 80, "/", false);
+
+ // Make sure the lenient (browser compatible) cookie parsing
+ // and validation is used for Netscape style cookies
+ Header header = new BasicHeader("Set-Cookie", "name=value;path=/;domain=domain.com");
+
+ List<Cookie> cookies = cookiespec.parse(header, origin);
+ for (int i = 0; i < cookies.size(); i++) {
+ cookiespec.validate(cookies.get(i), origin);
+ }
+ }
+
+ public void testNetscapeCookieParsing() throws Exception {
+ CookieSpec cookiespec = new BestMatchSpec();
+ CookieOrigin origin = new CookieOrigin("myhost.mydomain.com", 80, "/", false);
+
+ Header header = new BasicHeader("Set-Cookie",
+ "name=value; path=/; domain=.mydomain.com; expires=Thu, 01-Jan-2070 00:00:10 GMT; comment=no_comment");
+ List<Cookie> cookies = cookiespec.parse(header, origin);
+ cookiespec.validate(cookies.get(0), origin);
+
+ header = new BasicHeader("Set-Cookie",
+ "name=value; path=/; domain=.mydomain.com; expires=Thu, 01-Jan-2070 00:00:10 GMT; version=1");
+ try {
+ cookies = cookiespec.parse(header, origin);
+ cookiespec.validate(cookies.get(0), origin);
+ fail("MalformedCookieException exception should have been thrown");
+ } catch (MalformedCookieException e) {
+ // expected
+ }
+ }
+
+ public void testCookieStandardCompliantParsing() throws Exception {
+ CookieSpec cookiespec = new BestMatchSpec();
+ CookieOrigin origin = new CookieOrigin("a.b.domain.com", 80, "/", false);
+
+ // Make sure the strict (RFC2965) cookie parsing
+ // and validation is used for version 1 cookies
+ Header header = new BasicHeader("Set-Cookie", "name=value;path=/;domain=b.domain.com; version=1");
+
+ List<Cookie> cookies = cookiespec.parse(header, origin);
+ for (int i = 0; i < cookies.size(); i++) {
+ cookiespec.validate(cookies.get(i), origin);
+ }
+
+ header = new BasicHeader("Set-Cookie", "name=value;path=/;domain=domain.com; version=1");
+ try {
+ cookies = cookiespec.parse(header, origin);
+ cookiespec.validate(cookies.get(0), origin);
+ fail("MalformedCookieException exception should have been thrown");
+ } catch (MalformedCookieException e) {
+ // expected
+ }
+ }
+
+ public void testCookieBrowserCompatMatch() throws Exception {
+ CookieSpec cookiespec = new BestMatchSpec();
+ CookieOrigin origin = new CookieOrigin("a.b.domain.com", 80, "/", false);
+
+ // Make sure the lenient (browser compatible) cookie matching
+ // is used for Netscape style cookies
+ BasicClientCookie cookie = new BasicClientCookie("name", "value");
+ cookie.setDomain(".domain.com");
+ cookie.setAttribute(ClientCookie.DOMAIN_ATTR, cookie.getDomain());
+ cookie.setPath("/");
+ cookie.setAttribute(ClientCookie.PATH_ATTR, cookie.getPath());
+
+ assertTrue(cookiespec.match(cookie, origin));
+ }
+
+ public void testCookieStandardCompliantMatch() throws Exception {
+ CookieSpec cookiespec = new BestMatchSpec();
+ CookieOrigin origin = new CookieOrigin("a.b.domain.com", 80, "/", false);
+
+ // Make sure the strict (RFC2965) cookie matching
+ // is used for version 1 cookies
+ BasicClientCookie cookie = new BasicClientCookie("name", "value");
+ cookie.setVersion(1);
+ cookie.setDomain(".domain.com");
+ cookie.setAttribute(ClientCookie.DOMAIN_ATTR, cookie.getDomain());
+ cookie.setPath("/");
+ cookie.setAttribute(ClientCookie.PATH_ATTR, cookie.getPath());
+
+ assertFalse(cookiespec.match(cookie, origin));
+
+ cookie.setDomain(".b.domain.com");
+
+ assertTrue(cookiespec.match(cookie, origin));
+ }
+
+ public void testCookieBrowserCompatFormatting() throws Exception {
+ CookieSpec cookiespec = new BestMatchSpec();
+
+ // Make sure the lenient (browser compatible) cookie formatting
+ // is used for Netscape style cookies
+ BasicClientCookie cookie1 = new BasicClientCookie("name1", "value1");
+ cookie1.setDomain(".domain.com");
+ cookie1.setAttribute(ClientCookie.DOMAIN_ATTR, cookie1.getDomain());
+ cookie1.setPath("/");
+ cookie1.setAttribute(ClientCookie.PATH_ATTR, cookie1.getPath());
+
+ BasicClientCookie cookie2 = new BasicClientCookie("name2", "value2");
+ cookie2.setVersion(1);
+ cookie2.setDomain(".domain.com");
+ cookie2.setAttribute(ClientCookie.DOMAIN_ATTR, cookie2.getDomain());
+ cookie2.setPath("/");
+ cookie2.setAttribute(ClientCookie.PATH_ATTR, cookie2.getPath());
+
+ List<Cookie> cookies = new ArrayList<Cookie>();
+ cookies.add(cookie1);
+ cookies.add(cookie2);
+
+ List<Header> headers = cookiespec.formatCookies(cookies);
+ assertNotNull(headers);
+ assertEquals(1, headers.size());
+
+ Header header = headers.get(0);
+ assertEquals("name1=value1; name2=value2", header.getValue());
+
+ }
+
+ public void testCookieStandardCompliantFormatting() throws Exception {
+ CookieSpec cookiespec = new BestMatchSpec(null, true);
+
+ // Make sure the strict (RFC2965) cookie formatting
+ // is used for Netscape style cookies
+ BasicClientCookie cookie1 = new BasicClientCookie("name1", "value1");
+ cookie1.setVersion(1);
+ cookie1.setDomain(".domain.com");
+ cookie1.setAttribute(ClientCookie.DOMAIN_ATTR, cookie1.getDomain());
+ cookie1.setPath("/");
+ cookie1.setAttribute(ClientCookie.PATH_ATTR, cookie1.getPath());
+
+ BasicClientCookie cookie2 = new BasicClientCookie("name2", "value2");
+ cookie2.setVersion(1);
+ cookie2.setDomain(".domain.com");
+ cookie2.setAttribute(ClientCookie.DOMAIN_ATTR, cookie2.getDomain());
+ cookie2.setPath("/");
+ cookie2.setAttribute(ClientCookie.PATH_ATTR, cookie2.getPath());
+
+ List<Cookie> cookies = new ArrayList<Cookie>();
+ cookies.add(cookie1);
+ cookies.add(cookie2);
+
+ List<Header> headers = cookiespec.formatCookies(cookies);
+ assertNotNull(headers);
+ assertEquals(1, headers.size());
+
+ Header header = headers.get(0);
+ assertEquals("$Version=1; name1=\"value1\"; $Path=\"/\"; $Domain=\".domain.com\"; " +
+ "name2=\"value2\"; $Path=\"/\"; $Domain=\".domain.com\"",
+ header.getValue());
+
+ }
+
+ public void testInvalidInput() throws Exception {
+ CookieSpec cookiespec = new BestMatchSpec();
+ try {
+ cookiespec.parse(null, null);
+ fail("IllegalArgumentException must have been thrown");
+ } catch (IllegalArgumentException ex) {
+ // expected
+ }
+ try {
+ cookiespec.parse(new BasicHeader("Set-Cookie", "name=value"), null);
+ fail("IllegalArgumentException must have been thrown");
+ } catch (IllegalArgumentException ex) {
+ // expected
+ }
+ try {
+ cookiespec.formatCookies(null);
+ fail("IllegalArgumentException must have been thrown");
+ } catch (IllegalArgumentException ex) {
+ // expected
+ }
+ try {
+ List<Cookie> cookies = new ArrayList<Cookie>();
+ cookiespec.formatCookies(cookies);
+ fail("IllegalArgumentException must have been thrown");
+ } catch (IllegalArgumentException ex) {
+ // expected
+ }
+ }
+
+}
+
Propchange: httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieBestMatchSpec.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieBestMatchSpec.java
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieBestMatchSpec.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieRFC2109Spec.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieRFC2109Spec.java?rev=613865&r1=613864&r2=613865&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieRFC2109Spec.java (original)
+++ httpcomponents/httpclient/trunk/module-client/src/test/java/org/apache/http/impl/cookie/TestCookieRFC2109Spec.java Mon Jan 21 04:04:30 2008
@@ -92,7 +92,7 @@
/**
* Test domain equals host
*/
- public void testcookiesomainEqualsHost() throws Exception {
+ public void testCookiesomainEqualsHost() throws Exception {
Header header = new BasicHeader("Set-Cookie",
"cookie-name=cookie-value; domain=www.b.com; version=1");