OpenScape
V3.2, Revision 044 20100322

com.siemens.symphonia.bcom.bcommon.external
Interface ConnectionListener

All Superinterfaces:
RegistrationListener
All Known Subinterfaces:
BComConnectionFSM, ConnectionListenerInternal, RoutingListener, ServerConnectionListener, ServerConnectionListenerExtended
All Known Implementing Classes:
BComConnectionFSMImpl, ConnectionAdapter, ConnectionAdapter, SynchronizedConnectionListener

public interface ConnectionListener
extends RegistrationListener

Notification of connection oriented events.

Call-back interface to be implemented. It provides notifications on changes in the communication graph and on changes of ConnectionState information in ComConnection objects.

All methods have for the second parameter a communication endpoint object ComEndpoint. This parameter specifies for which endpoint the event is deliviered. This is either a BComUser or a DeviceEndpoint.
A precondition for receiveing events on an endpoint is to have subscribed for. This can be done by the various subscription methods like BComUser.addConnectionListener(ConnectionListener), BCom.addConnectionListenerForUser(Set,ConnectionListener) or BCom.addConnectionListenerForDevice(Set,ConnectionListener).


Method Summary
 void onAlerting(ComConnection comConnection, ComEndpoint comEndpoint)
          State of ComConnection changed to ALERTING.
 void onBusy(ComConnection comConnection, ComEndpoint comEndpoint)
          State of ComConnection changed to BUSY.
 void onConnected(ComConnection comConnection, ComEndpoint comEndpoint)
          State of ComConnection changed to CONNECTED.
 void onDialtone(ComConnection comConnection, ComEndpoint comEndpoint)
          State of ComConnection changed to DIALTONE.
 void onDisplayInfoChanged(ComConnection comConnection, ComEndpoint comEndpoint)
          Display information has changed.
 void onFailed(ComConnection comConnection, ComEndpoint comEndpoint)
          State of ComConnection changed to FAILED.
 void onHeld(ComConnection comConnection, ComEndpoint comEndpoint)
          State of ComConnection changed to HELD.
 void onInitiated(ComConnection comConnection, ComEndpoint comEndpoint)
          State of ComConnection changed to INITIATED.
 void onMethodsPermittedChanged(ComConnection comConnection, ComEndpoint comEndpoint)
          Set of permitted requests has changed.
 void onMoved(ComConnection comConnection, ComEndpoint comEndpoint)
          A connection has been moved from one communication to another communication.
 void onNewCommunication(Communication communication, ComEndpoint comEndpoint)
          A new communication graph has been created.
 void onNewConnection(ComConnection comConnection, ComEndpoint comEndpoint)
          A new connection has been added to an existing communication.
 void onRingback(ComConnection comConnection, ComEndpoint comEndpoint)
          State of ComConnection changed to RINGBACK.
 void onTerminated(ComConnection comConnection, ComEndpoint comEndpoint)
          A connection has been terminated.
 void onTransferPending(ComConnection comConnection, ComEndpoint comEndpoint)
          State of ComConnection changed to TRANSFER_PENDING.
 
Methods inherited from interface com.siemens.symphonia.bcom.bcommon.external.RegistrationListener
onRegistrationComplete
 

Method Detail

onNewCommunication

void onNewCommunication(Communication communication,
                        ComEndpoint comEndpoint)
A new communication graph has been created.

It consists of one, and only one, Communication object and at least one ComConnection object. The ComSession object might be also a new object.

It is the first event send for a new communication and notifies of the creation of the objects (and their linkage).

Parameters:
communication - created Communication object.
comEndpoint - target of event notification.

onNewConnection

void onNewConnection(ComConnection comConnection,
                     ComEndpoint comEndpoint)
A new connection has been added to an existing communication.

I.e. a new ComConnection object has been created and linked to an already existing Communication object.

Parameters:
comConnection - created ComConnection object.
comEndpoint - target of event notification.

onDialtone

void onDialtone(ComConnection comConnection,
                ComEndpoint comEndpoint)
State of ComConnection changed to DIALTONE.

