calllistenerobserver.java

jtapi for telephone

/*
	Copyright (c) 2005 Serban Iordache 
	
	All rights reserved. 
	
	Permission is hereby granted, free of charge, to any person obtaining a 
	copy of this software and associated documentation files (the 
	"Software"), to deal in the Software without restriction, including 
	without limitation the rights to use, copy, modify, merge, publish, 
	distribute, and/or sell copies of the Software, and to permit persons 
	to whom the Software is furnished to do so, provided that the above 
	copyright notice(s) and this permission notice appear in all copies of 
	the Software and that both the above copyright notice(s) and this 
	permission notice appear in supporting documentation. 
	
	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
	OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
	MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT 
	OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
	HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL 
	INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING 
	FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, 
	NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION 
	WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 
	
	Except as contained in this notice, the name of a copyright holder 
	shall not be used in advertising or otherwise to promote the sale, use 
	or other dealings in this Software without prior written authorization 
	of the copyright holder.
*/
package net.sourceforge.gjtapi.test.tapi3;

import java.util.HashMap;
import java.util.Map;

import javax.swing.DefaultListModel;
import javax.telephony.Call;
import javax.telephony.Connection;
import javax.telephony.Event;
import javax.telephony.TerminalConnection;
import javax.telephony.TerminalConnectionEvent;
import javax.telephony.TerminalConnectionListener;
import javax.telephony.callcontrol.CallControlCallObserver;
import javax.telephony.callcontrol.CallControlTerminalConnection;
import javax.telephony.callcontrol.events.CallCtlTermConnBridgedEv;
import javax.telephony.callcontrol.events.CallCtlTermConnDroppedEv;
import javax.telephony.callcontrol.events.CallCtlTermConnHeldEv;
import javax.telephony.callcontrol.events.CallCtlTermConnInUseEv;
import javax.telephony.callcontrol.events.CallCtlTermConnRingingEv;
import javax.telephony.callcontrol.events.CallCtlTermConnTalkingEv;
import javax.telephony.callcontrol.events.CallCtlTermConnUnknownEv;
import javax.telephony.events.CallActiveEv;
import javax.telephony.events.CallEv;
import javax.telephony.events.CallInvalidEv;
import javax.telephony.events.CallObservationEndedEv;
import javax.telephony.events.ConnAlertingEv;
import javax.telephony.events.ConnConnectedEv;
import javax.telephony.events.ConnCreatedEv;
import javax.telephony.events.ConnDisconnectedEv;
import javax.telephony.events.ConnEv;
import javax.telephony.events.ConnFailedEv;
import javax.telephony.events.ConnInProgressEv;
import javax.telephony.events.ConnUnknownEv;
import javax.telephony.events.TermConnActiveEv;
import javax.telephony.events.TermConnCreatedEv;
import javax.telephony.events.TermConnDroppedEv;
import javax.telephony.events.TermConnEv;import javax.telephony.events.TermConnPassiveEv;
import javax.telephony.events.TermConnRingingEv;
import javax.telephony.events.TermConnUnknownEv;
import javax.telephony.privatedata.events.PrivateCallEv;

import net.sourceforge.gjtapi.events.GenPrivateCallEv;
import net.sourceforge.gjtapi.raw.tapi3.Tapi3PrivateData;

import org.apache.log4j.Logger;

public class CallListenerObserver extends DefaultListModel implements TerminalConnectionListener, CallControlCallObserver {
    private static final Logger logger = Logger.getLogger(CallListenerObserver.class);

    // Map of Tapi3PrivateData indexed by Call
    private Map callMap = new HashMap();
    
    public class Item {
        private final Connection connection;
        
        public Item(Connection connection) {
            if(connection == null) {
                throw new IllegalArgumentException("connection is null.");
            }
            this.connection = connection;
        }

        public Connection getConnection() {
            return connection;
        }

        public TerminalConnection getTerminalConnection() {
            TerminalConnection terminalConnection = null;
            TerminalConnection[] tc = connection.getTerminalConnections();
            if(tc != null && tc.length > 0) {
                if(tc.length > 1) {
                    logger.warn("Item: " + tc.length + "");
                }
                terminalConnection = tc[0];
            }
            return terminalConnection;
        }
        
        public Tapi3PrivateData getPrivateData() {
            Tapi3PrivateData privateData = null;
            Call call = connection.getCall();
            if(call != null) {
                privateData = (Tapi3PrivateData)callMap.get(call);
            }
            return privateData;
        }
        
