|
JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.util.EventObject | +--jain.protocol.ip.mgcp.JainMgcpEvent | +--jain.protocol.ip.mgcp.JainMgcpCommandEvent | +--jain.protocol.ip.mgcp.message.ModifyConnection
An MGCP ModifyConnection command, expressed as an event object, sent by a Call Agent to a Media Gateway to request the Gateway to modify a connection between two endpoints. This command elicits a ModifyConnectionResponse event.
ModifyConnectionResponse
, Serialized FormFields inherited from class java.util.EventObject |
source |
Constructor Summary | |
ModifyConnection(java.lang.Object source,
CallIdentifier callIdentifier,
EndpointIdentifier endpointIdentifier,
ConnectionIdentifier connectionIdentifier)
Constructs a new ModifyConnection (Command) Event object. |
Method Summary | |
BearerInformation |
getBearerInformation()
Gets the Bearer Information. |
CallIdentifier |
getCallIdentifier()
Gets the Call Identifier. |
ConnectionIdentifier |
getConnectionIdentifier()
Gets the Connection Identifier. |
LocalOptionValue[] |
getLocalConnectionOptions()
Gets the Local Connection Options parameter. |
ConnectionMode |
getMode()
Gets the Mode parameter. |
NotificationRequestParms |
getNotificationRequestParms()
Gets the Notification Request parameters. |
NotifiedEntity |
getNotifiedEntity()
Gets the Notified Entity. |
ConnectionDescriptor |
getRemoteConnectionDescriptor()
Gets the Remote Connection Descriptor parameter. |
void |
setBearerInformation(BearerInformation bearerInformation)
Sets the Bearer Information. |
void |
setCallIdentifier(CallIdentifier callIdentifier)
Sets the Call Identifier. |
void |
setConnectionIdentifier(ConnectionIdentifier connectionIdentifier)
Sets the Connection Identifier. |
void |
setLocalConnectionOptions(LocalOptionValue[] localConnectionOptions)
Sets the Local Connection Options parameter. |
void |
setMode(ConnectionMode mode)
Sets the Mode parameter. |
void |
setNotificationRequestParms(NotificationRequestParms notificationRequestParms)
Sets the Notification Request parameters. |
void |
setNotifiedEntity(NotifiedEntity notifiedEntity)
Sets the Notified Entity. |
void |
setRemoteConnectionDescriptor(ConnectionDescriptor remoteConnectionDescriptor)
Sets the Remote Connection Descriptor parameter. |
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 |
public ModifyConnection(java.lang.Object source, CallIdentifier callIdentifier, EndpointIdentifier endpointIdentifier, ConnectionIdentifier connectionIdentifier) throws java.lang.IllegalArgumentException
callIdentifier
- A globally unique parameter that identifies the call (or session) to which this
connection belongs.endpointIdentifier
- Name for the endpoint in the gateway where this command executes.connectionIdentifier
- Identifies the connection within the endpoint whose characteristics are being modified.java.lang.IllegalArgumentException
- Thrown if the call identifier, the endpoint identifier, or the connection identifier is null-valued.Method Detail |
public BearerInformation getBearerInformation()
public CallIdentifier getCallIdentifier()
public ConnectionIdentifier getConnectionIdentifier()
public LocalOptionValue[] getLocalConnectionOptions()
public ConnectionMode getMode()
public NotificationRequestParms getNotificationRequestParms()
NotificationRequestParms
public NotifiedEntity getNotifiedEntity()
public ConnectionDescriptor getRemoteConnectionDescriptor()
public void setBearerInformation(BearerInformation bearerInformation)
bearerInformation
- Optional parameter. The bearer information (i.e., the encoding method).public void setCallIdentifier(CallIdentifier callIdentifier) throws java.lang.IllegalArgumentException
callIdentifier
- A globally unique parameter that identifies the call (or session) to which this
connection belongs.java.lang.IllegalArgumentException
- Thrown if the call identifier is null-valued.public void setConnectionIdentifier(ConnectionIdentifier connectionIdentifier) throws java.lang.IllegalArgumentException
connectionIdentifier
- Identifies the connection within the endpoint whose characteristics are being modified.java.lang.IllegalArgumentException
- Thrown if the connection identifier is null-valued.public void setLocalConnectionOptions(LocalOptionValue[] localConnectionOptions)
localConnectionOptions
- Optional parameter. A list of local connection option values. Used by the Call Agent to direct the handling
of the connection by the gateway.public void setMode(ConnectionMode mode)
mode
- Optional parameter.
Indicates the mode of operation for this side of the connection; e.g., send, receive, etc.public void setNotificationRequestParms(NotificationRequestParms notificationRequestParms)
notificationRequestParms
- Optional parameter. Used to encapsulate notification request parameters in
this command.NotificationRequestParms
public void setNotifiedEntity(NotifiedEntity notifiedEntity)
notifiedEntity
- Optional parameter. Specifies where notifications should be sent. If not set explicitly,
notifications will be sent to originator of this command.public void setRemoteConnectionDescriptor(ConnectionDescriptor remoteConnectionDescriptor)
remoteConnectionDescriptor
- Optional parameter. The connection descriptor for the remote side of a
connection, on the other
side of the IP network.public java.lang.String toString()
toString
in class java.util.EventObject
|
JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |