Merge pull request #2134 from SavinduDimal/tls-graceful-termination-c…

…onfig Add a configuration parameter to enable/disable graceful TLS connection termination
wso2 · Feb 9, 2024 · 556303e · 556303e
2 parents 6666e7e + ce41c7c
commit 556303e
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 5 deletions.
diff --git a/...nsports/core/nhttp/src/main/java/org/apache/synapse/transport/passthru/SourceHandler.java b/...nsports/core/nhttp/src/main/java/org/apache/synapse/transport/passthru/SourceHandler.java
@@ -760,8 +760,13 @@ public void timeout(NHttpServerConnection conn) {
         }
 
         SourceContext.updateState(conn, ProtocolState.CLOSED);
-
-        sourceConfiguration.getSourceConnections().closeConnection(conn, true);
+
+        if (conf.isTLSGracefulConnectionTerminationEnabled()) {
+            sourceConfiguration.getSourceConnections().closeConnection(conn, true);
+        } else {
+            sourceConfiguration.getSourceConnections().shutDownConnection(conn, true);
+        }
+
         if (isTimeoutOccurred) {
             rollbackTransaction(conn);
         }
@@ -846,7 +851,13 @@ public void closed(NHttpServerConnection conn) {
         metrics.disconnected();
 
         SourceContext.updateState(conn, ProtocolState.CLOSED);
-        sourceConfiguration.getSourceConnections().closeConnection(conn, isFault);
+
+        if (conf.isTLSGracefulConnectionTerminationEnabled()) {
+            sourceConfiguration.getSourceConnections().closeConnection(conn, isFault);
+        } else {
+            sourceConfiguration.getSourceConnections().shutDownConnection(conn, isFault);
+        }
+
         if (isFault) {
             rollbackTransaction(conn);
             metrics.exceptionOccured();

diff --git a/...nsports/core/nhttp/src/main/java/org/apache/synapse/transport/passthru/TargetHandler.java b/...nsports/core/nhttp/src/main/java/org/apache/synapse/transport/passthru/TargetHandler.java
@@ -827,7 +827,12 @@ public void closed(NHttpClientConnection conn) {
         metrics.disconnected();
 
         TargetContext.updateState(conn, ProtocolState.CLOSED);
-        targetConfiguration.getConnections().closeConnection(conn, isFault);
+
+        if (conf.isTLSGracefulConnectionTerminationEnabled()) {
+            targetConfiguration.getConnections().closeConnection(conn, isFault);
+        } else {
+            targetConfiguration.getConnections().shutdownConnection(conn, isFault);
+        }
 
     }
 
@@ -937,7 +942,12 @@ public void timeout(NHttpClientConnection conn) {
         }
 
         TargetContext.updateState(conn, ProtocolState.CLOSED);
-        targetConfiguration.getConnections().closeConnection(conn, true);
+
+        if (conf.isTLSGracefulConnectionTerminationEnabled()) {
+            targetConfiguration.getConnections().closeConnection(conn, true);
+        } else {
+            targetConfiguration.getConnections().shutdownConnection(conn, true);
+        }
     }
 
     private String workerPoolExhaustedErrorMessage(Object clientWorker

diff --git a/...p/src/main/java/org/apache/synapse/transport/passthru/config/PassThroughConfigPNames.java b/...p/src/main/java/org/apache/synapse/transport/passthru/config/PassThroughConfigPNames.java
@@ -182,4 +182,10 @@ public interface PassThroughConfigPNames {
      * Defines whether to ignore case-sensitive headers from excess headers map
      */
     public String IGNORE_CASE_SENSITIVE_HEADERS = "ignore_case_sensitive_headers";
+
+    /**
+     * Defines whether TransportHandler and SourceHandler has to enable/disable TLS graceful connection termination
+     */
+    public String TLS_GRACEFUL_CONNECTION_TERMINATION = "tls_graceful_connection_termination";
+
 }
diff --git a/.../src/main/java/org/apache/synapse/transport/passthru/config/PassThroughConfiguration.java b/.../src/main/java/org/apache/synapse/transport/passthru/config/PassThroughConfiguration.java
@@ -70,6 +70,9 @@ public class PassThroughConfiguration {
     /** Reverse proxy mode is enabled or not */
     private Boolean reverseProxyMode = null;
 
+    /** Enables graceful termination for TLS connection */
+    private Boolean isTLSGracefulConnectionTerminationEnabled = null;
+
     /** Default Synapse service name */
     private String passThroughDefaultServiceName = null;
 
@@ -151,6 +154,14 @@ public boolean isCloseSocketOnEndpointTimeout() {
                 , CLOSE_SOCKET_ON_ENDPOINT_TIMEOUT, props);
     }
 
+    public boolean isTLSGracefulConnectionTerminationEnabled() {
+        if (isTLSGracefulConnectionTerminationEnabled == null) {
+            isTLSGracefulConnectionTerminationEnabled = getBooleanProperty(
+                    PassThroughConfigPNames.TLS_GRACEFUL_CONNECTION_TERMINATION, true);
+        }
+        return isTLSGracefulConnectionTerminationEnabled;
+    }
+
     public boolean isConsumeAndDiscard() {
         isConsumeAndDiscard =
                     ConfigurationBuilderUtil.getBooleanProperty(PassThroughConfigPNames.CONSUME_AND_DISCARD,