org.mobicents.servlet.sip.proxy.ProxyTerminationInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sip-servlets-impl Show documentation
There is a newer version: 4.0.128
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. 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.servlet.sip.proxy;

import gov.nist.javax.sip.header.From;
import gov.nist.javax.sip.header.Route;
import gov.nist.javax.sip.header.To;
import gov.nist.javax.sip.message.SIPMessage;
import gov.nist.javax.sip.message.SIPRequest;
import gov.nist.javax.sip.message.SIPResponse;

import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.text.ParseException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.ListIterator;

import javax.servlet.sip.Address;
import javax.servlet.sip.ServletParseException;
import javax.servlet.sip.SipServletRequest;
import javax.servlet.sip.SipSession;
import javax.servlet.sip.SipURI;
import javax.sip.InvalidArgumentException;
import javax.sip.address.URI;
import javax.sip.header.ReasonHeader;
import javax.sip.header.RecordRouteHeader;
import javax.sip.header.RouteHeader;
import javax.sip.message.Request;

import org.apache.log4j.Logger;
import org.mobicents.servlet.sip.address.AddressImpl;
import org.mobicents.servlet.sip.core.session.MobicentsSipSession;
import org.mobicents.servlet.sip.message.SipFactoryImpl;
import org.mobicents.servlet.sip.message.SipServletRequestImpl;
import org.mobicents.servlet.sip.message.SipServletResponseImpl;

/**
 * PlaceHolder to store the information required to implement 3GPP TS 24.229 section 5.2.8.1.2. ie Termination of Session originating from the proxy.
 * @author Andrew Miller (Crocodile RCS)
 */
public class ProxyTerminationInfo implements Externalizable {
	
	private LinkedList calleeRouteSet; // Route set to reach callee from us.  
	private LinkedList callerRouteSet; // Route set to reach caller from us.

	private URI calleeContact; // Contact given by the callee in the final response to the initial INVITE  
	private URI callerContact; // Contact given by the caller in the initial INVITE

	private To toHeader;		   // To: header in the direction caller->callee
	private From fromHeader;       // From: header in the direction caller->callee
	private static final Logger logger = Logger.getLogger(ProxyTerminationInfo.class);
	private String callId;
	private boolean terminationSent; 
	
	private long callerCSeq; 	 // Last CSeq seen from caller
	private long calleeCSeq = 0; // Last CSeq seen from callee (We may never see one if the callee never sends a request)
	
	private ProxyImpl proxyImpl;
	
	// empty constructor used only for Externalizable interface
	public ProxyTerminationInfo() {
		callerRouteSet = new LinkedList();
		calleeRouteSet = new LinkedList();
	}
	
	public ProxyTerminationInfo(SipServletResponseImpl proxiedResponse, SipURI recordRouteURI, ProxyImpl proxyImpl) {
		if (proxyImpl == null)
			throw new NullPointerException("Null proxyImpl");
		if (proxiedResponse == null)
			throw new NullPointerException("Null message");
		this.proxyImpl = proxyImpl;
		SipServletRequest request = proxiedResponse.getRequest();
		SIPResponse nistResponse = (SIPResponse) ((SipServletResponseImpl) proxiedResponse).getResponse();
		SIPRequest nistRequest =  (SIPRequest) ((SipServletRequestImpl) request).getMessage(); 
		
		toHeader = (To) nistResponse.getTo();
		fromHeader = (From) nistResponse.getFrom();
		calleeContact = nistResponse.getContactHeader().getAddress().getURI();
		callerContact = nistRequest.getContactHeader().getAddress().getURI();
		
		calleeRouteSet = new LinkedList();
		callerRouteSet = new LinkedList();
		
		callId = proxiedResponse.getCallId();

		ListIterator i;
		try {
			i = proxiedResponse.getRequest().getAddressHeaders(RecordRouteHeader.NAME);
		} catch (ServletParseException e) {
			throw new IllegalArgumentException("Couldn't get the RecordRoute Headers from the request " + proxiedResponse.getRequest(), e);
		}
		while (i.hasNext()) {
			AddressImpl a = (AddressImpl) i.next();
			callerRouteSet.add(a.getAddress());
		}		

		try {		
			i = proxiedResponse.getAddressHeaders(RecordRouteHeader.NAME);
		} catch (ServletParseException e) {
			throw new IllegalArgumentException("Couldn't get the RecordRoute Headers from the response " + proxiedResponse, e);
		}
		while (i.hasNext()) { // loop through the record-routes until you reach us
			Address a = i.next();
			if (a.getURI().equals(recordRouteURI)) {
				i.previous();
				break;
			} 
		}
		while (i.hasPrevious()) { // Add the routes in reverse
			AddressImpl a = (AddressImpl) i.previous();
			calleeRouteSet.add(a.getAddress());
		}		
	}
	/*
	 * (non-Javadoc)
	 * @see java.io.Externalizable#readExternal(java.io.ObjectInput)
	 */
	public void readExternal(ObjectInput in) throws IOException,
			ClassNotFoundException {

		try {
			calleeCSeq = in.readLong();
			callerCSeq = in.readLong();
			calleeContact = SipFactoryImpl.addressFactory.createURI(in.readUTF());
			callerContact = SipFactoryImpl.addressFactory.createURI(in.readUTF());

			int routeSetSize = in.readInt();
			for (int i = 0; i < routeSetSize; i++) {
				javax.sip.address.Address route = SipFactoryImpl.addressFactory.createAddress(in.readUTF());
				callerRouteSet.add(route);
			} 

			routeSetSize = in.readInt();
			for (int i = 0; i < routeSetSize; i++) {
				javax.sip.address.Address route = SipFactoryImpl.addressFactory.createAddress(in.readUTF());
				calleeRouteSet.add(route);
			} 

			javax.sip.address.Address toAddress = SipFactoryImpl.addressFactory.createAddress(in.readUTF());
			toHeader = (To) SipFactoryImpl.headerFactory.createToHeader(toAddress, in.readUTF());

			javax.sip.address.Address fromAddress = SipFactoryImpl.addressFactory.createAddress(in.readUTF());
			fromHeader = (From) SipFactoryImpl.headerFactory.createFromHeader(fromAddress, in.readUTF());
			callId = in.readUTF();
		} catch (ParseException e) {
			throw new IllegalArgumentException("Problem occurred while unserializing ProxyTerminationInfo", e);
		}
	}
	/*
	 * (non-Javadoc)
	 * @see java.io.Externalizable#writeExternal(java.io.ObjectOutput)
	 */
	public void writeExternal(ObjectOutput out) throws IOException {

		out.writeLong(calleeCSeq);
		out.writeLong(callerCSeq);
		out.writeUTF(calleeContact.toString());
		out.writeUTF(callerContact.toString());

		out.writeInt(calleeRouteSet.size());
		Iterator i = calleeRouteSet.iterator();
    	while (i.hasNext()) {
    		javax.sip.address.Address a = i.next();
    		out.writeUTF(a.toString());
    	}

    	out.writeInt(callerRouteSet.size());
		i = callerRouteSet.iterator();
    	while (i.hasNext()) {
    		javax.sip.address.Address a = i.next();
    		out.writeUTF(a.toString());
    	}

    	out.writeUTF(toHeader.getAddress().toString());
    	out.writeUTF(toHeader.getTag());
    	out.writeUTF(fromHeader.getAddress().toString());
		out.writeUTF(fromHeader.getTag());
		out.writeUTF(callId);
	}

