jain.protocol.ip.mgcp.message
Class Notify
java.lang.Object
|
+--java.util.EventObject
|
+--jain.protocol.ip.mgcp.JainMgcpEvent
|
+--jain.protocol.ip.mgcp.JainMgcpCommandEvent
|
+--jain.protocol.ip.mgcp.message.Notify
- All Implemented Interfaces:
- java.io.Serializable
- public final class Notify
- extends JainMgcpCommandEvent
An MGCP Notify command, expressed as an event object, sent by a Media Gateway to a Call Agent to notify the
latter of events that have been detected by the Gateway.
Elicits a NotifyResponse Event Object.
- See Also:
NotifyResponse
, Serialized Form
Fields inherited from class java.util.EventObject |
source |
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 |
Notify
public Notify(java.lang.Object source,
EndpointIdentifier endpointIdentifier,
RequestIdentifier requestIdentifier,
EventName[] observedEvents)
throws java.lang.IllegalArgumentException
- Constructs a new Notify (Command) Event object.
- Parameters:
endpointIdentifier
- Name for the endpoint in the gateway for which the notification is taking
place.requestIdentifier
- Used to correlate this command with the notification request that triggers it.observedEvents
- A list of events that the gateway detected.- Throws:
java.lang.IllegalArgumentException
- Thrown if the endpoint identifier, the request identifier, or the list of observed events (or any entry in that
list) is null-valued.
getNotifiedEntity
public NotifiedEntity getNotifiedEntity()
- Gets the Notified Entity.
- Returns:
- Returns the Notified Entity.
getObservedEvents
public EventName[] getObservedEvents()
- Gets the Observed Events.
- Returns:
- Returns a reference to the Observed Events.
getRequestIdentifier
public RequestIdentifier getRequestIdentifier()
- Gets the Request Identifier.
- Returns:
- Returns the Request Identifier.
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.
setObservedEvents
public void setObservedEvents(EventName[] observedEvents)
throws java.lang.IllegalArgumentException
- Sets the Observed Events.
- Parameters:
observedEvents
- A list of events that the gateway detected.- Throws:
java.lang.IllegalArgumentException
- Thrown if the list of observed events, or any entry in that list, is null-valued.
setRequestIdentifier
public void setRequestIdentifier(RequestIdentifier requestIdentifier)
throws java.lang.IllegalArgumentException
- Sets the Request Identifier.
- Parameters:
requestIdentifier
- Used to correlate this command with the notification request that triggers it.- Throws:
java.lang.IllegalArgumentException
- Thrown if the request identifier is null-valued.
toString
public java.lang.String toString()
- Overrides java.lang.Object.toString().
- Overrides:
toString
in class java.util.EventObject
Copyright © 2000 Sun Microsystems, Inc.