Refactor to use a new class CompletingFutureContribution (#484)

garydgregory · ok2c · commit ba711d780293 · 2024-09-24T12:10:44.000+02:00
- Reduces boilerplate when the same pattern is used
diff --git a/httpcore5-h2/src/main/java/org/apache/hc/core5/http2/impl/nio/bootstrap/H2MultiplexingRequester.java b/httpcore5-h2/src/main/java/org/apache/hc/core5/http2/impl/nio/bootstrap/H2MultiplexingRequester.java
@@ -37,9 +37,9 @@
 import org.apache.hc.core5.annotation.Internal;
 import org.apache.hc.core5.concurrent.Cancellable;
 import org.apache.hc.core5.concurrent.CancellableDependency;
+import org.apache.hc.core5.concurrent.CompletingFutureContribution;
 import org.apache.hc.core5.concurrent.ComplexFuture;
 import org.apache.hc.core5.concurrent.FutureCallback;
-import org.apache.hc.core5.concurrent.FutureContribution;
 import org.apache.hc.core5.function.Callback;
 import org.apache.hc.core5.function.Decorator;
 import org.apache.hc.core5.function.Resolver;
@@ -282,14 +282,7 @@ public final <T> Future<T> execute(
         final AsyncClientExchangeHandler exchangeHandler = new BasicClientExchangeHandler<>(
                 requestProducer,
                 responseConsumer,
-                new FutureContribution<T>(future) {
-
-                    @Override
-                    public void completed(final T result) {
-                        future.completed(result);
-                    }
-
-                });
+                new CompletingFutureContribution<T, T>(future));
         execute(target, exchangeHandler, pushHandlerFactory, future, timeout, context != null ? context : HttpCoreContext.create());
         return future;
     }
diff --git a/httpcore5-testing/src/main/java/org/apache/hc/core5/testing/nio/ClientSessionEndpoint.java b/httpcore5-testing/src/main/java/org/apache/hc/core5/testing/nio/ClientSessionEndpoint.java
@@ -34,8 +34,8 @@
 import org.apache.hc.core5.annotation.Contract;
 import org.apache.hc.core5.annotation.ThreadingBehavior;
 import org.apache.hc.core5.concurrent.BasicFuture;
+import org.apache.hc.core5.concurrent.CompletingFutureContribution;
 import org.apache.hc.core5.concurrent.FutureCallback;
-import org.apache.hc.core5.concurrent.FutureContribution;
 import org.apache.hc.core5.http.ConnectionClosedException;
 import org.apache.hc.core5.http.nio.AsyncClientExchangeHandler;
 import org.apache.hc.core5.http.nio.AsyncPushConsumer;
@@ -103,14 +103,7 @@ public <T> Future<T> execute(
         Asserts.check(!closed.get(), "Connection is already closed");
         final BasicFuture<T> future = new BasicFuture<>(callback);
         execute(new BasicClientExchangeHandler<>(requestProducer, responseConsumer,
-                new FutureContribution<T>(future) {
-
-                    @Override
-                    public void completed(final T result) {
-                        future.completed(result);
-                    }
-
-                }),
+                new CompletingFutureContribution<T, T>(future)),
                 pushHandlerFactory, context);
         return future;
     }
diff --git a/httpcore5-testing/src/main/java/org/apache/hc/core5/testing/nio/H2TestClient.java b/httpcore5-testing/src/main/java/org/apache/hc/core5/testing/nio/H2TestClient.java
@@ -35,8 +35,8 @@
 import javax.net.ssl.SSLContext;
 
 import org.apache.hc.core5.concurrent.BasicFuture;
+import org.apache.hc.core5.concurrent.CompletingFutureContribution;
 import org.apache.hc.core5.concurrent.FutureCallback;
-import org.apache.hc.core5.concurrent.FutureContribution;
 import org.apache.hc.core5.function.Supplier;
 import org.apache.hc.core5.http.HttpHost;
 import org.apache.hc.core5.http.config.CharCodingConfig;
@@ -53,7 +53,6 @@
 import org.apache.hc.core5.reactor.IOEventHandlerFactory;
 import org.apache.hc.core5.reactor.IOReactorConfig;
 import org.apache.hc.core5.reactor.IOReactorStatus;
-import org.apache.hc.core5.reactor.IOSession;
 import org.apache.hc.core5.reactor.ssl.SSLSessionInitializer;
 import org.apache.hc.core5.reactor.ssl.SSLSessionVerifier;
 import org.apache.hc.core5.util.Args;