	public void setProxy(ProxyImpl proxyImpl) {
		this.proxyImpl = proxyImpl;
	}
	
	private void sendBye (final SipSession session, URI requestUri, To to, From from,
			  long cSeq, LinkedList routeSet,
			  int responseCode, String responseText) throws IOException {

		Request request;

		try {
			request = SipFactoryImpl.messageFactory.createRequest(requestUri, Request.BYE,
																proxyImpl.getSipFactoryImpl().getSipApplicationDispatcher().getCallId(null, callId),
																SipFactoryImpl.headerFactory.createCSeqHeader(cSeq, Request.BYE),
																from, to, new ArrayList(), 
																SipFactoryImpl.headerFactory.createMaxForwardsHeader(70));
		} catch (ParseException e1) {
			throw new IllegalArgumentException("Problem occurred while creating the Proxy BYE on session " + session + 
					" requestURI = " + requestUri + " From = " + from + " To = " + to + " cSeq " + cSeq + 
					" routeSet = " + routeSet, e1);
		} catch (InvalidArgumentException e1) {
			throw new IllegalArgumentException("Problem occurred while creating the Proxy BYE on session " + session + 
					" requestURI = " + requestUri + " From = " + from + " To = " + to + " cSeq " + cSeq + 
					" routeSet = " + routeSet, e1);
		}

		if ((responseText != null) && (responseCode > 299) && (responseCode < 700)) {
			ReasonHeader reason;
			try {
				reason = SipFactoryImpl.headerFactory.createReasonHeader("sip", responseCode, responseText);
				((SIPMessage)request).addHeader(reason);
			} catch (InvalidArgumentException e) {
				throw new IllegalArgumentException("Failed to build reason header " + responseCode + ":" + responseText);				
			} catch (ParseException e) {
				throw new IllegalArgumentException("Failed to build reason header " + responseCode + ":" + responseText);
			}

		}

		Iterator i = routeSet.iterator();
		while (i.hasNext()) {
			javax.sip.address.Address javaxAddress = i.next();
			RouteHeader routeHeader = new Route((gov.nist.javax.sip.address.AddressImpl) javaxAddress);
			request.addHeader(routeHeader);
		}

		SipServletRequestImpl sipServletRequest = (SipServletRequestImpl) proxyImpl.getSipFactoryImpl().getMobicentsSipServletMessageFactory().createSipServletRequest(request,
													(MobicentsSipSession) session, null, null, false);
		sipServletRequest.send();		
	}
	
	public void terminate(final SipSession session, 
						  final int calleeResponseCode, final String calleeResponseText,
						  final int callerResponseCode, final String callerResponseText) throws IOException {
		if(terminationSent) {
			throw new IllegalStateException("Proxy Termination Already Sent !");
		}
		sendBye (session, calleeContact, toHeader, fromHeader, callerCSeq + 1, calleeRouteSet, calleeResponseCode, calleeResponseText);
    	sendBye (session, callerContact, new To(fromHeader), new From(toHeader), calleeCSeq + 1, callerRouteSet, callerResponseCode, callerResponseText);
    	terminationSent = true;
	}

	/**
	 * @return the terminationSent
	 */
	public boolean isTerminationSent() {
		return terminationSent;
	}

	/**
	 * @return the callerCSeq
	 */
	public long getCallerCSeq() {
		return callerCSeq;
	}

	/**
	 * @param callerCSeq the callerCSeq to set
	 */
	public void setCallerCSeq(long callerCSeq) {
		this.callerCSeq = callerCSeq;
	}

	/**
	 * @return the calleeCSeq
	 */
	public long getCalleeCSeq() {
		return calleeCSeq;
	}

	/**
	 * @param calleeCSeq the calleeCSeq to set
	 */
	public void setCalleeCSeq(long calleeCSeq) {
		this.calleeCSeq = calleeCSeq;
	}
}