JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000

jain.protocol.ip.mgcp.message
Class NotificationRequest

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ip.mgcp.JainMgcpEvent
              |
              +--jain.protocol.ip.mgcp.JainMgcpCommandEvent
                    |
                    +--jain.protocol.ip.mgcp.message.NotificationRequest
All Implemented Interfaces:
java.io.Serializable

public final class NotificationRequest
extends JainMgcpCommandEvent

An MGCP NotificationRequest command, expressed as an event object, sent by a Call Agent to a Media Gateway to request the Gateway to notify the Call Agent of specified events, to apply signals to designated endpoints, to handle "quarantined" events in specified ways, to detect events during a "quarantine" period, and to configure designated endpoints. This command elicits a NotificationRequestResponse event.

See Also:
NotificationRequestResponse, Serialized Form

Fields inherited from class java.util.EventObject
source
 
Constructor Summary
NotificationRequest(java.lang.Object source, EndpointIdentifier endpointIdentifier, RequestIdentifier requestIdentifier)
          Constructs a new NotificationRequest (Command) Event object.

 
Method Summary
 BearerInformation getBearerInformation()
          Gets the Bearer Information.

 EventName[] getDetectEvents()
          Gets the list of events the gateway is to detect.

 DigitMap getDigitMap()
          Gets the Digit Map.

 NotifiedEntity getNotifiedEntity()
          Gets the Notified Entity.

 QuarantineHandling getQuarantineHandling()
          Gets the Quarantine Handling.

 RequestedEvent[] getRequestedEvents()
          Gets the Requested Events.

 RequestIdentifier getRequestIdentifier()
          Gets the Request Identifier.

 EventName[] getSignalRequests()
          Gets the Signal Requests.

 void setBearerInformation(BearerInformation bearerInformation)
          Sets the Bearer Information.

 void setDetectEvents(EventName[] detectEvents)
          Sets the list of MGCP events that the gateway is to detect.

 void setDigitMap(DigitMap digitMap)
          Sets the Digit Map.

 void setNotifiedEntity(NotifiedEntity notifiedEntity)
          Sets the Notified Entity.

 void setQuarantineHandling(QuarantineHandling quarantineHandling)
          Sets the Quarantine Handling.

 void setRequestedEvents(RequestedEvent[] requestedEvents)
          Sets the Requested Events.

 void setRequestIdentifier(RequestIdentifier requestIdentifier)
          Sets the Request Identifier.

 void setSignalRequests(EventName[] signalRequests)
          Sets the Signal Requests.

 java.lang.String toString()
          Overrides java.lang.Object.toString().
 
Methods inherited from class jain.protocol.ip.mgcp.JainMgcpCommandEvent
BuildCommandHeader, getEndpointIdentifier, setEndpointIdentifier
 
Methods inherited from class jain.protocol.ip.mgcp.JainMgcpEvent
BuildListParmLine, getObjectIdentifier, getTransactionHandle, setTransactionHandle
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NotificationRequest

public NotificationRequest(java.lang.Object source,
                           EndpointIdentifier endpointIdentifier,
                           RequestIdentifier requestIdentifier)
                    throws java.lang.IllegalArgumentException
Constructs a new NotificationRequest (Command) Event object.

Parameters:
endpointIdentifier - Name for the endpoint in the gateway where this command executes.
requestIdentifier - Used to correlate this command with the notifications it triggers.
Throws:
java.lang.IllegalArgumentException - Thrown if the endpoint identifier or the request identifier is null-valued.
Method Detail

getBearerInformation

public BearerInformation getBearerInformation()
Gets the Bearer Information.

Returns:
Returns the Bearer Information parameter.

getDetectEvents

public EventName[] getDetectEvents()
Gets the list of events the gateway is to detect.

Returns:
Returns the list of events the gateway is to detect.

getDigitMap

public DigitMap getDigitMap()
Gets the Digit Map.

Returns:
Returns the Digit Map.

getNotifiedEntity

public NotifiedEntity getNotifiedEntity()
Gets the Notified Entity.

Returns:
Returns the Notified Entity.

getQuarantineHandling

public QuarantineHandling getQuarantineHandling()
Gets the Quarantine Handling.

Returns:
Returns the Quarantine Handling.

getRequestedEvents

public RequestedEvent[] getRequestedEvents()
Gets the Requested Events.

Returns:
Returns the Requested Events.

getRequestIdentifier

public RequestIdentifier getRequestIdentifier()
Gets the Request Identifier.

Returns:
Returns the Request Identifier.

getSignalRequests

public EventName[] getSignalRequests()
Gets the Signal Requests.

Returns:
Returns the Signal Requests.

setBearerInformation

public void setBearerInformation(BearerInformation bearerInformation)
Sets the Bearer Information.

Parameters:
bearerInformation - Optional parameter. The bearer information (i.e., the encoding method).

setDetectEvents

public void setDetectEvents(EventName[] detectEvents)
Sets the list of MGCP events that the gateway is to detect.

Parameters:
detectEvents - Optional parameter. List of events that the gateway is requested to detect during the quarantine period. If not set explicitly, the events that should be detected in the quarantine period are those that were listed in the DetectEvents list most recently received by the gateway.

setDigitMap

public void setDigitMap(DigitMap digitMap)
Sets the Digit Map.

Parameters:
digitMap - Optional parameter. A String that contains a digit map according to which the gateway will accumulate digits.

setNotifiedEntity

public void setNotifiedEntity(NotifiedEntity notifiedEntity)
Sets the Notified Entity.

Parameters:
notifiedEntity - Optional parameter. Specifies where notifications should be sent. If not set explicitly, notifications will be sent to originator of this command.

setQuarantineHandling

public void setQuarantineHandling(QuarantineHandling quarantineHandling)
Sets the Quarantine Handling.

Parameters:
quarantineHandling - Optional parameter. Specifies handling of "quarantine" events; i.e., how events that were detected by the gateway before the arrival of this command and that have not yet been sent to the Call Agent, should be handled.

setRequestedEvents

public void setRequestedEvents(RequestedEvent[] requestedEvents)
Sets the Requested Events.

Parameters:
requestedEvents - Optional parameter. List of events that the gateway is requested to detect and report.

setRequestIdentifier

public void setRequestIdentifier(RequestIdentifier requestIdentifier)
                          throws java.lang.IllegalArgumentException
Sets the Request Identifier.

Parameters:
requestIdentifier - Used to correlate this command with the notifications it triggers.
Throws:
java.lang.IllegalArgumentException - Thrown if the request identifier is null-valued.

setSignalRequests

public void setSignalRequests(EventName[] signalRequests)
Sets the Signal Requests.

Parameters:
signalRequests - Optional parameter. List of signals that the gateway is asked to apply to the endpoint.

toString

public java.lang.String toString()
Overrides java.lang.Object.toString().
Overrides:
toString in class java.util.EventObject

JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000

Copyright © 2000 Sun Microsystems, Inc.