callprocessing.java

jtapi for telephone

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2000 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact [e-mail].
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 * Large portions of this software are based upon public domain software
 * https://sip-communicator.dev.java.net/
 *
 */
package net.sourceforge.gjtapi.raw.sipprovider.sip;

import net.sourceforge.gjtapi.raw.sipprovider.common.Console;
import net.sourceforge.gjtapi.raw.sipprovider.common.Utils;
import java.text.*;
import java.util.*;
import javax.sip.*;
import javax.sip.address.*;
import javax.sip.header.*;
import javax.sip.message.*;
import net.sourceforge.gjtapi.raw.sipprovider.sip.security.SipSecurityException;

/**
 * <p>Title: SIP COMMUNICATOR-1.1</p>
 * <p>Description: JAIN-SIP-1.1 Audio/Video Phone Application</p>
 * <p>Copyright: Copyright (c) 2003</p>
 * <p>Company: Organisation: LSIIT Laboratory (http://lsiit.u-strasbg.fr)<p>
 * </p>Network Research Team (http://www-r2.u-strasbg.fr))<p>
 * </p>Louis Pasteur University - Strasbourg - France</p>
 * @author Emil Ivov
 * @version 1.1
 */
public class CallProcessing
{
    protected static final Console console = Console.getConsole(CallProcessing.class);
    protected SipManager sipManCallback = null;
    protected CallDispatcher callDispatcher = new CallDispatcher();
    CallProcessing()
    {
        try {
            console.logEntry();
        }
        finally {
            console.logExit();
        }
    }

    public CallProcessing(SipManager sipManCallback)
    {
        this.sipManCallback = sipManCallback;
    }

    void setSipManagerCallBack(SipManager sipManCallback)
    {
        this.sipManCallback = sipManCallback;
    }

//============================= Remotely Initiated Processing ===================================
    //----------------------------- Responses
    public void processTrying(ClientTransaction clientTransaction, Response response)
    {
        try {
            console.logEntry();

            //find the call
            Call call = callDispatcher.findCall(clientTransaction.
                                                getDialog());
            if (call == null) {
                sipManCallback.fireUnknownMessageReceived(response);
                return;
            }
            //change status
            if (!call.getState().equals(Call.MOVING_LOCALLY))
                call.setState(Call.DIALING);
        }
        finally {
            console.logExit();
        }
    }

    public void processRinging(ClientTransaction clientTransaction, Response response)
    {
        try
        {
            console.logEntry();

            //find the call
            Call call = callDispatcher.findCall(clientTransaction.
                                                getDialog());
            if (call == null) {
                //?maybe we should just ignore it?
                sipManCallback.fireUnknownMessageReceived(response);
                return;
            }
            //change status
            call.setState(Call.RINGING);
        }
        finally
        {
            console.logExit();
        }
    }

    /**
     * According to the RFC  a
     * UAC canceling a request cannot rely on receiving a 487 (Request
     * Terminated) response for the original request, as an RFC 2543-
     * compliant UAS will not generate such a response. So we are closing the
     * call when sending the cancel request and here we don't do anything.
     * @param clientTransaction
     * @param response
     */
    public void processRequestTerminated(ClientTransaction clientTransaction,
                                  Response response)
    {
        try
        {
            console.logEntry();

            //add any additional code here
        }
        finally
        {
            console.logExit();
        }
    }

    public void processByeOK(ClientTransaction clientTransaction, Response response)
    {
        try {
            console.logEntry();

            //add any additional code here
        }
        finally {
            console.logExit();
        }
    }

    public void processCancelOK(ClientTransaction clientTransaction, Response response)
    {
        try
        {
            console.logEntry();

            //add any additional code here
        }
        finally
        {
            console.logExit();
        }
    }

    public void processInviteOK(ClientTransaction clientTransaction, Response ok)
    {
        try
        {
            console.logEntry();

            //find the call
            Call call = callDispatcher.findCall(clientTransaction.
                                                getDialog());
            if (call == null) {
                sipManCallback.fireUnknownMessageReceived(ok);
                return;
            }
            //Send ACK
            try {
                //Need to use dialog generated ACKs so that the remote UA core
                //sees them - Fixed by M.Ranganathan
                Request ack = (Request) clientTransaction.getDialog().
                    createRequest(Request.ACK);
                clientTransaction.getDialog().sendAck(ack);
            }
            catch (SipException ex) {
                console.error("Failed to acknowledge call!", ex);
                call.setState(Call.DISCONNECTED);
                sipManCallback.fireCommunicationsError(
                    new CommunicationsException(
                    "Failed to acknowledge call!"
                    , ex)
                    );
                return;
            }
            // !!! set sdp content before setting call state as that is where
            //listeners get alerted and they need the sdp
            call.setRemoteSdpDescription(new String(ok.getRawContent()));
            //change status
            if (!call.getState().equals(Call.CONNECTED)) {
                call.setState(Call.CONNECTED);
            }
        }
        finally
        {
            console.logExit();
        }

    }

    public void processBusyHere(ClientTransaction clientTransaction, Response busyHere)
    {
        try
        {
            console.logEntry();

            //find the call
            Call call = callDispatcher.findCall(clientTransaction.
                                                getDialog());
            if (call == null) {
                sipManCallback.fireUnknownMessageReceived(busyHere);
                return;
            }
            //change status
            call.setState(Call.BUSY);
            //it is the stack that should be sending the ACK so don't do it here
        }
        finally
        {
            console.logExit();
        }


    }

    public void processCallError(ClientTransaction clientTransaction, Response notAcceptable)
    {
        try
        {
            console.logEntry();

            if(console.isDebugEnabled())
            {
            	console.debug("Processing CALL ERROR response:\n" + notAcceptable);
            }
            //find the call
            Call call = callDispatcher.findCall(clientTransaction.
                                                getDialog());
            if (call == null) {
                sipManCallback.fireUnknownMessageReceived(notAcceptable);
                return;
            }
            //change status
            call.setState(Call.FAILED);
                sipManCallback.fireCommunicationsError(
                            new CommunicationsException(
                            "Remote party returned error response: " + notAcceptable.getStatusCode()
                            +" - " + notAcceptable.getReasonPhrase()
                        )
                    );
                return;

            //it is the stack that should be sending the ACK so don't do it here

        }
        finally
        {
            console.logExit();
        }


    }


    /**
     * Attempts to re-ogenerate the corresponding request with the proper
     * credentials and terminates the call if it fails.
     *
     * @param clientTransaction the corresponding transaction
     * @param response the challenge
     */
    public void processAuthenticationChallenge(ClientTransaction clientTransaction,
                                        Response response)
    {
        try {
            console.logEntry();

            Request challengedRequest = clientTransaction.getRequest();