Revision: 15706
Author: [email protected]
Date: Fri Dec 10 08:22:25 2010
Log: Update Issue 2066

Committing fix + non regression test
http://code.google.com/p/mobicents/source/detail?r=15706

Added:
/trunk/servers/sip-servlets/sip-servlets-client/src/main/java/org/mobicents/javax/servlet/sip/SipServletRequestExt.java
Modified:
 /trunk/servers/sip-servlets/sip-servlets-client/.classpath
/trunk/servers/sip-servlets/sip-servlets-impl/src/main/java/org/mobicents/servlet/sip/message/SipServletRequestImpl.java /trunk/servers/sip-servlets/sip-servlets-impl/src/main/java/org/mobicents/servlet/sip/message/SipServletResponseImpl.java /trunk/servers/sip-servlets/sip-servlets-test-suite/applications/shootist-sip-servlet/src/main/java/org/mobicents/servlet/sip/testsuite/ShootistSipServlet.java /trunk/servers/sip-servlets/sip-servlets-test-suite/testsuite/src/test/java/org/mobicents/servlet/sip/testsuite/reinvite/UACReInviteSipServletTest.java

=======================================
--- /dev/null
+++ /trunk/servers/sip-servlets/sip-servlets-client/src/main/java/org/mobicents/javax/servlet/sip/SipServletRequestExt.java Fri Dec 10 08:22:25 2010
@@ -0,0 +1,54 @@
+/*
+ * JBoss, Home of Professional Open Source
+ * Copyright 2008, Red Hat Middleware LLC, and individual contributors
+ * by the @authors tag. See the copyright.txt in the distribution for a
+ * full listing of individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+package org.mobicents.javax.servlet.sip;
+
+import javax.servlet.sip.SipServletRequest;
+import javax.servlet.sip.SipServletResponse;
+
+
+/**
+ * Interface Extension that adds extra features to the JSR 289 SipServetRequest interface.</br>
+ * It adds the following capabilities :
+ *
+ * <ul>
+ *             <li>
+ * Allows for applications to copy the record route headers on the responses to subsequent INVITE requests + * where the dialog route set shouldn't normally be changed to cope with non compliant RFC 3261 servers.
+ *             </li>
+ * </ul>
+ *
+ * @author [email protected]
+ * @since 1.5
+ */
+public interface SipServletRequestExt extends SipServletRequest {
+       /**
+ * Creates a response for this request with the specified status code and reason phrase.
+        * @param statusCode the status code for the response
+        * @param reasonPhrase reason phrase to appear in response line
+ * @param copyRecordRouteHeaders whether or not to copy the record route headers on the response to a subsequent INVITE request + * @return response object with specified status code and reason phrase and eventually the record route from the request copied in the response
+        *
+ * @throws IllegalArgumentException if the statuscode is not a valid SIP status code + * @throws IllegalStateException if this request has already been responded to with a final status code
+        */
+ SipServletResponse createResponse(int statusCode, String reasonPhrase, boolean copyRecordRouteHeaders);
+}
=======================================
--- /trunk/servers/sip-servlets/sip-servlets-client/.classpath Wed Aug 18 10:06:37 2010 +++ /trunk/servers/sip-servlets/sip-servlets-client/.classpath Fri Dec 10 08:22:25 2010
@@ -5,5 +5,6 @@
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/> <classpathentry combineaccessrules="false" kind="src" path="/sip-servlets-spec"/> <classpathentry kind="var" path="M2_REPO/log4j/log4j/1.2.14/log4j-1.2.14.jar"/> + <classpathentry kind="var" path="M2_REPO/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar"/>
        <classpathentry kind="output" path="target/classes"/>
 </classpath>
=======================================
--- /trunk/servers/sip-servlets/sip-servlets-impl/src/main/java/org/mobicents/servlet/sip/message/SipServletRequestImpl.java Thu Dec 9 08:01:47 2010 +++ /trunk/servers/sip-servlets/sip-servlets-impl/src/main/java/org/mobicents/servlet/sip/message/SipServletRequestImpl.java Fri Dec 10 08:22:25 2010
@@ -82,6 +82,7 @@
 import javax.sip.message.Response;

 import org.apache.log4j.Logger;
