Issue #7277 - Allow Request.getLocalName() and .getLocalPort() to be overridden

jetty-server/src/main/java/org/eclipse/jetty/server/AbstractConnector.java

@@ -42,6 +42,7 @@
 import org.eclipse.jetty.io.ByteBufferPool;
 import org.eclipse.jetty.io.EndPoint;
 import org.eclipse.jetty.io.ssl.SslConnection;
+import org.eclipse.jetty.util.HostPort;
 import org.eclipse.jetty.util.ProcessorUtils;
 import org.eclipse.jetty.util.StringUtil;
 import org.eclipse.jetty.util.annotation.ManagedAttribute;
@@ -161,7 +162,10 @@ public abstract class AbstractConnector extends ContainerLifeCycle implements Co
     private long _idleTimeout = 30000;
     private String _defaultProtocol;
     private ConnectionFactory _defaultConnectionFactory;
+    /* The name used to link up virtual host configuration to named connectors */
     private String _name;
+    /* The authority used to override the connection local name/port (see ServletRequest.getLocalName(), and ServletRequest.getLocalPort()) */
+    private HostPort _localAuthority;
     private int _acceptorPriorityDelta = -2;
     private boolean _accepting = true;
     private ThreadPoolBudget.Lease _lease;
@@ -298,6 +302,42 @@ public int getAcceptors()
         return _acceptors.length;
     }
 
+    /**
+     * @return Returns the optional local authority override
+     */
+    @ManagedAttribute("local authority")
+    public HostPort getLocalAuthority()
+    {
+        return _localAuthority;
+    }
+
+    /**
+     * Optional override of connection local name/port used within application API layer
+     * when identifying the local host name/port of a connected endpoint.
+     *
+     * @param authority the full authority including host and port, or null to unset
+     */
+    public void setLocalAuthority(String authority)
+    {
+        setLocalAuthority(new HostPort(authority));
+    }
+
+    /**
+     * Optional override of connection local name/port used within application API layer
+     * when identifying the local host name/port of a connected endpoint.
+     *
+     * @param authority the full authority including host and port, or null to unset
+     */
+    public void setLocalAuthority(HostPort authority)
+    {
+        if (authority == null)
+            _localAuthority = null;
+        else if (!authority.hasHost() || !authority.hasPort())
+            throw new IllegalStateException("Local Authority must have host and port declared");
+        else
+            _localAuthority = authority;
+    }
+
     @Override
     protected void doStart() throws Exception
     {
@@ -318,6 +358,7 @@ protected void doStart() throws Exception
         }
 
         _lease = ThreadPoolBudget.leaseFrom(getExecutor(), this, _acceptors.length);
+
         super.doStart();
 
         _stopping = new CountDownLatch(_acceptors.length);

jetty-server/src/main/java/org/eclipse/jetty/server/HttpChannel.java

@@ -97,6 +97,7 @@ public class HttpChannel implements Runnable, HttpOutput.Interceptor
     private MetaData.Response _committedMetaData;
     private RequestLog _requestLog;
     private long _oldIdleTimeout;