@@ -209,14 +208,7 @@ public Future<ClientSessionEndpoint> connect(
             final Timeout timeout,
             final FutureCallback<ClientSessionEndpoint> callback) {
         final BasicFuture<ClientSessionEndpoint> future = new BasicFuture<>(callback);
-        requestSession(host, timeout, new FutureContribution<IOSession>(future) {
-
-            @Override
-            public void completed(final IOSession session) {
-                future.completed(new ClientSessionEndpoint(session));
-            }
-
-        });
+        requestSession(host, timeout, new CompletingFutureContribution<>(future, ClientSessionEndpoint::new));
         return future;
     }
 
diff --git a/httpcore5-testing/src/main/java/org/apache/hc/core5/testing/nio/Http1TestClient.java b/httpcore5-testing/src/main/java/org/apache/hc/core5/testing/nio/Http1TestClient.java
@@ -33,8 +33,8 @@
 import javax.net.ssl.SSLContext;
 
 import org.apache.hc.core5.concurrent.BasicFuture;
+import org.apache.hc.core5.concurrent.CompletingFutureContribution;
 import org.apache.hc.core5.concurrent.FutureCallback;
-import org.apache.hc.core5.concurrent.FutureContribution;
 import org.apache.hc.core5.http.HttpHost;
 import org.apache.hc.core5.http.config.CharCodingConfig;
 import org.apache.hc.core5.http.config.Http1Config;
@@ -43,7 +43,6 @@
 import org.apache.hc.core5.http.protocol.HttpProcessor;
 import org.apache.hc.core5.reactor.IOReactorConfig;
 import org.apache.hc.core5.reactor.IOReactorStatus;
-import org.apache.hc.core5.reactor.IOSession;
 import org.apache.hc.core5.reactor.ssl.SSLSessionInitializer;
 import org.apache.hc.core5.reactor.ssl.SSLSessionVerifier;
 import org.apache.hc.core5.util.Asserts;
@@ -129,14 +128,7 @@ public Future<ClientSessionEndpoint> connect(
             final Timeout timeout,
             final FutureCallback<ClientSessionEndpoint> callback) {
         final BasicFuture<ClientSessionEndpoint> future = new BasicFuture<>(callback);
-        requestSession(host, timeout, new FutureContribution<IOSession>(future) {
-
-            @Override
-            public void completed(final IOSession session) {
-                future.completed(new ClientSessionEndpoint(session));
-            }
-
-        });
+        requestSession(host, timeout, new CompletingFutureContribution<>(future, ClientSessionEndpoint::new));
         return future;
     }
 
diff --git a/httpcore5-testing/src/test/java/org/apache/hc/core5/testing/nio/TLSIntegrationTest.java b/httpcore5-testing/src/test/java/org/apache/hc/core5/testing/nio/TLSIntegrationTest.java
@@ -40,6 +40,7 @@
 import javax.net.ssl.SSLSession;
 
 import org.apache.hc.core5.concurrent.BasicFuture;
+import org.apache.hc.core5.concurrent.CompletingFutureContribution;
 import org.apache.hc.core5.concurrent.FutureCallback;
 import org.apache.hc.core5.concurrent.FutureContribution;
 import org.apache.hc.core5.function.Supplier;
@@ -185,14 +186,7 @@ public void completed(final AsyncClientEndpoint clientEndpoint) {
                         try {
                             ((TlsUpgradeCapable) clientEndpoint).tlsUpgrade(
                                     target,
-                                    new FutureContribution<ProtocolIOSession>(tlsFuture) {
-
-                                        @Override
-                                        public void completed(final ProtocolIOSession protocolIOSession) {
-                                            tlsFuture.completed(protocolIOSession.getTlsDetails());
-                                        }
-
-                                    });
+                                    new CompletingFutureContribution<>(tlsFuture, ProtocolIOSession::getTlsDetails));
                         } catch (final Exception ex) {
                             tlsFuture.failed(ex);
                         }
diff --git a/httpcore5-testing/src/test/java/org/apache/hc/core5/testing/nio/TLSUpgradeTest.java b/httpcore5-testing/src/test/java/org/apache/hc/core5/testing/nio/TLSUpgradeTest.java
@@ -33,7 +33,7 @@
 import java.util.concurrent.Future;
 
 import org.apache.hc.core5.concurrent.BasicFuture;
-import org.apache.hc.core5.concurrent.FutureContribution;
+import org.apache.hc.core5.concurrent.CompletingFutureContribution;
 import org.apache.hc.core5.function.Supplier;
 import org.apache.hc.core5.http.ContentType;
 import org.apache.hc.core5.http.HttpHost;
