JSR-043: JTAPI-1.4

javax.telephony
Interface TerminalConnectionListener

All Superinterfaces:
CallListener, ConnectionListener, java.util.EventListener
All Known Subinterfaces:
CallControlTerminalConnectionListener

public interface TerminalConnectionListener
extends ConnectionListener

This interface is an extension of the ConnectionListener interface, and reports state changes of the Call, its Connections and its TerminalConnections.

Introduction

As is true for the CallListener interface, specific TerminalConnection object state changes are reported to specific corresponding TerminalConnectionListener methods. The eventID carried by the event (a TerminalConnectionEvent) corresponds to the method called, and indicates which specific state change occurred.

Adding a Listener to a Call

Applications may add a TerminalConnectionListener to a Call via one of several mechanisms. They may directly add a TerminalConnectionListener by specifying an object which implements that interface, as an argument to the Call.addCallListener() method. Applications may also add a TerminalConnectionListener to Calls indirectly by passing this listener object to either the Address.addCallListener() or Terminal.addCallListener() methods. These methods add the given listener to the Call when the Call comes to the Address or Terminal. See the specifications for Call, Address, and Terminal for more information.

Call State Changes and TerminalConnection Events

In the core package, an event is delivered whenever the Call changes state. An event is delivered to a method of this interface specifically when a TerminalConnection object changes state. The method called, and the event ID reported, indicate the new TerminalConnection state. The methods in this interface are: terminalConnectionActive, terminalConnectionCreated, terminalConnectionDropped, terminalConnectionPassive, terminalConnectionRinging, and terminalConnectionUnknown.

TerminalConnection Events

All events pertaining to the TerminalConnection object are reported on this interface. TerminalConnection events implement the TerminalConnectionEvent interface, which in turn, extends the CallEvent interface. TerminalConnectionEvents have an event ID which identifies the new state of the affected TerminalConnection object. In the core package, an event is delivered to this interface whenever the TerminalConnection changes state.

See Also:
TerminalConnection, CallEvent, ConnectionEvent, TerminalConnectionEvent, MetaEvent, CallListener, ConnectionListener

Method Summary
 void terminalConnectionActive(TerminalConnectionEvent event)
          The terminalConnectionActive method is called to report that the state of the TerminalConnection object has changed to TerminalConnection.ACTIVE.
 void terminalConnectionCreated(TerminalConnectionEvent event)
          The terminalConnectionCreated method is called to report that a new TerminalConnection object has been created.
 void terminalConnectionDropped(TerminalConnectionEvent event)
          The terminalConnectionDropped method is called to report that the state of the TerminalConnection object has changed to TerminalConnection.DROPPED.
 void terminalConnectionPassive(TerminalConnectionEvent event)
          The terminalConnectionPassive method is called to report that the state of the TerminalConnection object has changed to TerminalConnection.PASSIVE.
 void terminalConnectionRinging(TerminalConnectionEvent event)
          The terminalConnectionRinging method is called to report that the state of the TerminalConnection object has changed to TerminalConnection.RINGING.
 void terminalConnectionUnknown(TerminalConnectionEvent event)
          The terminalConnectionUnknown method is called to report that the state of the TerminalConnection object has changed to TerminalConnection.UNKNOWN.
 
Methods inherited from interface javax.telephony.ConnectionListener
connectionAlerting, connectionConnected, connectionCreated, connectionDisconnected, connectionFailed, connectionInProgress, connectionUnknown
 
Methods inherited from interface javax.telephony.CallListener
callActive, callEventTransmissionEnded, callInvalid, multiCallMetaMergeEnded, multiCallMetaMergeStarted, multiCallMetaTransferEnded, multiCallMetaTransferStarted, singleCallMetaProgressEnded, singleCallMetaProgressStarted, singleCallMetaSnapshotEnded, singleCallMetaSnapshotStarted
 

Method Detail

terminalConnectionActive

public void terminalConnectionActive(TerminalConnectionEvent event)
The terminalConnectionActive method is called to report that the state of the TerminalConnection object has changed to TerminalConnection.ACTIVE.

Parameters:
event - A TerminalConnectionEvent with eventID TerminalConnection.ACTIVE.

terminalConnectionCreated

public void terminalConnectionCreated(TerminalConnectionEvent event)
The terminalConnectionCreated method is called to report that a new TerminalConnection object has been created.

Parameters:
event - A TerminalConnectionEvent with eventID TerminalConnection.IDLE.

terminalConnectionDropped

public void terminalConnectionDropped(TerminalConnectionEvent event)
The terminalConnectionDropped method is called to report that the state of the TerminalConnection object has changed to TerminalConnection.DROPPED.

Parameters:
event - A TerminalConnectionEvent with eventID TerminalConnection.DROPPED.

terminalConnectionPassive

public void terminalConnectionPassive(TerminalConnectionEvent event)
The terminalConnectionPassive method is called to report that the state of the TerminalConnection object has changed to TerminalConnection.PASSIVE.

Parameters:
event - A TerminalConnectionEvent with eventID TerminalConnection.PASSIVE.

terminalConnectionRinging

public void terminalConnectionRinging(TerminalConnectionEvent event)
The terminalConnectionRinging method is called to report that the state of the TerminalConnection object has changed to TerminalConnection.RINGING.

Parameters:
event - A TerminalConnectionEvent with eventID TerminalConnection.RINGING.

terminalConnectionUnknown

public void terminalConnectionUnknown(TerminalConnectionEvent event)
The terminalConnectionUnknown method is called to report that the state of the TerminalConnection object has changed to TerminalConnection.UNKNOWN.

Parameters:
event - A TerminalConnectionEvent with eventID terminalConnection.UNKNOWN.

JSR-043: JTAPI-1.4

Send comments to: JSR-43@ectf.org