Fixes #9288 - Jetty 12 - Use oej.http.HttpCookie in jetty-client.

* Replaced usages of java.net.HttpCookie with oej.http.HttpCookie. * Moved server-side only methods from HttpCookie to HttpCookieUtils. * Introduced and implemented oej.http.HttpCookieStore. * Removed now obsolete oej.util.HttpCookieStore. Signed-off-by: Simone Bordet <[email protected]>
jetty · Feb 4, 2023 · 82f6383 · 82f6383
1 parent 9916706
commit 82f6383
Show file tree

Hide file tree

Showing 35 changed files with 1,956 additions and 812 deletions.
diff --git a/...entation/src/main/java/org/eclipse/jetty/docs/programming/client/http/HTTPClientDocs.java b/...entation/src/main/java/org/eclipse/jetty/docs/programming/client/http/HTTPClientDocs.java
@@ -17,8 +17,6 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
-import java.net.CookieStore;
-import java.net.HttpCookie;
 import java.net.URI;
 import java.nio.ByteBuffer;
 import java.nio.file.Path;
@@ -54,6 +52,8 @@
 import org.eclipse.jetty.client.transport.HttpClientTransportDynamic;
 import org.eclipse.jetty.client.transport.HttpClientTransportOverHTTP;
 import org.eclipse.jetty.fcgi.client.transport.HttpClientTransportOverFCGI;
+import org.eclipse.jetty.http.HttpCookie;
+import org.eclipse.jetty.http.HttpCookieStore;
 import org.eclipse.jetty.http.HttpHeader;
 import org.eclipse.jetty.http.HttpMethod;
 import org.eclipse.jetty.http.HttpStatus;
@@ -67,7 +67,6 @@
 import org.eclipse.jetty.io.ClientConnector;
 import org.eclipse.jetty.io.Content;
 import org.eclipse.jetty.util.Callback;
-import org.eclipse.jetty.util.HttpCookieStore;
 import org.eclipse.jetty.util.component.LifeCycle;
 import org.eclipse.jetty.util.ssl.SslContextFactory;
 
@@ -541,8 +540,8 @@ public void getCookies() throws Exception
         httpClient.start();
 
         // tag::getCookies[]
-        CookieStore cookieStore = httpClient.getCookieStore();
-        List<HttpCookie> cookies = cookieStore.get(URI.create("http://domain.com/path"));
+        HttpCookieStore cookieStore = httpClient.getHttpCookieStore();
+        List<HttpCookie> cookies = cookieStore.match(URI.create("http://domain.com/path"));
         // end::getCookies[]
     }
 
@@ -552,11 +551,12 @@ public void setCookie() throws Exception
         httpClient.start();
 
         // tag::setCookie[]
-        CookieStore cookieStore = httpClient.getCookieStore();
-        HttpCookie cookie = new HttpCookie("foo", "bar");
-        cookie.setDomain("domain.com");
-        cookie.setPath("/");
-        cookie.setMaxAge(TimeUnit.DAYS.toSeconds(1));
+        HttpCookieStore cookieStore = httpClient.getHttpCookieStore();
+        HttpCookie cookie = HttpCookie.build("foo", "bar")
+            .domain("domain.com")
+            .path("/")
+            .maxAge(TimeUnit.DAYS.toSeconds(1))
+            .build();
         cookieStore.add(URI.create("http://domain.com"), cookie);
         // end::setCookie[]
     }
@@ -568,7 +568,7 @@ public void requestCookie() throws Exception
 
         // tag::requestCookie[]
         ContentResponse response = httpClient.newRequest("http://domain.com/path")
-            .cookie(new HttpCookie("foo", "bar"))
+            .cookie(HttpCookie.from("foo", "bar"))
             .send();
         // end::requestCookie[]
     }
@@ -579,9 +579,9 @@ public void removeCookie() throws Exception
         httpClient.start();
 
         // tag::removeCookie[]
-        CookieStore cookieStore = httpClient.getCookieStore();
+        HttpCookieStore cookieStore = httpClient.getHttpCookieStore();
         URI uri = URI.create("http://domain.com");
