From bf057b35b1b7ed35332f84ff58435e89026db36b Mon Sep 17 00:00:00 2001
From: Nick Burch <nick.burch@quanticate.com>
Date: Thu, 25 Aug 2011 14:16:06 +0000
Subject: [PATCH] IT-5103 - Try to avoid "BindException: Address already in
 use" on build boxes when repeatedly stopping and starting the repository, by
 enabling retries (default for up to 1 second) when creating RMI Server Ports

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@30063 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
---
 config/alfresco/core-services-context.xml     |  1 +
 config/alfresco/remote-services-context.xml   |  5 +-
 config/alfresco/repository.properties         |  4 ++
 .../socket/HostConfigurableSocketFactory.java | 61 ++++++++++++++++++-
 4 files changed, 68 insertions(+), 3 deletions(-)

diff --git a/config/alfresco/core-services-context.xml b/config/alfresco/core-services-context.xml
index a71fa35755..490a75af21 100644
--- a/config/alfresco/core-services-context.xml
+++ b/config/alfresco/core-services-context.xml
@@ -6,6 +6,7 @@
 
    <bean id="hostConfigurableSocketFactory" class="org.alfresco.util.remote.server.socket.HostConfigurableSocketFactory">
       <property name="host" value="${alfresco.rmi.services.host}" />
+      <property name="retries" value="${alfresco.rmi.services.retries}" />
    </bean>
 
    <bean id="baseServiceExporter" class="org.springframework.remoting.rmi.RmiServiceExporter" abstract="true">
diff --git a/config/alfresco/remote-services-context.xml b/config/alfresco/remote-services-context.xml
index a2f85fc5d7..50db60d980 100644
--- a/config/alfresco/remote-services-context.xml
+++ b/config/alfresco/remote-services-context.xml
@@ -73,6 +73,9 @@
 		<property name="servicePort">
 			<value>${authentication.rmi.service.port}</value>
 		</property>
+		<property name="clientSocketFactory">
+			<ref bean="hostConfigurableSocketFactory" />
+		</property>
 	</bean>    
 	
     <!-- A Simple Filesystem like API for the repo implementation.
@@ -167,4 +170,4 @@
 			<value>${action.rmi.service.port}</value>
 		</property>
     </bean>
-</beans>
\ No newline at end of file
+</beans>
diff --git a/config/alfresco/repository.properties b/config/alfresco/repository.properties
index b68743d0fc..7d0025aa52 100644
--- a/config/alfresco/repository.properties
+++ b/config/alfresco/repository.properties
@@ -497,6 +497,10 @@ policy.content.update.ignoreEmpty=false
 #
 alfresco.rmi.services.host=0.0.0.0
 
+# If the RMI address is in-use, how many retries should be done before aborting
+# Default value of alfresco.rmi.services.retries is 0 which means 'Don't retry if the address is in-use'
+alfresco.rmi.services.retries=4
+
 # RMI service ports for the individual services.
 # These eight services are available remotely.
 #
diff --git a/source/java/org/alfresco/util/remote/server/socket/HostConfigurableSocketFactory.java b/source/java/org/alfresco/util/remote/server/socket/HostConfigurableSocketFactory.java
index f3d1394656..f763ad61ca 100644
--- a/source/java/org/alfresco/util/remote/server/socket/HostConfigurableSocketFactory.java
+++ b/source/java/org/alfresco/util/remote/server/socket/HostConfigurableSocketFactory.java
@@ -20,6 +20,7 @@ package org.alfresco.util.remote.server.socket;
 
 import java.io.IOException;
 import java.io.Serializable;
+import java.net.BindException;
 import java.net.InetAddress;
 import java.net.ServerSocket;
 import java.net.Socket;
@@ -28,6 +29,8 @@ import java.rmi.server.RMIClientSocketFactory;
 import java.rmi.server.RMIServerSocketFactory;
 
 import org.alfresco.util.EqualsHelper;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.springframework.beans.factory.InitializingBean;
 
 /**
@@ -46,9 +49,20 @@ import org.springframework.beans.factory.InitializingBean;
 public class HostConfigurableSocketFactory implements RMIServerSocketFactory, RMIClientSocketFactory, Serializable
 {
     private static final long serialVersionUID = 1L;
+    private static Log logger = LogFactory.getLog(HostConfigurableSocketFactory.class);
 
+    /**
+     * How many retries to attempt if the socket is in use.
+     * Default is zero (no retries)
+     */
+    private int retries = 0;
+    /**
+     * How long to wait between retries, in miliseconds?
+     */
+    private int retryInterval = 250;
+    
     private InetAddress host;
-
+    
     public void setHost(String host)
     {
         try
@@ -64,6 +78,23 @@ public class HostConfigurableSocketFactory implements RMIServerSocketFactory, RM
             throw new RuntimeException(e.toString());
         }
     }
+    
+    /**
+     * How many retries to attempt if the socket is in use.
+     * Default is zero (no retries)
+     */
+    public void setRetries(int retries)
+    {
+       this.retries = retries;
+    }
+    
+    /**
+     * How long to wait between retries, in miliseconds?
+     */
+    public void setRetryInterval(int retryInterval)
+    {
+       this.retryInterval = retryInterval;
+    }
 
     public Socket createSocket(String host, int port) throws IOException
     {
@@ -72,7 +103,33 @@ public class HostConfigurableSocketFactory implements RMIServerSocketFactory, RM
 
     public ServerSocket createServerSocket(int port) throws IOException
     {
-        return new ServerSocket(port, 50, this.host);
+        ServerSocket socket = null;
+        for(int i=0; socket == null && i<retries+1; i++)
+        {
+           try
+           {
+              socket = new ServerSocket(port, 50, this.host);
+           }
+           catch(BindException e)
+           {
+              if(i >= retries)
+              {
+                 // We're out of retries, abort
+                 throw e;
+              }
+              else
+              {
+                 // Sleep and try again
+                 logger.warn("Port in-use, retrying", e);
+                 try
+                 {
+                    Thread.sleep(retryInterval);
+                 }
+                 catch(InterruptedException ie) {}
+              }
+           }
+        }
+        return socket;
     }
 
     /*