org.mobicents.media.control.mgcp.pkg

Class AbstractMgcpSignal

java.lang.Object

org.mobicents.media.control.mgcp.pkg.AbstractMgcpSignal

All Implemented Interfaces:

MgcpEventSubject, MgcpSignal

Direct Known Subclasses:

EndSignal, PlayAnnouncement, PlayCollect, PlayRecord

public abstract class AbstractMgcpSignal
extends Object
implements MgcpSignal

Generic representation of an MGCP Signal.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicBoolean	executing

Constructor Summary

Constructors

Constructor and Description
AbstractMgcpSignal(String packageName, String symbol, SignalType type, int requestId)
AbstractMgcpSignal(String packageName, String symbol, SignalType type, int requestId, Map<String,String> parameters)
AbstractMgcpSignal(String packageName, String symbol, SignalType type, int requestId, NotifiedEntity notifiedEntity)
AbstractMgcpSignal(String packageName, String symbol, SignalType type, int requestId, NotifiedEntity notifiedEntity, Map<String,String> parameters)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
void	forget(MgcpEventObserver observer)
String	getName() Gets the name of the signal which is composed of the MGCP package plus the signal name.
NotifiedEntity	getNotifiedEntity() Gets the entity which requested the notification of events resulting from the completion of the signal.
String	getParameter(String name)
int	getRequestId() Gets the identifier of the request that submitted the signal.
SignalType	getSignalType() Gets the type of signal.
String	getSymbol()
boolean	isExecuting() Gets whether the signal is currently executing.
protected abstract boolean	isParameterSupported(String name)
void	notify(Object originator, MgcpEvent event)
void	observe(MgcpEventObserver observer)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mobicents.media.control.mgcp.pkg.MgcpSignal

cancel, execute

Field Detail

executing

protected final AtomicBoolean executing

Constructor Detail

AbstractMgcpSignal

public AbstractMgcpSignal(String packageName,
                  String symbol,
                  SignalType type,
                  int requestId,
                  NotifiedEntity notifiedEntity,
                  Map<String,String> parameters)

AbstractMgcpSignal

public AbstractMgcpSignal(String packageName,
                  String symbol,
                  SignalType type,
                  int requestId,
                  Map<String,String> parameters)

AbstractMgcpSignal

public AbstractMgcpSignal(String packageName,
                  String symbol,
                  SignalType type,
                  int requestId,
                  NotifiedEntity notifiedEntity)

AbstractMgcpSignal

public AbstractMgcpSignal(String packageName,
                  String symbol,
                  SignalType type,
                  int requestId)

Method Detail

getSymbol

public String getSymbol()

getName

public String getName()

Description copied from interface: MgcpSignal

Gets the name of the signal which is composed of the MGCP package plus the signal name.

Specified by:

getName in interface MgcpSignal

Returns:

The name of the signal.

getSignalType

public SignalType getSignalType()

Description copied from interface: MgcpSignal

Gets the type of signal.

Specified by:

getSignalType in interface MgcpSignal

Returns:

The type of the signal.

getRequestId

public int getRequestId()

Description copied from interface: MgcpSignal

Gets the identifier of the request that submitted the signal.

Specified by:

getRequestId in interface MgcpSignal

Returns:

The request identifier.

getNotifiedEntity

public NotifiedEntity getNotifiedEntity()

Description copied from interface: MgcpSignal

Gets the entity which requested the notification of events resulting from the completion of the signal.

This parameter is equal to the NotifiedEntity parameter of the NotificationRequest that triggered this notification. The parameter is absent if there was no such parameter in the triggering request.

Specified by:

getNotifiedEntity in interface MgcpSignal

Returns:

The entity that submitted the signal. May return null if parameter was not specified in original RQNT command.

getParameter

public String getParameter(String name)

isParameterSupported

protected abstract boolean isParameterSupported(String name)

isExecuting

public boolean isExecuting()

Description copied from interface: MgcpSignal

Gets whether the signal is currently executing.

Specified by:

isExecuting in interface MgcpSignal

Returns:

true if executing; otherwise returns false

observe

public void observe(MgcpEventObserver observer)

Specified by:

observe in interface MgcpEventSubject

forget

public void forget(MgcpEventObserver observer)

Specified by:

forget in interface MgcpEventSubject

notify

public void notify(Object originator,
          MgcpEvent event)

Specified by:

notify in interface MgcpEventSubject

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object