-        List<HttpCookie> cookies = cookieStore.get(uri);
+        List<HttpCookie> cookies = cookieStore.match(uri);
         for (HttpCookie cookie : cookies)
         {
             cookieStore.remove(uri, cookie);
@@ -595,7 +595,7 @@ public void emptyCookieStore() throws Exception
         httpClient.start();
 
         // tag::emptyCookieStore[]
-        httpClient.setCookieStore(new HttpCookieStore.Empty());
+        httpClient.setHttpCookieStore(new HttpCookieStore.Empty());
         // end::emptyCookieStore[]
     }
 
@@ -605,17 +605,18 @@ public void filteringCookieStore() throws Exception
         httpClient.start();
 
         // tag::filteringCookieStore[]
-        class GoogleOnlyCookieStore extends HttpCookieStore
+        class GoogleOnlyCookieStore extends HttpCookieStore.Default
         {
             @Override
-            public void add(URI uri, HttpCookie cookie)
+            public boolean add(URI uri, HttpCookie cookie)
             {
                 if (uri.getHost().endsWith("google.com"))
-                    super.add(uri, cookie);
+                    return super.add(uri, cookie);
+                return false;
             }
         }
 
-        httpClient.setCookieStore(new GoogleOnlyCookieStore());
+        httpClient.setHttpCookieStore(new GoogleOnlyCookieStore());
         // end::filteringCookieStore[]
     }
 

diff --git a/jetty-core/jetty-client/src/main/java/org/eclipse/jetty/client/HttpClient.java b/jetty-core/jetty-client/src/main/java/org/eclipse/jetty/client/HttpClient.java
@@ -43,6 +43,8 @@
 import org.eclipse.jetty.client.transport.HttpDestination;
 import org.eclipse.jetty.client.transport.HttpRequest;
 import org.eclipse.jetty.http.HttpCompliance;
+import org.eclipse.jetty.http.HttpCookie;
+import org.eclipse.jetty.http.HttpCookieStore;
 import org.eclipse.jetty.http.HttpField;
 import org.eclipse.jetty.http.HttpHeader;
 import org.eclipse.jetty.http.HttpMethod;
@@ -81,7 +83,7 @@
  * and HTTP parameters (such as whether to follow redirects).</p>
  * <p>HttpClient transparently pools connections to servers, but allows direct control of connections
  * for cases where this is needed.</p>
- * <p>HttpClient also acts as a central configuration point for cookies, via {@link #getCookieStore()}.</p>
+ * <p>HttpClient also acts as a central configuration point for cookies, via {@link #getHttpCookieStore()}.</p>
  * <p>Typical usage:</p>
  * <pre>
  * HttpClient httpClient = new HttpClient();
@@ -121,8 +123,8 @@ public class HttpClient extends ContainerLifeCycle
     private final HttpClientTransport transport;
     private final ClientConnector connector;
     private AuthenticationStore authenticationStore = new HttpAuthenticationStore();
-    private CookieManager cookieManager;
-    private CookieStore cookieStore;
+    private HttpCookieStore cookieStore;
+    private HttpCookieParser cookieParser;
     private SocketAddressResolver resolver;
     private HttpField agentField = new HttpField(HttpHeader.USER_AGENT, USER_AGENT);
     private boolean followRedirects = true;
@@ -222,8 +224,9 @@ protected void doStart() throws Exception
 
         decoderFactories.put(new GZIPContentDecoder.Factory(retainableByteBufferPool));
 
-        cookieManager = newCookieManager();
-        cookieStore = cookieManager.getCookieStore();
+        if (cookieStore == null)
+            cookieStore = new HttpCookieStore.Default();
+        cookieParser = new HttpCookieParser();
 
         transport.setHttpClient(this);
 
@@ -236,11 +239,6 @@ protected void doStart() throws Exception
         }
     }
 