Parameters:
comConnection - connection whose state has been changed.
comEndpoint - target of event notification.

onInitiated

void onInitiated(ComConnection comConnection,
                 ComEndpoint comEndpoint)
State of ComConnection changed to INITIATED.

Parameters:
comConnection - connection whose state has been changed.
comEndpoint - target of event notification.

onRingback

void onRingback(ComConnection comConnection,
                ComEndpoint comEndpoint)
State of ComConnection changed to RINGBACK.

Parameters:
comConnection - connection whose state has been changed.
comEndpoint - target of event notification.

onAlerting

void onAlerting(ComConnection comConnection,
                ComEndpoint comEndpoint)
State of ComConnection changed to ALERTING.

Parameters:
comConnection - connection whose state has been changed.
comEndpoint - target of event notification.

onFailed

void onFailed(ComConnection comConnection,
              ComEndpoint comEndpoint)
State of ComConnection changed to FAILED.

After reception of this event the connection is no more usable for any requests. And the only event to be furthermore expected is onTerminated(ComConnection, ComEndpoint).

Parameters:
comConnection - connection whose state has been changed.
comEndpoint - target of event notification.

onBusy

void onBusy(ComConnection comConnection,
            ComEndpoint comEndpoint)
State of ComConnection changed to BUSY.

After reception of this event the connection is no more usable for any requests. And the only event to be furthermore expected is onTerminated(ComConnection, ComEndpoint).

Parameters:
comConnection - connection whose state has been changed.
comEndpoint - target of event notification.

onConnected

void onConnected(ComConnection comConnection,
                 ComEndpoint comEndpoint)
State of ComConnection changed to CONNECTED.

Parameters:
comConnection - connection whose state has been changed.
comEndpoint - target of event notification.

onHeld

void onHeld(ComConnection comConnection,
            ComEndpoint comEndpoint)
State of ComConnection changed to HELD.

Parameters:
comConnection - connection whose state has been changed.
comEndpoint - target of event notification.

onMoved

void onMoved(ComConnection comConnection,
             ComEndpoint comEndpoint)
A connection has been moved from one communication to another communication.

While transfering a communication or joining a conference two communications are merged together. For this purpose connections are move between these communications. This event indicates that a connection has been moved from one communication to another. No state change applies for this connection.

Parameters:
comConnection - moved ComConnection object.
comEndpoint - target of event notification.

onTransferPending

void onTransferPending(ComConnection comConnection,
                       ComEndpoint comEndpoint)
State of ComConnection changed to TRANSFER_PENDING.

Parameters:
comConnection - connection whose state has been changed.
comEndpoint - target of event notification.

onTerminated

void onTerminated(ComConnection comConnection,
                  ComEndpoint comEndpoint)
A connection has been terminated.

The ComConnection object will be released after return from the call-back method. No further access to the object is permitted after this.

Parameters:
comConnection - terminated ComConnection object.
comEndpoint - target of event notification.

onMethodsPermittedChanged

void onMethodsPermittedChanged(ComConnection comConnection,
                               ComEndpoint comEndpoint)
Set of permitted requests has changed.

For all requests there exists a method named can<name of request method> (e.g. canDrop()). This method allows to check wheter it is currently possible to invoke the corresponding method.
This event indicates that at least one of these permissions has changed, i.e. at least one of the can-methods returns another value.

Notes:

Parameters:
comConnection - ComConnection object whose set of permitted requests has been changed.
comEndpoint - target of event notification.

onDisplayInfoChanged

void onDisplayInfoChanged(ComConnection comConnection,
                          ComEndpoint comEndpoint)
Display information has changed.

The methods getDisplayName() and getDisplayNumber() may return another value.

Note:
The display information may also change because of a state change. Therefore it is necessary to check the display information also on state change events.

Parameters:
comConnection - ComConnection object whose display information has been changed.
comEndpoint - target of event notification.

OpenScape
V3.2, Revision 044 20100322

Copyright (c) 2007 Siemens Enterprise Communications, Germany
All rights reserved.

This software is the confidential and proprietary information of Siemens Enterprise Communications, Germany