org.mobicents.mscontrol
Interface MsEndpoint

All Superinterfaces:

java.io.Serializable

public interface MsEndpoint
extends java.io.Serializable

Media Server contain endpoints on which the Call-Agent/Application can create, modify and delete connections in order to establish and control media sessions with other multimedia endpoints. MsEndpoint represents the Endpoint in media server. Once the MsConnection is created, application can get reference to MsEndpoint by calling MsConnection.getEndpoint().

Endpoints in media server is broadly divided in two categories 1) VirtualEndpoint for example Announcement Endpoint, IVR Endpoint, Packet Relay Endpoint etc and 2) PhysicalEndpoint like Fax line, DS0, TDM etc

Reference of MsEndpoint is useful to detect the events like DTMF or apply signal like Play Announcement on MsConnection or MsLink

Author:

Oleg Kulikov, amit.bhayani

Method Summary

void	addConnectionListener(MsConnectionListener listener) Register MsConnectionListener to listen for changes in MsConnection state handled by this Endpoint
void	addNotificationListener(MsNotificationListener listener) Register MsNotificationListener to listen for MsNotifyEvent which are fired due to events detected by Endpoints like DTMF.
void	execute(MsRequestedSignal[] signals, MsRequestedEvent[] events) Call this method to Generate event or request Signal on Endpoint directly.
void	execute(MsRequestedSignal[] signals, MsRequestedEvent[] events, MsConnection connection) Call this method to Generate event or request Signal on MsConnection in Endpoint.
void	execute(MsRequestedSignal[] signals, MsRequestedEvent[] events, MsLink link) Call this method to Generate event or request Signal on MsLink in Endpint
java.lang.String	getLocalName() Returns the fully qualified Endpoint Name
java.lang.String[]	getSupportedPackages() This method gives the array of Supported Packages for given Endpoint.
void	removeConnectionListener(MsConnectionListener listener) Removes the MsConnectionListener
void	removeNotificationListener(MsNotificationListener listener) Remove the NotificationListener

Method Detail

getLocalName

java.lang.String getLocalName()

Returns the fully qualified Endpoint Name

Returns:

The endpoint name specific to this MsEndpoint. For example 'media/trunk/IVR/enp-3'

execute

void execute(MsRequestedSignal[] signals,
             MsRequestedEvent[] events)

Call this method to Generate event or request Signal on Endpoint directly. Mainly used for Physical Endpoint.

Parameters:

signals - array of MsRequestedSignal to be applied on Endpoint

events - array of MsRequestedEvent to be detected on Endpoint

execute

void execute(MsRequestedSignal[] signals,
             MsRequestedEvent[] events,
             MsConnection connection)

Call this method to Generate event or request Signal on MsConnection in Endpoint.

Parameters:

signals - array of MsRequestedSignal to be applied on Endpoint

events - array of MsRequestedEvent to be detected on Endpoint

connection - MsConnection on which events/signals need to be applied

execute

void execute(MsRequestedSignal[] signals,
             MsRequestedEvent[] events,
             MsLink link)

Call this method to Generate event or request Signal on MsLink in Endpint

Parameters:

signals - array of MsRequestedSignal to be applied on Endpoint

events - array of MsRequestedEvent to be detected on Endpoint

link - MsLink on which events/signals need to be applied

addNotificationListener

void addNotificationListener(MsNotificationListener listener)

Register MsNotificationListener to listen for MsNotifyEvent which are fired due to events detected by Endpoints like DTMF. Use above execute methods to register for event, passing appropriate MsRequestedEvent

Parameters:

listener -

removeNotificationListener

void removeNotificationListener(MsNotificationListener listener)

Remove the NotificationListener

Parameters:

listener -

addConnectionListener

void addConnectionListener(MsConnectionListener listener)

Register MsConnectionListener to listen for changes in MsConnection state handled by this Endpoint

Parameters:

listener -

removeConnectionListener

void removeConnectionListener(MsConnectionListener listener)

Removes the MsConnectionListener

Parameters:

listener -

getSupportedPackages

java.lang.String[] getSupportedPackages()

This method gives the array of Supported Packages for given Endpoint.

Returns:

String[]