-    private CookieManager newCookieManager()
-    {
-        return new CookieManager(getCookieStore(), CookiePolicy.ACCEPT_ALL);
-    }
-
     @Override
     protected void doStop() throws Exception
     {
@@ -274,20 +272,19 @@ public List<Request.Listener> getRequestListeners()
     /**
      * @return the cookie store associated with this instance
      */
-    public CookieStore getCookieStore()
+    public HttpCookieStore getHttpCookieStore()
     {
         return cookieStore;
     }
 
     /**
      * @param cookieStore the cookie store associated with this instance
      */
-    public void setCookieStore(CookieStore cookieStore)
+    public void setHttpCookieStore(HttpCookieStore cookieStore)
     {
         if (isStarted())
             throw new IllegalStateException();
         this.cookieStore = Objects.requireNonNull(cookieStore);
-        this.cookieManager = newCookieManager();
     }
 
     public void putCookie(URI uri, HttpField field)
@@ -297,9 +294,8 @@ public void putCookie(URI uri, HttpField field)
             String value = field.getValue();
             if (value != null)
             {
-                Map<String, List<String>> header = new HashMap<>(1);
-                header.put(field.getHeader().asString(), List.of(value));
-                cookieManager.put(uri, header);
+                HttpCookie cookie = cookieParser.parse(uri, field);
+                cookieStore.add(uri, cookie);
             }
         }
         catch (IOException x)
@@ -1154,4 +1150,66 @@ public ClientConnectionFactory newSslClientConnectionFactory(SslContextFactory.C
             sslContextFactory = getSslContextFactory();
         return new SslClientConnectionFactory(sslContextFactory, getRetainableByteBufferPool(), getExecutor(), connectionFactory);
     }
+
+    private static class HttpCookieParser extends CookieManager
+    {
+        public HttpCookieParser()
+        {
+            super(new Store(), CookiePolicy.ACCEPT_ALL);
+        }
+
+        public HttpCookie parse(URI uri, HttpField field) throws IOException
+        {
+            // TODO: hacky implementation waiting for a real HttpCookie parser.
+            String value = field.getValue();
+            if (value == null)
+                return null;
+            Map<String, List<String>> header = new HashMap<>(1);
+            header.put(field.getHeader().asString(), List.of(value));
+            put(uri, header);
+            Store store = (Store)getCookieStore();
+            return store.cookie;
+        }
+
+        private static class Store implements CookieStore
+        {
+            private HttpCookie cookie;
+
+            @Override
+            public void add(URI uri, java.net.HttpCookie cookie)
+            {
+                this.cookie = HttpCookie.from(cookie);
+            }
+
+            @Override
+            public List<java.net.HttpCookie> get(URI uri)
+            {
+                throw new UnsupportedOperationException();
+            }
+
+            @Override
+            public List<java.net.HttpCookie> getCookies()
+            {
+                throw new UnsupportedOperationException();
+            }
+
+            @Override
+            public List<URI> getURIs()
+            {
+                throw new UnsupportedOperationException();
+            }
+
+            @Override
+            public boolean remove(URI uri, java.net.HttpCookie cookie)
+            {
+                throw new UnsupportedOperationException();
+            }
+
+            @Override
+            public boolean removeAll()
+            {
+                throw new UnsupportedOperationException();
+            }
+        }
+    }
 }
diff --git a/jetty-core/jetty-client/src/main/java/org/eclipse/jetty/client/Request.java b/jetty-core/jetty-client/src/main/java/org/eclipse/jetty/client/Request.java
@@ -14,7 +14,6 @@
 package org.eclipse.jetty.client;
 
 import java.io.IOException;
-import java.net.HttpCookie;
 import java.net.URI;
 import java.net.URLEncoder;
 import java.nio.ByteBuffer;
@@ -30,6 +29,7 @@
 import java.util.function.Consumer;
 import java.util.function.Supplier;
 
+import org.eclipse.jetty.http.HttpCookie;
 import org.eclipse.jetty.http.HttpFields;
 import org.eclipse.jetty.http.HttpMethod;
 import org.eclipse.jetty.http.HttpVersion;

diff --git a/jetty-core/jetty-client/src/main/java/org/eclipse/jetty/client/transport/HttpConnection.java b/jetty-core/jetty-client/src/main/java/org/eclipse/jetty/client/transport/HttpConnection.java
@@ -13,8 +13,6 @@
 
 package org.eclipse.jetty.client.transport;
 