+import org.mobicents.javax.servlet.sip.SipServletRequestExt;
 import org.mobicents.servlet.sip.JainSipUtils;
 import org.mobicents.servlet.sip.SipConnector;
 import org.mobicents.servlet.sip.SipFactories;
@@ -108,7 +109,7 @@
 import org.mobicents.servlet.sip.startup.loading.SipServletImpl;

 public class SipServletRequestImpl extends SipServletMessageImpl implements
-               SipServletRequest {
+               SipServletRequestExt {

        public static final String STALE = "stale";

@@ -255,14 +256,26 @@
         * @see javax.servlet.sip.SipServletRequest#createResponse(int)
         */
        public SipServletResponse createResponse(int statusCode) {
-               return createResponse(statusCode, null);
+               return createResponse(statusCode, null, false, true);
        }

+       /*
+        * (non-Javadoc)
+ * @see javax.servlet.sip.SipServletRequest#createResponse(int, java.lang.String)
+        */
public SipServletResponse createResponse(final int statusCode, final String reasonPhrase) {
-               return createResponse(statusCode, reasonPhrase, true);
-       }
-
- public SipServletResponse createResponse(final int statusCode, final String reasonPhrase, boolean validate) {
+               return createResponse(statusCode, reasonPhrase, false, true);
+       }
+
+       /*
+        * (non-Javadoc)
+ * @see org.mobicents.javax.servlet.sip.SipServletRequestExt#createResponse(int, java.lang.String, boolean)
+        */
+ public SipServletResponse createResponse(final int statusCode, final String reasonPhrase, boolean copyRecordRouteHeaders) { + return createResponse(statusCode, reasonPhrase, copyRecordRouteHeaders, true);
+       }
+
+ public SipServletResponse createResponse(final int statusCode, final String reasonPhrase, boolean copyRecordRouteHeaders, boolean validate) {
                checkReadOnly();
                final Transaction transaction = getTransaction();
                if(RoutingState.CANCELLED.equals(routingState)) {
@@ -360,6 +373,16 @@
// RouteHeader routeHeader = SipFactories.headerFactory.createRouteHeader(recordRouteHeader.getAddress());
 //                             response.addHeader(routeHeader);
 //                     }
+
+ if(copyRecordRouteHeaders && !isInitial() && requestMethod.equals(Request.INVITE)) { + // Miss Record-Route in Response for non compliant Server in reINVITE http://code.google.com/p/mobicents/issues/detail?id=2066 + final ListIterator<RecordRouteHeader> recordRouteHeaders = request.getHeaders(RecordRouteHeader.NAME);
+                               while (recordRouteHeaders.hasNext()) {
+ RecordRouteHeader recordRouteHeader = (RecordRouteHeader) recordRouteHeaders
+                                                       .next();
+                                       response.addHeader(recordRouteHeader);
+                               }
+                       }

final SipServletResponseImpl newSipServletResponse = new SipServletResponseImpl(response, super.sipFactoryImpl, validate ? (ServerTransaction) transaction : transaction, session, getDialog(), false, false);
=======================================
--- /trunk/servers/sip-servlets/sip-servlets-impl/src/main/java/org/mobicents/servlet/sip/message/SipServletResponseImpl.java Tue Dec 7 08:16:00 2010 +++ /trunk/servers/sip-servlets/sip-servlets-impl/src/main/java/org/mobicents/servlet/sip/message/SipServletResponseImpl.java Fri Dec 10 08:22:25 2010
@@ -17,7 +17,6 @@
 package org.mobicents.servlet.sip.message;

 import gov.nist.javax.sip.DialogExt;
-import gov.nist.javax.sip.message.ResponseExt;
 import gov.nist.javax.sip.stack.SIPClientTransaction;
 import gov.nist.javax.sip.stack.SIPTransaction;

=======================================
--- /trunk/servers/sip-servlets/sip-servlets-test-suite/applications/shootist-sip-servlet/src/main/java/org/mobicents/servlet/sip/testsuite/ShootistSipServlet.java Tue Aug 3 06:22:04 2010 +++ /trunk/servers/sip-servlets/sip-servlets-test-suite/applications/shootist-sip-servlet/src/main/java/org/mobicents/servlet/sip/testsuite/ShootistSipServlet.java Fri Dec 10 08:22:25 2010
@@ -45,6 +45,7 @@
 import javax.sip.ListeningPoint;

 import org.apache.log4j.Logger;
+import org.mobicents.javax.servlet.sip.SipServletRequestExt;
 import org.mobicents.javax.servlet.sip.SipSessionExt;

 public class ShootistSipServlet
@@ -139,9 +140,17 @@
                        IOException {
                String requestURIStringified = req.getRequestURI().toString();
                logger.info(requestURIStringified);
+               
if(req.getTo().getURI().toString().contains("nonrecordrouteeinvite"))  {
+                       req.createResponse(200).send();
+                       return;
+               }
+               
if(req.getTo().getURI().toString().contains("recordrouteeinvite"))  {
+                       ((SipServletRequestExt) req).createResponse(200, null, 
true).send();
+                       return;
+               }
if(!requestURIStringified.startsWith("sip:[email protected];org.mobicents.servlet.sip.ApplicationSessionKey=%28") && !requestURIStringified.endsWith("%3Aorg.mobicents.servlet.sip.testsuite.ShootistApplication%29")) { req.createResponse(500, "SipURI.toString() does not escape charachters according to RFC2396.").send();
-               }
+               }
if(((SipURI)req.getFrom().getURI()).getUser().equalsIgnoreCase(ENCODE_URI)) {
                        if(req.getApplicationSession().getAttribute(ENCODE_URI) 
!= null) {
                                req.createResponse(200).send();
@@ -150,7 +159,7 @@
                        }
                } else {
req.createResponse(500, "received a request using the encodeURI mechanism but not the same sip application session").send();
-               }
+               }
        }

        @Override
=======================================
--- /trunk/servers/sip-servlets/sip-servlets-test-suite/testsuite/src/test/java/org/mobicents/servlet/sip/testsuite/reinvite/UACReInviteSipServletTest.java Thu Oct 28 13:12:24 2010 +++ /trunk/servers/sip-servlets/sip-servlets-test-suite/testsuite/src/test/java/org/mobicents/servlet/sip/testsuite/reinvite/UACReInviteSipServletTest.java Fri Dec 10 08:22:25 2010
@@ -15,7 +15,17 @@
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  */
 package org.mobicents.servlet.sip.testsuite.reinvite;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.ListIterator;
+import java.util.Map;
+import java.util.Map.Entry;
+
 import javax.sip.SipProvider;
+import javax.sip.header.Header;
+import javax.sip.header.RecordRouteHeader;
+import javax.sip.message.Response;

 import org.apache.catalina.deploy.ApplicationParameter;
 import org.apache.log4j.Logger;
@@ -57,6 +67,23 @@
                context.addApplicationParameter(applicationParameter);
                assertTrue(tomcat.deployContext(context));
        }
+
+       public SipStandardContext deployApplication(Map<String, String> params) 
{
+               SipStandardContext context = new SipStandardContext();
+ context.setDocBase(projectHome + "/sip-servlets-test-suite/applications/shootist-sip-servlet/src/main/sipapp");
+               context.setName("sip-test-context");
+               context.setPath("sip-test");
+               context.addLifecycleListener(new SipContextConfig());
+               context.setManager(new SipStandardManager());
+               for (Entry<String, String> param : params.entrySet()) {
+                       ApplicationParameter applicationParameter = new 
ApplicationParameter();
+                       applicationParameter.setName(param.getKey());
+                       applicationParameter.setValue(param.getValue());
+                       context.addApplicationParameter(applicationParameter);
+               }
+               assertTrue(tomcat.deployContext(context));
+               return context;
+       }

        @Override
        protected String getDarConfigurationFile() {
@@ -85,6 +112,80 @@
                Thread.sleep(TIMEOUT);
                assertTrue(receiver.getByeReceived());
        }
+
+       /**
+        * Non Regression test for
+        * http://code.google.com/p/mobicents/issues/detail?id=2066
+        * Miss Record-Route in Response
+        */
+       public void testShootistReInviteRecordRouteHeaders() throws Exception {
+//             receiver.sendInvite();
+               receiverProtocolObjects =new ProtocolObjects(
+ "recordrouteeinvite", "gov.nist", TRANSPORT, AUTODIALOG, null, null, null);
+
+ receiver = new TestSipListener(5080, 5070, receiverProtocolObjects, false);
+               receiver.setRecordRoutingProxyTesting(true);
+               SipProvider senderProvider = receiver.createProvider();
+
+               senderProvider.addSipListener(receiver);
+
+               receiverProtocolObjects.start();
+               tomcat.startTomcat();
+               Map<String, String> params = new HashMap<String, String>();
+               params.put("username", "recordrouteeinvite");
+               params.put("timeToWaitForBye", "15000");
+               deployApplication(params);
+               Thread.sleep(TIMEOUT);
+               assertTrue(receiver.isAckReceived());
+
+               List<Header> headers = new ArrayList<Header>();
+ headers.add(receiverProtocolObjects.headerFactory.createHeader(RecordRouteHeader.NAME, "sip:127.0.0.1:5080")); + receiver.sendInDialogSipRequest("INVITE", null, null, null, headers, null);
+               Thread.sleep(TIMEOUT);
+
+               Response reinviteOKResponse = receiver.getInviteOkResponse();
+ ListIterator<Header> recordRouteHeaders = reinviteOKResponse.getHeaders(RecordRouteHeader.NAME);
+               assertTrue(recordRouteHeaders.hasNext());
+
+               assertTrue(receiver.getByeReceived());
+       }
+
+       /**
+        * Non Regression test for
+        * http://code.google.com/p/mobicents/issues/detail?id=2066
+        * Miss Record-Route in Response
+        */
+       public void testShootistReInviteNonRecordRouteHeaders() throws 
Exception {
+//             receiver.sendInvite();
+               receiverProtocolObjects =new ProtocolObjects(
+ "recordrouteeinvite", "gov.nist", TRANSPORT, AUTODIALOG, null, null, null);
+
+ receiver = new TestSipListener(5080, 5070, receiverProtocolObjects, false);
+               receiver.setRecordRoutingProxyTesting(true);
+               SipProvider senderProvider = receiver.createProvider();
+
+               senderProvider.addSipListener(receiver);
+
+               receiverProtocolObjects.start();
+               tomcat.startTomcat();
+               Map<String, String> params = new HashMap<String, String>();
+               params.put("username", "nonrecordrouteeinvite");
+               params.put("timeToWaitForBye", "15000");
+               deployApplication(params);
+               Thread.sleep(TIMEOUT);
+               assertTrue(receiver.isAckReceived());
+
+               List<Header> headers = new ArrayList<Header>();
+ headers.add(receiverProtocolObjects.headerFactory.createHeader(RecordRouteHeader.NAME, "sip:127.0.0.1:5080")); + receiver.sendInDialogSipRequest("INVITE", null, null, null, headers, null);
+               Thread.sleep(TIMEOUT);
+
+               Response reinviteOKResponse = receiver.getInviteOkResponse();
+ ListIterator<Header> recordRouteHeaders = reinviteOKResponse.getHeaders(RecordRouteHeader.NAME);
+               assertFalse(recordRouteHeaders.hasNext());
+
+               assertTrue(receiver.getByeReceived());
+       }

        @Override
        protected void tearDown() throws Exception {

Reply via email to