jain.protocol.ip.mgcp
Interface JainMgcpProvider

public interface JainMgcpProvider

This interface must be implemented by any class that represents the JAIN MGCP abstraction of an MGCP stack and that interacts directly with a proprietary (vendor-specific) implementation of that MGCP stack.

Method Summary

void	addJainMgcpListener(JainMgcpListener jainMgcpListener) Adds a JAIN MGCP Listener to the list of Event Listeners registered on an implementation of the JainMgcpProvider interface.
JainMgcpStack	getJainMgcpStack() Returns an object reference to the underlying JAIN MGCP Stack to which this JAIN MGCP Provider is bound.
void	removeJainMgcpListener(JainMgcpListener jainMgcpListener) Removes a JAIN MGCP Listener from the list of Event Listeners registered on an implementation of the JainMgcpProvider interface.
void	sendMgcpEvents(JainMgcpEvent[] jainMgcpEvents) Sends a list of MGCP commands and responses into the MGCP stack.

Method Detail

addJainMgcpListener

public void addJainMgcpListener(JainMgcpListener jainMgcpListener)
                         throws java.util.TooManyListenersException

Adds a JAIN MGCP Listener to the list of Event Listeners registered on an implementation of the JainMgcpProvider interface.

Parameters:

jainMgcpListener - A reference to an object that implements the JainMgcpListener interface and that is to be added to the list of Event Listeners.

Throws:

java.util.TooManyListenersException - Thrown if adding this Listener would exceed the number of JAIN MGCP Listeners permitted by the implementation.

getJainMgcpStack

public JainMgcpStack getJainMgcpStack()

Returns an object reference to the underlying JAIN MGCP Stack to which this JAIN MGCP Provider is bound.

Returns:

An object reference to the underlying JAIN MGCP Stack to which this JAIN MGCP Provider is bound.

removeJainMgcpListener

public void removeJainMgcpListener(JainMgcpListener jainMgcpListener)

Removes a JAIN MGCP Listener from the list of Event Listeners registered on an implementation of the JainMgcpProvider interface. If the object reference to the JainMgcpListener does not correspond to a registered Listener, this method simply returns.

Parameters:

jainMgcpListener - A reference to an object that implements the JainMgcpListener interface and that is to be removed from the list of Event Listeners.

sendMgcpEvents

public void sendMgcpEvents(JainMgcpEvent[] jainMgcpEvents)
                    throws java.lang.IllegalArgumentException

Sends a list of MGCP commands and responses into the MGCP stack. The use of a list is intended to facilitate "piggybacking" of messages, all of whose destinations are the same. Specific vendor implementations may impose restrictions on the number of command and response messages, the sequencing of those messages, and other such limitations on the usage of this method.

Parameters:

jainMgcpEvents - An array of JainMgcpEvent objects.

Throws:

java.lang.IllegalArgumentException - Thrown if any of the limitations imposed by a vendor's implementation are exceeded.