Merge pull request #2759 from RestComm/issue-2758

Fixes #2758

Author: maria-farooq

restcomm/restcomm.telephony/src/main/java/org/restcomm/connect/telephony/ua/UserAgentManager.java

@@ -24,6 +24,8 @@
 import static javax.servlet.sip.SipServletResponse.SC_OK;
 import static javax.servlet.sip.SipServletResponse.SC_PROXY_AUTHENTICATION_REQUIRED;
 import static javax.servlet.sip.SipServletResponse.SC_UNAUTHORIZED;
+import static javax.servlet.sip.SipServletResponse.SC_BUSY_EVERYWHERE;
+import static javax.servlet.sip.SipServletResponse.SC_BUSY_HERE;
 import static org.restcomm.connect.commons.util.HexadecimalUtils.toHex;
 
 import java.io.IOException;
@@ -311,7 +313,11 @@ public void onReceive(final Object message) throws Exception {
             }
         } else if (message instanceof SipServletResponse) {
             SipServletResponse response = (SipServletResponse) message;
-            if (response.getStatus()>400 && response.getMethod().equalsIgnoreCase("OPTIONS")) {
+            int responseStatusCode = response.getStatus();
+            if (responseStatusCode > 400
+                    // https://telestax.atlassian.net/browse/RESTCOMM-1582: Fix for User Agent that reply with BUSY when they are in a call
+                    && (responseStatusCode != SC_BUSY_HERE && responseStatusCode != SC_BUSY_EVERYWHERE)
+                    && response.getMethod().equalsIgnoreCase("OPTIONS")) {
                 removeRegistration(response);
             } else if (actAsImsUa && response.getMethod().equalsIgnoreCase(REGISTER)) {
                 proxyResponseFromIms(message, response);

restcomm/restcomm.testsuite/src/test/java/org/restcomm/connect/testsuite/telephony/ua/UserAgentManagerTest.java

@@ -508,6 +508,38 @@ public void registerUserAgentWith408ErrorResponse() throws ParseException, Inter
         assertTrue(MonitoringServiceTool.getInstance().getRegisteredUsers(deploymentUrl.toString(),adminAccountSid, adminAuthToken)==0);
     }
 
+    @Test
+    public void registerUserAgentWith486BusyErrorResponse() throws ParseException, InterruptedException, InvalidArgumentException {
+//        deployer.deploy("UserAgentTest");
+        // Register the phone so we can get OPTIONS pings from RestComm.
+        SipURI uri = sipStack2.getAddressFactory().createSipURI(null, restcommContact);
+        Credential c = new Credential("127.0.0.1","bob", "1234");
+        phone2.addUpdateCredential(c);
+        assertTrue(phone2.register(uri, "bob", "1234", bobContact, 3600, 3600));
+        Thread.sleep(2000);
+        assertTrue(MonitoringServiceTool.getInstance().getRegisteredUsers(deploymentUrl.toString(),adminAccountSid, adminAuthToken)==1);
+
+        phone2.listenRequestMessage();
+        RequestEvent request = phone2.waitRequest(10000);
+        assertEquals(request.getRequest().getMethod(), SipRequest.OPTIONS);
+
+        ArrayList<Header> additionalHeader = new ArrayList<Header>();
+        Header reason = sipStack2.getHeaderFactory().createReasonHeader("udp", 486, "Busy Here");
+        additionalHeader.add(reason);
+
+        phone2.sendReply(request, 486, "Busy Here", null, null, 3600);
+        Thread.sleep(1000);
+        assertTrue(MonitoringServiceTool.getInstance().getRegisteredUsers(deploymentUrl.toString(),adminAccountSid, adminAuthToken)==1);
+        //Dispose phone. Restcomm will fail to send the OPTIONS message and should remove the registration
+        sipStack2.dispose();
+        phone2 = null;
+        sipStack2 = null;
+        // need a higher timeout to cope with SIP OPTIONS transaction timeout
+        Thread.sleep(65000);
+        assertTrue(MonitoringServiceTool.getInstance().getRegisteredUsers(deploymentUrl.toString(),adminAccountSid, adminAuthToken)==0);
+    }
+
+    
     /**
      * registerUserAgentWithAtTheRateSignInLogin
      * we should be able to register and remove registration on non-response to options