org.mobicents.media.control.mgcp.endpoint

Class GenericMgcpEndpoint

java.lang.Object

org.mobicents.media.control.mgcp.endpoint.GenericMgcpEndpoint

All Implemented Interfaces:

MgcpEndpoint, MgcpEndpointSubject, MgcpCallListener, MgcpConnectionListener, MgcpMessageSubject, MgcpEventObserver

Direct Known Subclasses:

MgcpMixerEndpoint, MgcpSplitterEndpoint

public class GenericMgcpEndpoint
extends Object
implements MgcpEndpoint, MgcpCallListener, MgcpConnectionListener

Abstract representation of an MGCP Endpoint that groups connections by calls.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected MediaGroup	mediaGroup

Constructor Summary

Constructors

Constructor and Description
GenericMgcpEndpoint(EndpointIdentifier endpointId, MgcpConnectionProvider connectionProvider, MediaGroup mediaGroup)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelSignal(String signal) Attempts to cancel an active signal in the endpoint.
MgcpConnection	createConnection(int callId, boolean local) Registers a connection.
protected void	deactivate()
MgcpConnection	deleteConnection(int callId, int connectionId) Deletes an active connection.
List<MgcpConnection>	deleteConnections() Deletes all currently active connections.
List<MgcpConnection>	deleteConnections(int callId) Deletes all currently active connections within a specific call.
void	forget(MgcpEndpointObserver observer)
void	forget(MgcpMessageObserver observer)
MgcpConnection	getConnection(int callId, int connectionId) Gets a connection by identifier.
EndpointIdentifier	getEndpointId() Gets the endpoint identifier
MediaGroup	getMediaGroup() Gets the media group that holds media components of the endpoint.
boolean	hasCalls()
boolean	isActive()
void	notify(MgcpEndpoint endpoint, MgcpEndpointState state)
void	notify(Object originator, MgcpMessage message, MessageDirection direction)
void	observe(MgcpEndpointObserver observer)
void	observe(MgcpMessageObserver observer)
protected void	onActivated() Event that is called when endpoint becomes active.
void	onCallTerminated(MgcpCall call)
protected void	onConnectionCreated(MgcpConnection connection) Event that is called when a new connection is created in the endpoint.
protected void	onConnectionDeleted(MgcpConnection connection) Event that is called when a new connection is deleted in the endpoint.
void	onConnectionFailure(MgcpConnection connection)
protected void	onDeactivated() Event that is called when endpoint becomes inactive.
void	onEvent(Object originator, MgcpEvent event) Triggered when an MGCP event is fired.
void	requestNotification(NotificationRequest request) Requests a notification to be fired when an event happens in the endpoint.

Methods inherited from class java.lang.Object

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

Field Detail

mediaGroup

protected final MediaGroup mediaGroup

Constructor Detail

GenericMgcpEndpoint

public GenericMgcpEndpoint(EndpointIdentifier endpointId,
                   MgcpConnectionProvider connectionProvider,
                   MediaGroup mediaGroup)

Method Detail

getEndpointId

public EndpointIdentifier getEndpointId()

Description copied from interface: MgcpEndpoint

Gets the endpoint identifier

Specified by:

getEndpointId in interface MgcpEndpoint

Returns:

The endpoint ID

getMediaGroup

public MediaGroup getMediaGroup()

Description copied from interface: MgcpEndpoint

Gets the media group that holds media components of the endpoint.

Specified by:

getMediaGroup in interface MgcpEndpoint

Returns:

The media group.

hasCalls

public boolean hasCalls()

getConnection

public MgcpConnection getConnection(int callId,
                           int connectionId)

Description copied from interface: MgcpEndpoint

Gets a connection by identifier.

Specified by:

getConnection in interface MgcpEndpoint

Parameters:

callId - The call identifier.

connectionId - The connection identifier.

Returns:

The connection matching the criteria. Returns null if no such connection exists.

createConnection

public MgcpConnection createConnection(int callId,
                              boolean local)

Description copied from interface: MgcpEndpoint

Registers a connection.

Specified by:

createConnection in interface MgcpEndpoint

Parameters:

callId - The identifier of the call where the connection belongs to.

local - Whether a local or remote connection is to be created.

deleteConnection

public MgcpConnection deleteConnection(int callId,
                              int connectionId)
                                throws MgcpCallNotFoundException,
                                       MgcpConnectionNotFound

Description copied from interface: MgcpEndpoint

Deletes an active connection.

Specified by:

deleteConnection in interface MgcpEndpoint

Parameters:

callId - The ID of the call where the connection is stored.

connectionId - The connection ID

Throws:

MgcpCallNotFoundException - When call with such ID cannot be found.

MgcpConnectionNotFound - When call does not contain connection with such ID.

deleteConnections

public List<MgcpConnection> deleteConnections(int callId)
                                       throws MgcpCallNotFoundException

Description copied from interface: MgcpEndpoint

Deletes all currently active connections within a specific call.

Specified by:

deleteConnections in interface MgcpEndpoint

Parameters:

callId - the call identifier

Throws:

MgcpCallNotFoundException - When call with such ID cannot be found.

deleteConnections

public List<MgcpConnection> deleteConnections()

Description copied from interface: MgcpEndpoint

Deletes all currently active connections.

Specified by:

deleteConnections in interface MgcpEndpoint

onCallTerminated

public void onCallTerminated(MgcpCall call)

Specified by:

onCallTerminated in interface MgcpCallListener

isActive

public boolean isActive()

deactivate

protected void deactivate()
                   throws IllegalStateException

Throws:

IllegalStateException

onConnectionFailure

public void onConnectionFailure(MgcpConnection connection)

Specified by:

onConnectionFailure in interface MgcpConnectionListener

requestNotification

public void requestNotification(NotificationRequest request)

Description copied from interface: MgcpEndpoint

Requests a notification to be fired when an event happens in the endpoint.

Specified by:

requestNotification in interface MgcpEndpoint

Parameters:

request - The notification request.

cancelSignal

public void cancelSignal(String signal)

Description copied from interface: MgcpEndpoint

Attempts to cancel an active signal in the endpoint.

Specified by:

cancelSignal in interface MgcpEndpoint

Parameters:

signal - The name of the signal.

onConnectionCreated

protected void onConnectionCreated(MgcpConnection connection)

Event that is called when a new connection is created in the endpoint.
To be overridden by subclasses.

Parameters:

connection -

onConnectionDeleted

protected void onConnectionDeleted(MgcpConnection connection)

Event that is called when a new connection is deleted in the endpoint.
To be overriden by subclasses.

Parameters:

connection -

onActivated

protected void onActivated()

Event that is called when endpoint becomes active.
To be overriden by subclasses.

Parameters:

connection -

onDeactivated

protected void onDeactivated()

Event that is called when endpoint becomes inactive.
To be overriden by subclasses.

Parameters:

connection -

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

onEvent

public void onEvent(Object originator,
           MgcpEvent event)

Description copied from interface: MgcpEventObserver

Triggered when an MGCP event is fired.

Specified by:

onEvent in interface MgcpEventObserver

Parameters:

originator - The source of the event.

event - The event data.

observe

public void observe(MgcpEndpointObserver observer)

Specified by:

observe in interface MgcpEndpointSubject

forget

public void forget(MgcpEndpointObserver observer)

Specified by:

forget in interface MgcpEndpointSubject

notify

public void notify(MgcpEndpoint endpoint,
          MgcpEndpointState state)

Specified by:

notify in interface MgcpEndpointSubject