Merge pull request #267 from art-community/feature/keep-alive-policy-soap

mizantrop2397 · web-flow · commit bb80519cf858 · 2020-04-02T04:16:33.000+03:00
add keep alive policy for SOAP Communicator
diff --git a/application-http-client/src/main/java/ru/art/http/client/communicator/HttpCommunicationConfiguration.java b/application-http-client/src/main/java/ru/art/http/client/communicator/HttpCommunicationConfiguration.java
@@ -26,16 +26,14 @@
 import ru.art.entity.Value;
 import ru.art.entity.interceptor.*;
 import ru.art.entity.mapper.*;
-import ru.art.http.client.constants.*;
 import ru.art.http.client.constants.HttpClientModuleConstants.*;
 import ru.art.http.client.handler.*;
 import ru.art.http.client.interceptor.*;
 import ru.art.http.constants.*;
 import static lombok.AccessLevel.*;
 import static ru.art.core.context.Context.*;
 import static ru.art.core.factory.CollectionsFactory.*;
-import static ru.art.http.client.constants.HttpClientModuleConstants.HttpClientKeepAliveHeaderStrategy.CONSIDER;
-import static ru.art.http.client.constants.HttpClientModuleConstants.HttpClientKeepAliveHeaderStrategy.IGNORE;
+import static ru.art.http.client.constants.HttpClientModuleConstants.ConnectionClosingPolicy.CLOSE_AFTER_RESPONSE;
 import static ru.art.http.client.module.HttpClientModule.*;
 import static ru.art.http.constants.HttpMethodType.*;
 import java.nio.charset.*;
