ProxySipServlet.java

/*
 * 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.servlet.sip.testsuite;

import java.io.IOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.util.ArrayList;
import java.util.List;

import javax.servlet.Servlet;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.sip.Address;
import javax.servlet.sip.Proxy;
import javax.servlet.sip.SipErrorEvent;
import javax.servlet.sip.SipErrorListener;
import javax.servlet.sip.SipFactory;
import javax.servlet.sip.SipServlet;
import javax.servlet.sip.SipServletRequest;
import javax.servlet.sip.SipServletResponse;
import javax.servlet.sip.SipURI;
import javax.servlet.sip.URI;

import org.apache.log4j.Logger;

public class ProxySipServlet extends SipServlet implements SipErrorListener {
	private static final long serialVersionUID = 1L;
	private static transient Logger logger = Logger.getLogger(ProxySipServlet.class);
	
	private static String USE_HOSTNAME = "useHostName";
	private static String CHECK_URI = "check_uri";
	private static String NON_RECORD_ROUTING = "nonRecordRouting";

	@Override
	public void init(ServletConfig servletConfig) throws ServletException {
		logger.info("the proxy sip servlet has been started");
		super.init(servletConfig);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected void doInvite(SipServletRequest request) throws ServletException,
			IOException {

		if(!request.isInitial()){
			return;
		}
			
		logger.info("Got request:\n"
				+ request.getMethod());		
		//This is a proxying sample.
		SipFactory sipFactory = (SipFactory) getServletContext().getAttribute(SIP_FACTORY);

		String host = "127.0.0.1";
		SipURI fromURI = ((SipURI)request.getFrom().getURI());
		if(USE_HOSTNAME.equals(fromURI.getUser())) {		
			host = "localhost";
			logger.info("using Host Name for proxy test");
		}

		URI uri1 = sipFactory.createAddress("sip:receiver@" + host + ":5057").getURI();		
		URI uri2 = sipFactory.createAddress("sip:cutme@" + host + ":5056").getURI();
		URI uri3 = sipFactory.createAddress("sip:nonexist@" + host + ":5856").getURI();

		if(request.getFrom().getURI().toString().contains("sequential")) {
			Proxy proxy = request.getProxy();
			proxy.setParallel(false);
			proxy.setProxyTimeout(5);
			proxy.setRecordRoute(true);
			ArrayList<URI> uris = new ArrayList<URI>();
			if(request.getFrom().getURI().toString().contains("sequential-reverse")) {
				uris.add(uri1);
				if(!request.getFrom().getURI().toString().contains("sequential-reverse-one")) {
					uris.add(uri2);
				}
			} else if(request.getFrom().getURI().toString().contains("sequential-three")) {
				uris.add(uri3);
				uris.add(uri2);
				uris.add(uri1);
			} else {
				uris.add(uri2);
				uris.add(uri1);
			}

			proxy.proxyTo(uris);
		} else {
			ArrayList<URI> uris = new ArrayList<URI>();
			uris.add(uri1);
			if(!fromURI.getUser().equals("unique-location")) {
				uris.add(uri2);
			}
			Proxy proxy = request.getProxy();
			List<SipURI> outboundInterfaces = (List<SipURI>)getServletContext().getAttribute(OUTBOUND_INTERFACES);

			if(outboundInterfaces == null) throw new NullPointerException("Outbound interfaces should not be null");

			SipURI obi = null;

			for(SipURI uri:outboundInterfaces) {
				if(uri.toString().indexOf("127.0.0.1")>0) {
					// pick the lo interface, since its universal on all machines
					proxy.setOutboundInterface(new InetSocketAddress(InetAddress.getByName(uri.getHost()),uri.getPort()));
					obi = uri;
					break;
				}
			}

			if(obi == null) throw new NullPointerException("No loopback interface found.");

			boolean recordRoute = true;
			if(NON_RECORD_ROUTING.equals(fromURI.getUser())) {		
				recordRoute = false;
				logger.info("not record routing");
			}
			//proxy.setOutboundInterface((SipURI)sipFactory.createAddress("sip:proxy@127.0.0.1:5070").getURI());
			proxy.setRecordRoute(recordRoute);
			proxy.setSupervised(true);
			if(recordRoute) {
				proxy.getRecordRouteURI().setParameter("testparamname", "TESTVALUE");
			}		
			proxy.setParallel(true);
			if(CHECK_URI.equals(fromURI.getUser())) {
				Address routeAddress = sipFactory.createAddress("sip:127.0.0.1:5057");
				request.pushRoute(routeAddress);
				Address ra = request.getAddressHeader("Route");
				logger.info("doInvite: ra = " + ra);
				URI uri = ra.getURI(); // this causes NPE
				logger.info("doInvite: uri = " + uri);
				proxy.setParallel(false);
			}
			proxy.setProxyTimeout(4);
			proxy.proxyTo(uris);
		}
	}

	/**
	 * {@inheritDoc}
	 */
	protected void doBye(SipServletRequest request) throws ServletException,
			IOException {

		logger.info("Got BYE request:\n" + request);
		SipServletResponse sipServletResponse = request.createResponse(200);
		
		// If the branchResponse callback was called we are good otherwise fail by
		// not delivering OK to BYE
		String doBranchRespValue = (String) request.getApplicationSession().getAttribute("branchResponseReceived");
		if("true".equals(doBranchRespValue))
			sipServletResponse.send();
	}

	/**
	 * {@inheritDoc}
	 */
	protected void doResponse(SipServletResponse response)
			throws ServletException, IOException {

		logger.info("Got response: " + response);
		logger.info("Sip Session is :" + response.getSession(false));
		if(!"PRACK".equals(response.getMethod()) && response.getProxy() != null && response.getProxy().getOriginalRequest() != null) {
			logger.info("Original Sip Session is :" + response.getProxy().getOriginalRequest().getSession(false));
		}
		super.doResponse(response);
	}
	
	@Override
	protected void doBranchResponse(SipServletResponse resp)
			throws ServletException, IOException {
		logger.info("doBranchResponse callback was called.");		
		resp.getApplicationSession().setAttribute("branchResponseReceived", "true");
		super.doBranchResponse(resp);
	}	
	
	// SipErrorListener methods

	/**
	 * {@inheritDoc}
	 */
	public void noAckReceived(SipErrorEvent ee) {
		logger.error("noAckReceived.");
	}

	/**
	 * {@inheritDoc}
	 */
	public void noPrackReceived(SipErrorEvent ee) {
		logger.error("noPrackReceived.");
	}
	
    @Override
    protected void doSubscribe(SipServletRequest req) throws ServletException, IOException 
    {
        SipURI uri = (SipURI)req.getRequestURI().clone();
        uri.setPort(5057);
        req.pushRoute(uri);
        req.getProxy(true).proxyTo(req.getRequestURI());
    }

    @Override
    protected void doPublish(SipServletRequest req) throws ServletException, IOException 
    {
        SipURI uri = (SipURI)req.getRequestURI().clone();
        uri.setPort(5057);
        req.pushRoute(uri);
        req.getProxy(true).proxyTo(req.getRequestURI());
    }
	
    @Override
    protected void doCancel(SipServletRequest req) throws ServletException,
    		IOException {
    	logger.error("CANCEL seen at proxy " + req);
    }

}