@@ -120,14 +120,7 @@ void testTLSUpgrade() throws Exception {
 
         // Upgrade to TLS
         final BasicFuture<TlsDetails> tlsFuture = new BasicFuture<>(null);
-        ((TlsUpgradeCapable) clientEndpoint).tlsUpgrade(target, new FutureContribution<ProtocolIOSession>(tlsFuture) {
-
-            @Override
-            public void completed(final ProtocolIOSession protocolIOSession) {
-                tlsFuture.completed(protocolIOSession.getTlsDetails());
-            }
-
-        });
+        ((TlsUpgradeCapable) clientEndpoint).tlsUpgrade(target, new CompletingFutureContribution<>(tlsFuture, ProtocolIOSession::getTlsDetails));
 
         final TlsDetails tlsDetails = tlsFuture.get(TIMEOUT.getDuration(), TIMEOUT.getTimeUnit());
         Assertions.assertNotNull(tlsDetails);
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/concurrent/CompletingFutureContribution.java b/httpcore5/src/main/java/org/apache/hc/core5/concurrent/CompletingFutureContribution.java
@@ -0,0 +1,70 @@
+/*
+ * ====================================================================
+ * 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.hc.core5.concurrent;
+
+import java.util.Objects;
+import java.util.function.Function;
+
+/**
+ * Completes a result on a {@link BasicFuture}.
+ *
+ * @param <T> the future result type of an asynchronous operation for this type.
+ * @param <U> the future result type of an asynchronous operation for the {@link FutureCallback}.
+ * @since 5.5
+ */
+public class CompletingFutureContribution<T, U> extends FutureContribution<T> {
+
+    private final Function<T, U> resultProvider;
+
+    /**
+     * Constructs a new instance to callback the given {@link BasicFuture}.
+     *
+     * @param future The callback.
+     */
+    @SuppressWarnings("unchecked")
+    public CompletingFutureContribution(final BasicFuture<U> future) {
+        this(future, (Function<T, U>) Function.identity());
+    }
+
+    /**
+     * Constructs a new instance to callback the given {@link BasicFuture}.
+     *
+     * @param future The callback.
+     * @param resultProvider Provides the result to complete the future.
+     */
+    public CompletingFutureContribution(final BasicFuture<U> future, final Function<T, U> resultProvider) {
+        super(future);
+        this.resultProvider = Objects.requireNonNull(resultProvider, "resultProvider");
+    }
+
+    @Override
+    public void completed(final T result) {
+        getFuture().completed(resultProvider.apply(result));
+    }
+
+}
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/concurrent/FutureContribution.java b/httpcore5/src/main/java/org/apache/hc/core5/concurrent/FutureContribution.java
@@ -30,7 +30,7 @@
  * Convenience base class for {@link FutureCallback}s that contribute a result
  * of the operation to another {@link BasicFuture}.
  *
- * @param <T> the future result type of an asynchronous operation.
+ * @param <T> the future result type of an asynchronous operation for this type.
  * @since 5.1
  */
 public abstract class FutureContribution<T> implements FutureCallback<T> {
@@ -60,4 +60,9 @@ public final void cancelled() {
         }
     }
 
+    @SuppressWarnings("unchecked")
+    <R> BasicFuture<R> getFuture() {
+        return (BasicFuture<R>) future;
+    }
+
 }
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/impl/bootstrap/HttpAsyncRequester.java b/httpcore5/src/main/java/org/apache/hc/core5/http/impl/bootstrap/HttpAsyncRequester.java
@@ -37,9 +37,9 @@
 import org.apache.hc.core5.annotation.Internal;
 import org.apache.hc.core5.concurrent.BasicFuture;
 import org.apache.hc.core5.concurrent.CallbackContribution;
+import org.apache.hc.core5.concurrent.CompletingFutureContribution;
 import org.apache.hc.core5.concurrent.ComplexFuture;
 import org.apache.hc.core5.concurrent.FutureCallback;
-import org.apache.hc.core5.concurrent.FutureContribution;
 import org.apache.hc.core5.function.Callback;
 import org.apache.hc.core5.function.Decorator;
 import org.apache.hc.core5.http.ConnectionClosedException;
@@ -417,14 +417,7 @@ public final <T> Future<T> execute(
         final AsyncClientExchangeHandler exchangeHandler = new BasicClientExchangeHandler<>(
                 requestProducer,
                 responseConsumer,
-                new FutureContribution<T>(future) {
-
-                    @Override
-                    public void completed(final T result) {
-                        future.completed(result);
-                    }
-
-                });
+                new CompletingFutureContribution<T, T>(future));
         execute(target, exchangeHandler, pushHandlerFactory, timeout, context != null ? context : HttpCoreContext.create());
         return future;
     }
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/http/nio/AsyncClientEndpoint.java b/httpcore5/src/main/java/org/apache/hc/core5/http/nio/AsyncClientEndpoint.java
@@ -32,8 +32,8 @@
 import org.apache.hc.core5.annotation.Contract;
 import org.apache.hc.core5.annotation.ThreadingBehavior;
 import org.apache.hc.core5.concurrent.BasicFuture;