        public String getCallName() {
            Tapi3PrivateData privateData = getPrivateData();
            if(privateData != null) {
                return privateData.getCalledName() + "(" + privateData.getCalledNumber() + ") " + 
    			"<-- " + privateData.getCallerName() + "(" + privateData.getCallerNumber() + ")";
            } else {
                return "???@" + connection.getAddress();
            }
        }
        
        public String toString() {
            TerminalConnection termConn = getTerminalConnection();
            final String stateName;
            if(termConn == null || termConn.getState() == TerminalConnection.UNKNOWN) {
                stateName = TapiUtil.getConnectionStateName(connection);
            } else {
                stateName = TapiUtil.getTerminalConnectionStateName(termConn);
            }
            String s = getCallName() + " - " + stateName;
            return s;
        }

        public boolean equals(Object obj) {
        	boolean eq = false;
            if(obj != null && obj instanceof Item) {
                Item item = (Item)obj;
                eq = (item.connection.getCall() == connection.getCall());
            }
            return eq;
        }
                
		public int hashCode() {
			return connection.getCall().hashCode();
		}
    };

    public void clear() {
        super.clear();
        callMap.clear();
    }
    
    public void update() {
    	logger.debug("CallMap: " + callMap);
        fireContentsChanged(this, 0, getSize());
    }

    public CallListenerObserver() {
    }
    
    private void updatePrivateData(Call call, Tapi3PrivateData privateData) {
        callMap.put(call, privateData);
        update();
    }
    
    private void updateConnection(Connection connection) {
        Item item = new Item(connection);
        logger.debug("Updating connection(" + connection + " - " + connection.getAddress() + " - " + connection.getCall() + ")");
        if(!contains(item)) {
            logger.debug("Calling addElement(" + connection + " - " + connection.getAddress() + " - " + connection.getCall() + ")");
            addElement(item);
        }
        TerminalConnection tc = item.getTerminalConnection();
        int state = CallControlTerminalConnection.UNKNOWN;
        if(tc != null) {
            state = TapiUtil.getTerminalConnectionState(tc);
        }
        if(state == CallControlTerminalConnection.TALKING) {
            synchronized(tc) {
                tc.notifyAll();
            }
        }
        update();
    }

    private void removeConnection(Connection connection) {
        Item item = new Item(connection);
        logger.debug("removeElement(" + connection + " - " + connection.getAddress() + " - " + connection.getCall() + ")");
//        boolean contained = callMap.containsKey(connection.getCall());
        removeElement(item);
        callMap.remove(connection.getCall());
        update();
    }

    
    /**
     * Convert the event cause string to a cause. Creation date: (2000-05-01
     * 9:58:39)
     * 
     * @author: Richard Deadman
     * @return English description of the cause
     * @param cause
     *            The Event cause id.
     */
    public String causeToString(int cause) {
        switch (cause) {
            case Event.CAUSE_CALL_CANCELLED: {
                return "Call cancelled";
            }
            case Event.CAUSE_DEST_NOT_OBTAINABLE: {
                return "Destination not obtainable";
            }
            case Event.CAUSE_INCOMPATIBLE_DESTINATION: {
                return "Incompatable destination";
            }
            case Event.CAUSE_LOCKOUT: {
                return "Lockout";
            }
            case Event.CAUSE_NETWORK_CONGESTION: {
                return "Network congestion";
            }
            case Event.CAUSE_NETWORK_NOT_OBTAINABLE: {
                return "Network not obtainable";
            }
            case Event.CAUSE_NEW_CALL: {
                return "New call";
            }
            case Event.CAUSE_NORMAL: {
                return "Normal";
            }
            case Event.CAUSE_RESOURCES_NOT_AVAILABLE: {
                return "Resource not available";
            }
            case Event.CAUSE_SNAPSHOT: {
                return "Snapshot";
            }
            case Event.CAUSE_UNKNOWN: {
                return "Unknown";
            }
        }
        return "Cause mapping error: " + cause;
    }

    
    /**
     * Describe myself
     * 
     * @return a string representation of myself
     */
    public String toString() {
        return "ListModel with call listener and observer.";
    }

    /**
     * callActive method comment.
     */
    public void callActive(javax.telephony.CallEvent event) {
        logger.debug("Active Call event with cause: " + this.causeToString(event.getCause()));
        update();