@@ -58,7 +56,7 @@ class HttpCommunicationConfiguration {
     private HttpCommunicationCancellationHandler<?> cancellationHandler;
     private boolean chunkedBody;
     private boolean gzipCompressedBody;
-    private HttpClientKeepAliveHeaderStrategy keepAliveResponseHeaderStrategy = IGNORE;
+    private ConnectionClosingPolicy connectionClosingPolicy = CLOSE_AFTER_RESPONSE;
     private RequestConfig requestConfig = httpClientModule().getRequestConfig();
     private HttpVersion httpProtocolVersion = httpClientModule().getHttpVersion();
     private MimeToContentTypeMapper producesMimeType = httpClientModule().getProducesMimeTypeMapper();
diff --git a/application-http-client/src/main/java/ru/art/http/client/communicator/HttpCommunicationExecutor.java b/application-http-client/src/main/java/ru/art/http/client/communicator/HttpCommunicationExecutor.java
@@ -32,11 +32,11 @@
 import ru.art.entity.Value;
 import ru.art.entity.interceptor.*;
 import ru.art.entity.mapper.*;
-import ru.art.http.client.constants.*;
 import ru.art.http.client.exception.*;
 import ru.art.http.client.handler.*;
 import ru.art.http.client.interceptor.*;
 import ru.art.http.constants.*;
+import ru.art.http.constants.HttpHeaders;
 import ru.art.http.mapper.*;
 import static java.text.MessageFormat.*;
 import static java.util.Objects.*;
@@ -52,9 +52,9 @@
 import static ru.art.http.client.body.descriptor.HttpBodyDescriptor.*;
 import static ru.art.http.client.builder.HttpUriBuilder.*;
 import static ru.art.http.client.constants.HttpClientExceptionMessages.*;
-import static ru.art.http.client.constants.HttpClientModuleConstants.HttpClientKeepAliveHeaderStrategy.CONSIDER;
-import static ru.art.http.client.constants.HttpClientModuleConstants.HttpClientKeepAliveHeaderStrategy.IGNORE;
+import static ru.art.http.client.constants.HttpClientModuleConstants.ConnectionClosingPolicy.CLOSE_AFTER_RESPONSE;
 import static ru.art.http.client.module.HttpClientModule.*;
+import static ru.art.http.constants.HttpHeaders.KEEP_ALIVE;
 import static ru.art.logging.LoggingModule.*;
 import javax.annotation.*;
 import java.util.*;
@@ -91,9 +91,20 @@ private static <ResponseType> ResponseType executeHttpUriRequest(HttpCommunicati
         } catch (Throwable throwable) {
             throw new HttpClientException(throwable);
         } finally {
-            if (nonNull(httpResponse) && configuration.getKeepAliveResponseHeaderStrategy() == IGNORE) {
+            if (nonNull(httpResponse)) {
                 try {
-                    httpResponse.close();
+                    switch (configuration.getConnectionClosingPolicy()) {
+                        case CLOSE_AFTER_RESPONSE:
+                            httpResponse.close();
+                            break;
+                        case CLOSE_IF_NOT_KEEP_ALIVE_HEADER_PRESENTS:
+                            if (!httpResponse.containsHeader(KEEP_ALIVE)) {
+                                httpResponse.close();
+                            }
+                            break;
+                        case ALWAYS_KEEP_OPEN_AFTER_RESPONSE:
+                            break;
+                    }
                 } catch (Throwable closableThrowable) {
                     loggingModule()
                             .getLogger(HttpCommunicationExecutor.class)
diff --git a/application-http-client/src/main/java/ru/art/http/client/communicator/HttpCommunicator.java b/application-http-client/src/main/java/ru/art/http/client/communicator/HttpCommunicator.java
@@ -25,10 +25,12 @@
 import ru.art.entity.*;
 import ru.art.entity.interceptor.*;
 import ru.art.entity.mapper.*;
+import ru.art.http.client.constants.*;
 import ru.art.http.client.handler.*;
 import ru.art.http.client.interceptor.*;
 import ru.art.http.client.model.*;
 import ru.art.http.constants.*;
+import static ru.art.http.client.constants.HttpClientModuleConstants.*;
 import java.nio.charset.*;
 import java.util.*;
 import java.util.concurrent.*;
@@ -76,9 +78,7 @@ static HttpCommunicator httpCommunicator(HttpCommunicationTargetConfiguration ta
 
     HttpCommunicator options();
 
-    HttpCommunicator considerKeepAliveResponseHeader();
-
-    HttpCommunicator ignoreKeepAliveResponseHeader();
+    HttpCommunicator connectionClosingPolicy(ConnectionClosingPolicy policy);
 
     HttpCommunicator delete();
 
diff --git a/application-http-client/src/main/java/ru/art/http/client/communicator/HttpCommunicatorImplementation.java b/application-http-client/src/main/java/ru/art/http/client/communicator/HttpCommunicatorImplementation.java
@@ -43,7 +43,7 @@
 import static ru.art.core.extension.StringExtensions.*;
 import static ru.art.core.wrapper.ExceptionWrapper.*;
 import static ru.art.http.client.communicator.HttpCommunicationExecutor.*;
-import static ru.art.http.client.constants.HttpClientModuleConstants.HttpClientKeepAliveHeaderStrategy.*;
+import static ru.art.http.client.constants.HttpClientModuleConstants.*;
 import static ru.art.http.client.module.HttpClientModule.*;
 import static ru.art.http.constants.HttpMethodType.*;
 import static ru.art.logging.LoggingModule.*;
@@ -221,14 +221,8 @@ public HttpCommunicator gzipCompressed() {
     }
 
     @Override
-    public HttpCommunicator ignoreKeepAliveResponseHeader() {
-        configuration.setKeepAliveResponseHeaderStrategy(IGNORE);
-        return this;
-    }
-
-    @Override
-    public HttpCommunicator considerKeepAliveResponseHeader() {
-        configuration.setKeepAliveResponseHeaderStrategy(CONSIDER);
+    public HttpCommunicator connectionClosingPolicy(ConnectionClosingPolicy policy) {
+        configuration.setConnectionClosingPolicy(policy);
         return this;
     }
 
diff --git a/application-http-client/src/main/java/ru/art/http/client/constants/HttpClientModuleConstants.java b/application-http-client/src/main/java/ru/art/http/client/constants/HttpClientModuleConstants.java
@@ -28,8 +28,9 @@ public interface HttpClientModuleConstants {
     int DEFAULT_MAX_CONNECTIONS_PER_ROUTE = 2;
     int DEFAULT_MAX_CONNECTIONS_TOTAL = 20;
 
-    enum HttpClientKeepAliveHeaderStrategy {
-        IGNORE,
-        CONSIDER
+    enum ConnectionClosingPolicy {
+        CLOSE_AFTER_RESPONSE,
+        CLOSE_IF_NOT_KEEP_ALIVE_HEADER_PRESENTS,
+        ALWAYS_KEEP_OPEN_AFTER_RESPONSE
     }
 }
diff --git a/application-http/src/main/java/ru/art/http/constants/HttpHeaders.java b/application-http/src/main/java/ru/art/http/constants/HttpHeaders.java
@@ -379,4 +379,6 @@ public interface HttpHeaders {
      * @see <a href="http://tools.ietf.org/html/rfc7235#section-4.1">Section 4.1 of RFC 7235</a>
      */
     String WWW_AUTHENTICATE = "WWW-Authenticate";
+
+    String KEEP_ALIVE = "Keep-Alive";
 }
diff --git a/application-soap-client/src/main/java/ru/art/soap/client/communicator/SoapCommunicationConfiguration.java b/application-soap-client/src/main/java/ru/art/soap/client/communicator/SoapCommunicationConfiguration.java
@@ -26,13 +26,16 @@
 import ru.art.entity.*;
 import ru.art.entity.interceptor.*;
 import ru.art.entity.mapper.*;
+import ru.art.http.client.constants.*;
+import ru.art.http.client.constants.HttpClientModuleConstants.*;
 import ru.art.http.client.handler.*;
 import ru.art.http.client.interceptor.*;
 import ru.art.soap.client.exception.*;
 import ru.art.soap.content.mapper.*;
 import static lombok.AccessLevel.*;
 import static ru.art.core.checker.CheckerForEmptiness.*;
 import static ru.art.core.factory.CollectionsFactory.*;
+import static ru.art.http.client.constants.HttpClientModuleConstants.ConnectionClosingPolicy.CLOSE_AFTER_RESPONSE;
 import static ru.art.http.client.module.HttpClientModule.*;
 import static ru.art.soap.client.constants.SoapClientModuleConstants.*;
 import static ru.art.soap.client.constants.SoapClientModuleConstants.OperationIdSource.*;
@@ -71,6 +74,7 @@ class SoapCommunicationConfiguration {
     private List<ValueInterceptor<XmlEntity, XmlEntity>> requestValueInterceptors = linkedListOf();
     private List<ValueInterceptor<XmlEntity, XmlEntity>> responseValueInterceptors = linkedListOf();
     private OperationIdSource operationIdSource = REQUEST;
+    private ConnectionClosingPolicy connectionClosingPolicy = CLOSE_AFTER_RESPONSE;
 
     void validateRequiredFields() {
         boolean urlIsEmpty = isEmpty(url);
diff --git a/application-soap-client/src/main/java/ru/art/soap/client/communicator/SoapCommunicationExecutor.java b/application-soap-client/src/main/java/ru/art/soap/client/communicator/SoapCommunicationExecutor.java
@@ -40,6 +40,7 @@ static <RequestType, ResponseType> Optional<ResponseType> execute(SoapCommunicat
         configuration.getRequestValueInterceptors().forEach(interceptor -> httpCommunicator.addRequestValueInterceptor(cast(interceptor)));
         configuration.getResponseValueInterceptors().forEach(interceptor -> httpCommunicator.addResponseValueInterceptor(cast(interceptor)));
         httpCommunicator
+                .connectionClosingPolicy(configuration.getConnectionClosingPolicy())
                 .version(configuration.getHttpVersion())
                 .requestCharset(configuration.getRequestCharset())
                 .addHeader(ACCEPT, configuration.getConsumesMimeType().getMimeType().toString())
@@ -68,6 +69,7 @@ static <RequestType, ResponseType> CompletableFuture<Optional<ResponseType>> exe
         configuration.getRequestValueInterceptors().forEach(interceptor -> httpCommunicator.addRequestValueInterceptor(cast(interceptor)));
         configuration.getResponseValueInterceptors().forEach(interceptor -> httpCommunicator.addResponseValueInterceptor(cast(interceptor)));
         httpCommunicator
+                .connectionClosingPolicy(configuration.getConnectionClosingPolicy())
                 .version(configuration.getHttpVersion())
                 .requestCharset(configuration.getRequestCharset())
                 .addHeader(ACCEPT, configuration.getConsumesMimeType().getMimeType().toString())
diff --git a/application-soap-client/src/main/java/ru/art/soap/client/communicator/SoapCommunicator.java b/application-soap-client/src/main/java/ru/art/soap/client/communicator/SoapCommunicator.java
@@ -25,10 +25,13 @@
 import ru.art.entity.*;
 import ru.art.entity.interceptor.*;
 import ru.art.entity.mapper.*;
+import ru.art.http.client.communicator.*;
+import ru.art.http.client.constants.*;
 import ru.art.http.client.handler.*;
 import ru.art.http.client.interceptor.*;
 import ru.art.http.client.model.*;
 import ru.art.soap.content.mapper.*;
+import static ru.art.http.client.constants.HttpClientModuleConstants.*;
 import java.nio.charset.*;
 import java.util.*;
 import java.util.concurrent.*;
@@ -78,6 +81,8 @@ static SoapCommunicator soapCommunicator(HttpCommunicationTargetConfiguration ta
 
     SoapCommunicator useOperationIdFromConfiguration();
 
+    SoapCommunicator connectionClosingPolicy(ConnectionClosingPolicy policy);
+
     SoapCommunicator version(HttpVersion httpVersion);
 
     <RequestType, ResponseType> Optional<ResponseType> execute(RequestType request);
diff --git a/application-soap-client/src/main/java/ru/art/soap/client/communicator/SoapCommunicatorImplementation.java b/application-soap-client/src/main/java/ru/art/soap/client/communicator/SoapCommunicatorImplementation.java
@@ -26,6 +26,7 @@
 import ru.art.entity.*;
 import ru.art.entity.interceptor.*;
 import ru.art.entity.mapper.*;
+import ru.art.http.client.constants.*;
 import ru.art.http.client.handler.*;
 import ru.art.http.client.interceptor.*;
 import ru.art.http.client.model.*;
@@ -181,6 +182,12 @@ public SoapCommunicator useOperationIdFromConfiguration() {
         return this;
     }
 
+    @Override
+    public SoapCommunicator connectionClosingPolicy(HttpClientModuleConstants.ConnectionClosingPolicy policy) {
+        configuration.setConnectionClosingPolicy(policy);
+        return this;
+    }
+
     @Override
     public SoapCommunicator version(HttpVersion httpVersion) {
         HttpVersion httpProtocolVersion = getOrElse(httpVersion, httpClientModule().getHttpVersion());

Original file line number	Diff line number	Diff line change
`@@ -28,8 +28,9 @@ public interface HttpClientModuleConstants {`
`28`	`28`	`int DEFAULT_MAX_CONNECTIONS_PER_ROUTE = 2;`
`29`	`29`	`int DEFAULT_MAX_CONNECTIONS_TOTAL = 20;`
`30`	`30`
`31`		`- enum HttpClientKeepAliveHeaderStrategy {`
`32`		`- IGNORE,`
`33`		`- CONSIDER`
	`31`	`+ enum ConnectionClosingPolicy {`
	`32`	`+ CLOSE_AFTER_RESPONSE,`
	`33`	`+ CLOSE_IF_NOT_KEEP_ALIVE_HEADER_PRESENTS,`
	`34`	`+ ALWAYS_KEEP_OPEN_AFTER_RESPONSE`
`34`	`35`	`}`
`35`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -379,4 +379,6 @@ public interface HttpHeaders {`
`379`	`379`	`* @see <a href="http://tools.ietf.org/html/rfc7235#section-4.1">Section 4.1 of RFC 7235</a>`
`380`	`380`	`*/`
`381`	`381`	`String WWW_AUTHENTICATE = "WWW-Authenticate";`
	`382`	`+`
	`383`	`+ String KEEP_ALIVE = "Keep-Alive";`
`382`	`384`	`}`