+import org.apache.hc.core5.concurrent.CompletingFutureContribution;
 import org.apache.hc.core5.concurrent.FutureCallback;
-import org.apache.hc.core5.concurrent.FutureContribution;
 import org.apache.hc.core5.http.nio.support.BasicClientExchangeHandler;
 import org.apache.hc.core5.http.protocol.HttpContext;
 import org.apache.hc.core5.http.protocol.HttpCoreContext;
@@ -101,14 +101,7 @@ public final <T> Future<T> execute(
             final FutureCallback<T> callback) {
         final BasicFuture<T> future = new BasicFuture<>(callback);
         execute(new BasicClientExchangeHandler<>(requestProducer, responseConsumer,
-                        new FutureContribution<T>(future) {
-
-                            @Override
-                            public void completed(final T result) {
-                                future.completed(result);
-                            }
-
-                        }),
+                        new CompletingFutureContribution<T, T>(future)),
                 pushHandlerFactory, context != null ? context : HttpCoreContext.create());
         return future;
     }
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/reactor/AbstractIOSessionPool.java b/httpcore5/src/main/java/org/apache/hc/core5/reactor/AbstractIOSessionPool.java
@@ -38,9 +38,9 @@
 
 import org.apache.hc.core5.annotation.Contract;
 import org.apache.hc.core5.annotation.ThreadingBehavior;
+import org.apache.hc.core5.concurrent.CompletingFutureContribution;
 import org.apache.hc.core5.concurrent.ComplexFuture;
 import org.apache.hc.core5.concurrent.FutureCallback;
-import org.apache.hc.core5.concurrent.FutureContribution;
 import org.apache.hc.core5.function.Callback;
 import org.apache.hc.core5.http.ConnectionClosedException;
 import org.apache.hc.core5.io.CloseMode;
@@ -145,14 +145,7 @@ public void completed(final IOSession ioSession) {
                         future.completed(ioSession);
                     } else {
                         getSessionInternal(poolEntry, true, endpoint, connectTimeout,
-                            new FutureContribution<IOSession>(future) {
-
-                            @Override
-                            public void completed(final IOSession ioSession1) {
-                                future.completed(ioSession1);
-                            }
-
-                        });
+                            new CompletingFutureContribution<>(future));
                     }
                 });
             }
diff --git a/httpcore5/src/main/java/org/apache/hc/core5/reactor/ProtocolIOSession.java b/httpcore5/src/main/java/org/apache/hc/core5/reactor/ProtocolIOSession.java
@@ -40,6 +40,7 @@ public interface ProtocolIOSession extends IOSession, TransportSecurityLayer {
 
     /**
      * Switches this I/O session to the application protocol with the given ID.
+     *
      * @param protocolId the application protocol ID
      * @param callback the result callback
      * @throws UnsupportedOperationException if application protocol switch
@@ -52,10 +53,8 @@ default void switchProtocol(String protocolId, FutureCallback<ProtocolIOSession>
     /**
      * Registers protocol upgrade handler with the given application protocol ID.
      *
-     * @since 5.2
      * @param protocolId the application protocol ID
      * @param upgradeHandler the upgrade handler.
-     *
      * @since 5.2
      */
     default void registerProtocol(String protocolId, ProtocolUpgradeHandler upgradeHandler) {

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`* Convenience base class for {@link FutureCallback}s that contribute a result`
`31`	`31`	`* of the operation to another {@link BasicFuture}.`
`32`	`32`	`*`
`33`		`- * @param <T> the future result type of an asynchronous operation.`
	`33`	`+ * @param <T> the future result type of an asynchronous operation for this type.`
`34`	`34`	`* @since 5.1`
`35`	`35`	`*/`
`36`	`36`	`public abstract class FutureContribution<T> implements FutureCallback<T> {`
`@@ -60,4 +60,9 @@ public final void cancelled() {`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`
	`63`	`+ @SuppressWarnings("unchecked")`
	`64`	`+ <R> BasicFuture<R> getFuture() {`
	`65`	`+ return (BasicFuture<R>) future;`
	`66`	`+ }`
	`67`	`+`
`63`	`68`	`}`