-import java.net.CookieStore;
-import java.net.HttpCookie;
 import java.net.URI;
 import java.util.ArrayList;
 import java.util.Iterator;
@@ -30,13 +28,14 @@
 import org.eclipse.jetty.client.ProxyConfiguration;
 import org.eclipse.jetty.client.Request;
 import org.eclipse.jetty.client.Response;
+import org.eclipse.jetty.http.HttpCookie;
+import org.eclipse.jetty.http.HttpCookieStore;
 import org.eclipse.jetty.http.HttpField;
 import org.eclipse.jetty.http.HttpFields;
 import org.eclipse.jetty.http.HttpHeader;
 import org.eclipse.jetty.http.HttpVersion;
 import org.eclipse.jetty.io.CyclicTimeouts;
 import org.eclipse.jetty.util.Attachable;
-import org.eclipse.jetty.util.HttpCookieStore;
 import org.eclipse.jetty.util.NanoTime;
 import org.eclipse.jetty.util.thread.AutoLock;
 import org.eclipse.jetty.util.thread.Scheduler;
@@ -210,12 +209,12 @@ protected void normalizeRequest(HttpRequest request)
 
         // Cookies
         StringBuilder cookies = convertCookies(request.getCookies(), null);
-        CookieStore cookieStore = getHttpClient().getCookieStore();
+        HttpCookieStore cookieStore = getHttpClient().getHttpCookieStore();
         if (cookieStore != null && cookieStore.getClass() != HttpCookieStore.Empty.class)
         {
             URI uri = request.getURI();
             if (uri != null)
-                cookies = convertCookies(HttpCookieStore.matchPath(uri, cookieStore.get(uri)), cookies);
+                cookies = convertCookies(cookieStore.match(uri), cookies);
         }
         if (cookies != null)
         {

diff --git a/jetty-core/jetty-client/src/main/java/org/eclipse/jetty/client/transport/HttpRequest.java b/jetty-core/jetty-client/src/main/java/org/eclipse/jetty/client/transport/HttpRequest.java
@@ -14,7 +14,6 @@
 package org.eclipse.jetty.client.transport;
 
 import java.io.IOException;
-import java.net.HttpCookie;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URLDecoder;
@@ -48,6 +47,7 @@
 import org.eclipse.jetty.client.Request;
 import org.eclipse.jetty.client.Response;
 import org.eclipse.jetty.client.Result;
+import org.eclipse.jetty.http.HttpCookie;
 import org.eclipse.jetty.http.HttpField;
 import org.eclipse.jetty.http.HttpFields;
 import org.eclipse.jetty.http.HttpHeader;

diff --git a/jetty-core/jetty-client/src/test/java/org/eclipse/jetty/client/HttpClientTest.java b/jetty-core/jetty-client/src/test/java/org/eclipse/jetty/client/HttpClientTest.java
@@ -17,7 +17,6 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
-import java.net.HttpCookie;
 import java.net.InetSocketAddress;
 import java.net.ServerSocket;
 import java.net.Socket;
@@ -48,6 +47,7 @@
 import org.eclipse.jetty.client.transport.HttpRequest;
 import org.eclipse.jetty.client.transport.internal.HttpConnectionOverHTTP;
 import org.eclipse.jetty.http.BadMessageException;
+import org.eclipse.jetty.http.HttpCookie;
 import org.eclipse.jetty.http.HttpField;
 import org.eclipse.jetty.http.HttpHeader;
 import org.eclipse.jetty.http.HttpHeaderValue;
@@ -122,7 +122,7 @@ public void testStoppingClosesConnections(Scenario scenario) throws Exception
 
         Origin origin = destination.getOrigin();
         String uri = origin.getScheme() + "://" + origin.getAddress();
-        client.getCookieStore().add(URI.create(uri), new HttpCookie("foo", "bar"));
+        client.getHttpCookieStore().add(URI.create(uri), HttpCookie.from("foo", "bar"));
 
         client.stop();