+    private String overriddenLocalName;
 
     /**
      * Bytes written after interception (eg after compression)
@@ -298,6 +299,73 @@ public EndPoint getEndPoint()
         return _endPoint;
     }
 
+    /**
+     * <p>Return the Local Name of the connected channel.</p>
+     *
+     * <p>
+     * This is the name after the connector is bound and the connection is accepted.
+     * The value is typically the local address and optionally the local host name
+     * if the local address is unavailable.
+     * </p>
+     * <p>
+     * Value can be overridden by {@link AbstractConnector#setLocalAuthority(HostPort)} for
+     * scenarios where Jetty is being an intermediary and the local name
+     * needs to be changed to satisfy public (pre-intermediary) HTTP behaviors
+     * such as absolute-URI creation (eg: Location response header).
+     * </p>
+     *
+     * @return the local name if overridden, or the local address, or
+     * null in the case of no local address (usually seen in connectors not based on IP networking).
+     */
+    public String getLocalName()
+    {
+        Connector connector = getConnector();
+
+        if (connector instanceof AbstractConnector)
+        {
+            HostPort localAuthority = ((AbstractConnector)connector).getLocalAuthority();
+            if (localAuthority != null)
+                return localAuthority.getHost();
+        }
+
+        InetSocketAddress local = getLocalAddress();
+        if (local != null)
+            return local.getHostString();
+
+        return null;
+    }
+
+    /**
+     * <p>Return the Local Port of the connected channel.</p>
+     *
+     * <p>
+     * This is the port the connector is bound to and is accepting connection on.
+     * </p>
+     * <p>
+     * Value can be overridden by {@link AbstractConnector#setLocalAuthority(HostPort)} for
+     * scenarios where Jetty is being an intermediary and the local port
+     * needs to be changed to satisfy public (pre-intermediary) HTTP behaviors
+     * such as absolute-URI creation (eg: Location response header).
+     * </p>
+     *
+     * @return the local authority port if overridden, or the local address port, or
+     * 0 in the case of no local address (usually seen in connectors not based on IP networking).
+     */
+    public int getLocalPort()
+    {
+        Connector connector = getConnector();
+
+        if (connector instanceof AbstractConnector)
+        {
+            HostPort localAuthority = ((AbstractConnector)connector).getLocalAuthority();
+            if (localAuthority != null)
+                return localAuthority.getPort();
+        }
+
+        InetSocketAddress local = getLocalAddress();
+        return local == null ? 0 : local.getPort();
+    }
+
     public InetSocketAddress getLocalAddress()
     {
         return _endPoint.getLocalAddress();

jetty-server/src/main/java/org/eclipse/jetty/server/Request.java

@@ -1025,22 +1025,11 @@ public String getLocalName()
     {
         if (_channel != null)
         {
-            InetSocketAddress local = _channel.getLocalAddress();
-            if (local != null)
-                return formatAddrOrHost(local.getHostString());
+            String localName = _channel.getLocalName();
+            if (localName != null)
+                return formatAddrOrHost(localName);
         }
 
-        try
-        {
-            String name = InetAddress.getLocalHost().getHostName();
-            if (StringUtil.ALL_INTERFACES.equals(name))
-                return null;
-            return formatAddrOrHost(name);
-        }
-        catch (UnknownHostException e)
-        {
-            LOG.ignore(e);
-        }
         return null;
     }
 
@@ -1050,10 +1039,16 @@ public String getLocalName()
     @Override
     public int getLocalPort()
     {
-        if (_channel == null)
-            return 0;
-        InetSocketAddress local = _channel.getLocalAddress();
-        return local == null ? 0 : local.getPort();
+        if (_channel != null)
+        {
+            int localPort = _channel.getLocalPort();
+            if (localPort > 0)
+                return localPort;
+            InetSocketAddress local = _channel.getLocalAddress();
+            if (local != null)
+                return local.getPort();
+        }
+        return 0;
     }
 
     /*
@@ -1474,19 +1469,18 @@ private int findServerPort()
         HttpField host = metadata == null ? null : metadata.getFields().getField(HttpHeader.HOST);
         if (host != null)
         {
-            // TODO is this needed now?
             HostPortHttpField authority = (host instanceof HostPortHttpField)
                 ? ((HostPortHttpField)host)
                 : new HostPortHttpField(host.getValue());
-            metadata.getURI().setAuthority(authority.getHost(), authority.getPort());
-            return authority.getPort();
+            if (authority.getHostPort().hasHost() && authority.getHostPort().hasPort())
+            {
+                metadata.getURI().setAuthority(authority.getHost(), authority.getPort());
+                return authority.getPort();
+            }
         }
 
         // Return host from connection
-        if (_channel != null)
-            return getLocalPort();
-
-        return -1;
+        return getLocalPort();
     }
 
     @Override