Add "Override local binding" to HTTP Sender

Author: jbeckers

client/src/com/mirth/connect/connectors/http/HttpSender.java

@@ -1,8 +1,8 @@
 /*
  * Copyright (c) Mirth Corporation. All rights reserved.
- * 
+ *
  * http://www.mirthcorp.com
- * 
+ *
  * The software in this package is published under the terms of the MPL license a copy of which has
  * been included with this distribution in the LICENSE.txt file.
  */
@@ -130,7 +130,7 @@ public void changedUpdate(DocumentEvent e) {
                 checkContentEnabled();
             }
         });
-        
+
         initToolTips();
         initLayout();
     }
@@ -148,6 +148,8 @@ public ConnectorProperties getProperties() {
         properties.setUseProxyServer(useProxyServerYesRadio.isSelected());
         properties.setProxyAddress(proxyAddressField.getText());
         properties.setProxyPort(proxyPortField.getText());
+        properties.setOverrideLocalBinding(overrideLocalBindingYesRadio.isSelected());
+        properties.setLocalAddress(localAddressField.getText());
 
         if (postButton.isSelected()) {
             properties.setMethod("post");
@@ -190,7 +192,7 @@ public ConnectorProperties getProperties() {
         properties.setParametersMap(getProperties(queryParametersTable));
         properties.setUseParametersVariable(useQueryParamsVariableRadio.isSelected());
         properties.setParametersVariable(queryParamsVariableField.getText());
-        
+
         properties.setHeadersMap(getProperties(headersTable));
         properties.setUseHeadersVariable(useHeadersVariableRadio.isSelected());
         properties.setHeadersVariable(headersVariableField.getText());
@@ -219,6 +221,15 @@ public void setProperties(ConnectorProperties properties) {
         proxyAddressField.setText(props.getProxyAddress());
         proxyPortField.setText(props.getProxyPort());
 
+        if (props.isOverrideLocalBinding()) {
+            overrideLocalBindingYesRadio.setSelected(true);
+            overrideLocalBindingYesRadioActionPerformed(null);
+        } else {
+            overrideLocalBindingNoRadio.setSelected(true);
+            overrideLocalBindingNoRadioActionPerformed(null);
+        }
+        localAddressField.setText(props.getLocalAddress());
+
         if (props.getMethod().equalsIgnoreCase("post")) {
             postButton.setSelected(true);
             postButtonActionPerformed(null);
@@ -656,6 +667,15 @@ public boolean checkProperties(ConnectorProperties properties, boolean highlight
             }
         }
 
+        if (props.isOverrideLocalBinding()) {
+            if (props.getLocalAddress().length() <= 3) {
+                valid = false;
+                if (highlight) {
+                    localAddressField.setBackground(UIConstants.INVALID_COLOR);
+                }
+            }
+        }
+
         return valid;
     }
 
@@ -670,6 +690,7 @@ public void resetInvalidProperties() {
         headersVariableField.setBackground(null);
         contentTypeField.setBackground(null);
         contentTextArea.setBackground(null);
+        localAddressField.setBackground(null);
     }
 
     @Override
@@ -889,6 +910,12 @@ private void initComponents() {
         responseBinaryMimeTypesField = new MirthTextField();
         responseBinaryMimeTypesRegexCheckBox = new MirthCheckBox();
         patchButton = new MirthRadioButton();
+        overrideLocalBindingLabel = new JLabel();
+        overrideLocalBindingButtonGroup = new ButtonGroup();
+        overrideLocalBindingYesRadio = new MirthRadioButton();
+        overrideLocalBindingNoRadio = new MirthRadioButton();
+        localAddressLabel = new JLabel();
+        localAddressField = new MirthIconTextField();
 
         setBackground(new Color(255, 255, 255));
         setBorder(BorderFactory.createEmptyBorder(1, 1, 1, 1));
@@ -926,13 +953,13 @@ public void actionPerformed(ActionEvent evt) {
         useQueryParamsTableRadio.addActionListener(event -> {
             useQueryParamsVariableFieldsEnabled(false);
         });
-        
+
         useQueryParamsVariableRadio.setText("Use Map:");
         useQueryParamsVariableRadio.setBackground(new Color(255, 255, 255));
         useQueryParamsVariableRadio.addActionListener(event -> {
             useQueryParamsVariableFieldsEnabled(true);
         });
-        
+
         ButtonGroup queryParamsButtonGroup = new ButtonGroup();
         queryParamsButtonGroup.add(useQueryParamsTableRadio);
         queryParamsButtonGroup.add(useQueryParamsVariableRadio);
@@ -989,17 +1016,17 @@ public void actionPerformed(ActionEvent evt) {
         useHeadersTableRadio.addActionListener(event -> {
             useHeadersVariableFieldsEnabled(false);
         });
-        
+
         useHeadersVariableRadio.setText("Use Map:");
         useHeadersVariableRadio.setBackground(new Color(255, 255, 255));
         useHeadersVariableRadio.addActionListener(event -> {
             useHeadersVariableFieldsEnabled(true);
         });
-        
+
         ButtonGroup headersButtonGroup = new ButtonGroup();
         headersButtonGroup.add(useHeadersTableRadio);
         headersButtonGroup.add(useHeadersVariableRadio);
-        
+
         responseContentLabel.setText("Response Content:");
 
         responseContentXmlBodyRadio.setBackground(new Color(255, 255, 255));
@@ -1203,8 +1230,38 @@ public void actionPerformed(ActionEvent evt) {
                 patchButtonActionPerformed(evt);
             }
         });
+
+        localAddressLabel.setText("Local Address:");
+
+        localAddressField.setToolTipText("<html>The local address that the client socket will be bound to, if Override Local Binding is set to Yes.<br/></html>");
+
+        overrideLocalBindingLabel.setText("Override Local Binding:");
+
+        overrideLocalBindingYesRadio.setBackground(new Color(255, 255, 255));
+        overrideLocalBindingYesRadio.setBorder(BorderFactory.createEmptyBorder(0, 0, 0, 0));
+        overrideLocalBindingButtonGroup.add(overrideLocalBindingYesRadio);
+        overrideLocalBindingYesRadio.setText("Yes");
+        overrideLocalBindingYesRadio.setToolTipText("<html>Select Yes to override the local address that the client socket will be bound to.<br/>Select No to use the default values of 0.0.0.0:0.<br/></html>");
+        overrideLocalBindingYesRadio.setMargin(new Insets(0, 0, 0, 0));
+        overrideLocalBindingYesRadio.addActionListener(new ActionListener() {
+            public void actionPerformed(ActionEvent evt) {
+                overrideLocalBindingYesRadioActionPerformed(evt);
+            }
+        });
+
+        overrideLocalBindingNoRadio.setBackground(new Color(255, 255, 255));
+        overrideLocalBindingNoRadio.setBorder(BorderFactory.createEmptyBorder(0, 0, 0, 0));
+        overrideLocalBindingButtonGroup.add(overrideLocalBindingNoRadio);
+        overrideLocalBindingNoRadio.setText("No");
+        overrideLocalBindingNoRadio.setToolTipText("<html>Select Yes to override the local address that the client socket will be bound to.<br/>Select No to use the default values of 0.0.0.0:0.<br/></html>");
+        overrideLocalBindingNoRadio.setMargin(new Insets(0, 0, 0, 0));
+        overrideLocalBindingNoRadio.addActionListener(new ActionListener() {
+            public void actionPerformed(ActionEvent evt) {
+                overrideLocalBindingNoRadioActionPerformed(evt);
+            }
+        });
     }
-    
+
     private void initToolTips() {
         urlField.setToolTipText("Enter the URL of the HTTP server to send each message to.");
         queryParametersTable.setToolTipText("Query parameters are encoded as x=y pairs as part of the request URL, separated from it by a '?' and from each other by an '&'.");
@@ -1243,15 +1300,15 @@ private void initToolTips() {
         patchButton.setToolTipText("Selects the HTTP operation used to send each message.");
         useQueryParamsTableRadio.setToolTipText("<html>The table below will be used to populate query parameters.</html>");
         useQueryParamsVariableRadio.setToolTipText("<html>The Java map specified by the following variable will be used to populate query parameters.<br/>The map must have String keys and either String or List&lt;String&gt; values.</html>");
-        queryParamsVariableField.setToolTipText("<html>The variable of a Java map to use to populate query parameters.<br/>The map must have String keys and either String or List&lt;String&gt; values.</html>");  
+        queryParamsVariableField.setToolTipText("<html>The variable of a Java map to use to populate query parameters.<br/>The map must have String keys and either String or List&lt;String&gt; values.</html>");
         useHeadersTableRadio.setToolTipText("<html>The table below will be used to populate headers.</html>");
         useHeadersVariableRadio.setToolTipText("<html>The Java map specified by the following variable will be used to populate headers.<br/>The map must have String keys and either String or List&lt;String&gt; values.</html>");
         headersVariableField.setToolTipText("<html>The variable of a Java map to use to populate headers.<br/>The map must have String keys and either String or List&lt;String&gt; values.</html>");
     }
-    
+
     private void initLayout() {
         setLayout(new MigLayout("insets 0 8 0 8, novisualpadding, hidemode 3, gap 12 6", "[][]6[]", "[][][][][][][][][][][][][][][][][grow][][grow][][][][grow]"));
-        
+
         add(urlLabel, "right");
         add(urlField, "w 312!, sx, split 2");
         add(testConnection, "gapbefore 6");
@@ -1262,6 +1319,11 @@ private void initLayout() {
         add(proxyAddressField, "w 202!, sx");
         add(proxyPortLabel, "newline, right");
         add(proxyPortField, "w 56!, sx");
+        add(overrideLocalBindingLabel, "newline, right");
+        add(overrideLocalBindingYesRadio, "split 2");
+        add(overrideLocalBindingNoRadio);
+        add(localAddressLabel, "newline, right");
+        add(localAddressField, "w 200!, sx");
         add(methodLabel, "newline, right");
         add(postButton, "split 5");
         add(getButton);
@@ -1476,21 +1538,31 @@ private void dataTypeTextRadioActionPerformed(ActionEvent evt) {
             charsetEncodingCombobox.setEnabled(true);
         }
     }
-    
+
     private void useHeadersVariableFieldsEnabled(boolean useVariable) {
         headersVariableField.setEnabled(useVariable);
         headersTable.setEnabled(!useVariable);
         headersNewButton.setEnabled(!useVariable);
         headersDeleteButton.setEnabled(!useVariable && headersTable.getSelectedRow() > -1);
     }
-    
+
     private void useQueryParamsVariableFieldsEnabled(boolean useVariable) {
         queryParamsVariableField.setEnabled(useVariable);
         queryParametersTable.setEnabled(!useVariable);
         queryParametersNewButton.setEnabled(!useVariable);
         queryParametersDeleteButton.setEnabled(!useVariable && queryParametersTable.getSelectedRow() > -1);
     }
-    
+
+    private void overrideLocalBindingYesRadioActionPerformed(ActionEvent evt) {
+        localAddressField.setEnabled(true);
+        localAddressLabel.setEnabled(true);
+    }
+
+    private void overrideLocalBindingNoRadioActionPerformed(ActionEvent evt) {
+        localAddressField.setEnabled(false);
+        localAddressLabel.setEnabled(false);
+    }
+
     private ButtonGroup authenticationButtonGroup;
     private JLabel authenticationLabel;
     private MirthRadioButton authenticationNoRadio;
@@ -1570,4 +1642,10 @@ private void useQueryParamsVariableFieldsEnabled(boolean useVariable) {
     private MirthRadioButton useProxyServerYesRadio;
     private MirthTextField usernameField;
     private JLabel usernameLabel;
+    private JLabel overrideLocalBindingLabel;
+    private ButtonGroup overrideLocalBindingButtonGroup;
+    private MirthRadioButton overrideLocalBindingNoRadio;
+    private MirthRadioButton overrideLocalBindingYesRadio;
+    private JLabel localAddressLabel;
+    private MirthIconTextField localAddressField;
 }

server/src/com/mirth/connect/connectors/http/HttpConnectorServlet.java

@@ -1,8 +1,8 @@
 /*
  * Copyright (c) Mirth Corporation. All rights reserved.
- * 
+ *
  * http://www.mirthcorp.com
- * 
+ *
  * The software in this package is published under the terms of the MPL license a copy of which has
  * been included with this distribution in the LICENSE.txt file.
  */
@@ -15,13 +15,12 @@
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.SecurityContext;
 
-import org.apache.commons.lang3.StringUtils;
-
 import com.mirth.connect.client.core.api.MirthApiException;
 import com.mirth.connect.server.api.MirthServlet;
 import com.mirth.connect.server.util.ConnectorUtil;
 import com.mirth.connect.server.util.TemplateValueReplacer;
 import com.mirth.connect.util.ConnectionTestResponse;
+import org.apache.commons.lang3.Strings;
 
 public class HttpConnectorServlet extends MirthServlet implements HttpConnectorServletInterface {
 
@@ -36,9 +35,22 @@ public HttpConnectorServlet(@Context HttpServletRequest request, @Context Securi
     public ConnectionTestResponse testConnection(String channelId, String channelName, HttpDispatcherProperties properties) {
         try {
             URL url = new URL(replacer.replaceValues(properties.getHost(), channelId, channelName));
-            int port = url.getPort();
             // If no port was provided, default to port 80 or 443.
-            return ConnectorUtil.testConnection(url.getHost(), (port == -1) ? (StringUtils.equalsIgnoreCase(url.getProtocol(), "https") ? 443 : 80) : port, TIMEOUT);
+            final int port;
+            if (url.getPort() != -1) {
+                port = url.getPort();
+            } else if (Strings.CI.equals(url.getProtocol(), "https")) {
+                port = 443;
+            } else {
+                port = 80;
+            }
+
+            if (!properties.isOverrideLocalBinding()) {
+                return ConnectorUtil.testConnection(url.getHost(), port, TIMEOUT);
+            } else {
+                String localAddr = replacer.replaceValues(properties.getLocalAddress(), channelId, channelName);
+                return ConnectorUtil.testConnection(url.getHost(), port, TIMEOUT, localAddr);
+            }
         } catch (Exception e) {
             throw new MirthApiException(e);
         }

server/src/com/mirth/connect/connectors/http/HttpDispatcher.java

@@ -1,15 +1,16 @@
 /*
  * Copyright (c) Mirth Corporation. All rights reserved.
- * 
+ *
  * http://www.mirthcorp.com
- * 
+ *
  * The software in this package is published under the terms of the MPL license a copy of which has
  * been included with this distribution in the LICENSE.txt file.
  */
 
 package com.mirth.connect.connectors.http;
 
 import java.io.File;
+import java.net.InetAddress;
 import java.net.URI;
 import java.nio.charset.Charset;
 import java.util.ArrayList;
@@ -27,6 +28,8 @@
 import javax.mail.util.ByteArrayDataSource;
 
 import com.mirth.connect.client.core.BrandingConstants;
+import com.mirth.connect.connectors.tcp.TcpDispatcherProperties;
+import com.mirth.connect.util.TcpUtil;
 import org.apache.commons.collections4.CollectionUtils;
 import org.apache.commons.collections4.map.CaseInsensitiveMap;
 import org.apache.commons.fileupload.FileUploadBase;
@@ -192,6 +195,7 @@ public void replaceConnectorProperties(ConnectorProperties connectorProperties,
         httpDispatcherProperties.setHost(replacer.replaceValues(httpDispatcherProperties.getHost(), connectorMessage));
         httpDispatcherProperties.setProxyAddress(replacer.replaceValues(httpDispatcherProperties.getProxyAddress(), connectorMessage));
         httpDispatcherProperties.setProxyPort(replacer.replaceValues(httpDispatcherProperties.getProxyPort(), connectorMessage));
+        httpDispatcherProperties.setLocalAddress(replacer.replaceValues(httpDispatcherProperties.getLocalAddress(), connectorMessage));
         httpDispatcherProperties.setResponseBinaryMimeTypes(replacer.replaceValues(httpDispatcherProperties.getResponseBinaryMimeTypes(), connectorMessage));
         httpDispatcherProperties.setHeadersMap(replacer.replaceKeysAndValuesInMap(httpDispatcherProperties.getHeadersMap(), connectorMessage));
         httpDispatcherProperties.setHeadersVariable(replacer.replaceValues(httpDispatcherProperties.getHeadersVariable(), connectorMessage));
@@ -258,9 +262,9 @@ public Response send(ConnectorProperties connectorProperties, ConnectorMessage c
 
             /*
              * If a charset is set in the Content Type field, use that.
-             * 
+             *
              * If the charset is NONE, keep it as null.
-             * 
+             *
              * Otherwise, use the charset from the Character Encoding drop-down menu.
              */
             Charset charset = null;
@@ -312,8 +316,15 @@ public Response send(ConnectorProperties connectorProperties, ConnectorMessage c
                 logger.debug("using authentication with credentials: " + credentials);
             }
 
-            RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(socketTimeout).setSocketTimeout(socketTimeout).setStaleConnectionCheckEnabled(true).build();
-            context.setRequestConfig(requestConfig);
+            final RequestConfig.Builder requestConfigBuilder = RequestConfig.custom()
+                    .setConnectTimeout(socketTimeout)
+                    .setSocketTimeout(socketTimeout)
+                    .setStaleConnectionCheckEnabled(true);
+            if (httpDispatcherProperties.isOverrideLocalBinding()) {
+                final InetAddress localAddress = InetAddress.getByName(getLocalAddress());
+                requestConfigBuilder.setLocalAddress(localAddress);
+            }
+            context.setRequestConfig(requestConfigBuilder.build());
 
             // Set proxy information
             if (httpDispatcherProperties.isUseProxyServer()) {
@@ -444,7 +455,7 @@ public boolean isBinaryContentType(ContentType contentType) {
 
         return new Response(responseStatus, responseData, responseStatusMessage, responseError, validateResponse);
     }
-    
+
     protected boolean shouldParseMultipart(HttpDispatcherProperties httpDispatcherProperties, String mimeType) {
     	// Only parse multipart if XML Body is selected and Parse Multipart is enabled
     	return httpDispatcherProperties.isResponseXmlBody() && httpDispatcherProperties.isResponseParseMultipart() && mimeType.startsWith(FileUploadBase.MULTIPART);
@@ -709,6 +720,9 @@ private boolean isBinaryContentType(String binaryMimeTypes, ContentType contentT
         }
     }
 
+    private String getLocalAddress() {
+        return TcpUtil.getFixedHost(replacer.replaceValues(getConnectorProperties().getLocalAddress(), getChannelId(), getChannel().getName()));
+    }
     @Override
     public HttpDispatcherProperties getConnectorProperties() {
         return (HttpDispatcherProperties) super.getConnectorProperties();