org.mobicents.media.control.mgcp.endpoint

Class MgcpEndpointManager

java.lang.Object

org.mobicents.media.control.mgcp.endpoint.MgcpEndpointManager

All Implemented Interfaces:

MgcpEndpointObserver, MgcpMessageObserver, MgcpMessageSubject

public class MgcpEndpointManager
extends Object
implements MgcpEndpointObserver, MgcpMessageObserver, MgcpMessageSubject

Manages the collection of endpoints registered system-wide.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Constructor Summary

Constructors

Constructor and Description
MgcpEndpointManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	forget(MgcpMessageObserver observer)
MgcpEndpoint	getEndpoint(String endpointId) Gets a registered endpoint.
void	installProvider(MgcpEndpointProvider<?> provider)
void	notify(Object originator, MgcpMessage message, MessageDirection direction)
void	observe(MgcpMessageObserver observer)
void	onEndpointStateChanged(MgcpEndpoint endpoint, MgcpEndpointState state) Fired when an endpoint state changes.
void	onMessage(MgcpMessage message, MessageDirection direction) Event triggered when a message arrives.
MgcpEndpoint	registerEndpoint(String namespace) Registers a new endpoint.
boolean	supportsNamespace(String namespace)
void	uninstallProvider(String namespace)
void	unregisterEndpoint(String endpointId) Unregisters an active endpoint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MgcpEndpointManager

public MgcpEndpointManager()

Method Detail

installProvider

public void installProvider(MgcpEndpointProvider<?> provider)
                     throws IllegalArgumentException

Throws:

IllegalArgumentException

uninstallProvider

public void uninstallProvider(String namespace)

supportsNamespace

public boolean supportsNamespace(String namespace)

registerEndpoint

public MgcpEndpoint registerEndpoint(String namespace)
                              throws UnrecognizedMgcpNamespaceException

Registers a new endpoint.

Parameters:

endpoint - The name space of the endpoint which indicates what kind of endpoint is generated.

Throws:

UnrecognizedMgcpNamespaceException

getEndpoint

public MgcpEndpoint getEndpoint(String endpointId)

Gets a registered endpoint.

Parameters:

endpointId - The endpoint identifier.

Returns:

The endpoint if registered; otherwise returns null

unregisterEndpoint

public void unregisterEndpoint(String endpointId)
                        throws MgcpEndpointNotFoundException

Unregisters an active endpoint.

Parameters:

endpointId - The ID of the endpoint to be unregistered

Throws:

MgcpEndpointNotFoundException - If there is no registered endpoint with such ID

onMessage

public void onMessage(MgcpMessage message,
             MessageDirection direction)

Description copied from interface: MgcpMessageObserver

Event triggered when a message arrives.

Specified by:

onMessage in interface MgcpMessageObserver

Parameters:

message - The message

direction - The direction of the message: incoming or outgoing.

observe

public void observe(MgcpMessageObserver observer)

Specified by:

observe in interface MgcpMessageSubject

forget

public void forget(MgcpMessageObserver observer)

Specified by:

forget in interface MgcpMessageSubject

notify

public void notify(Object originator,
          MgcpMessage message,
          MessageDirection direction)

Specified by:

notify in interface MgcpMessageSubject

onEndpointStateChanged

public void onEndpointStateChanged(MgcpEndpoint endpoint,
                          MgcpEndpointState state)

Description copied from interface: MgcpEndpointObserver

Fired when an endpoint state changes.

An endpoint becomes ACTIVE when it contains at least one connection. Its Mixer is active and consumes CPU.
An endpoint becomes INACTIVE when it contains no connections. Its Mixer is inactive and does not consume CPU.

Specified by:

onEndpointStateChanged in interface MgcpEndpointObserver

Parameters:

endpoint - The endpoint whose state changed.

state - The new state of the endpoint.