jain.protocol.ip.mgcp.message
Class ModifyConnection

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ip.mgcp.JainMgcpEvent
              |
              +--jain.protocol.ip.mgcp.JainMgcpCommandEvent
                    |
                    +--jain.protocol.ip.mgcp.message.ModifyConnection

All Implemented Interfaces:

java.io.Serializable

public final class ModifyConnection

extends JainMgcpCommandEvent

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.

See Also:

ModifyConnectionResponse, Serialized Form

Fields 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

ModifyConnection

public ModifyConnection(java.lang.Object source,
                        CallIdentifier callIdentifier,
                        EndpointIdentifier endpointIdentifier,
                        ConnectionIdentifier connectionIdentifier)
                 throws java.lang.IllegalArgumentException

Constructs a new ModifyConnection (Command) Event object.

Parameters:

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.

Throws:

java.lang.IllegalArgumentException - Thrown if the call identifier, the endpoint identifier, or the connection identifier is null-valued.

Method Detail

getBearerInformation

public BearerInformation getBearerInformation()

Gets the Bearer Information.

Returns:

Returns a reference to the Bearer Information parameter.

getCallIdentifier

public CallIdentifier getCallIdentifier()

Gets the Call Identifier.

Returns:

The Call Identifier.

getConnectionIdentifier

public ConnectionIdentifier getConnectionIdentifier()

Gets the Connection Identifier.

Returns:

The Connection Identifier.

getLocalConnectionOptions

public LocalOptionValue[] getLocalConnectionOptions()

Gets the Local Connection Options parameter.

Returns:

The list of Local Connection Option values.

getMode

public ConnectionMode getMode()

Gets the Mode parameter.

Returns:

The Mode parameter.

getNotificationRequestParms

public NotificationRequestParms getNotificationRequestParms()

Gets the Notification Request parameters.

Returns:

The Notification Request parameters.

See Also:

NotificationRequestParms

getNotifiedEntity

public NotifiedEntity getNotifiedEntity()

Gets the Notified Entity.

Returns:

The Notified Entity.

getRemoteConnectionDescriptor

public ConnectionDescriptor getRemoteConnectionDescriptor()

Gets the Remote Connection Descriptor parameter.

Returns:

The Remote Connection Descriptor parameter.

setBearerInformation

public void setBearerInformation(BearerInformation bearerInformation)

Sets the Bearer Information.

Parameters:

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

setCallIdentifier

public void setCallIdentifier(CallIdentifier callIdentifier)
                       throws java.lang.IllegalArgumentException

Sets the Call Identifier.

Parameters:

callIdentifier - A globally unique parameter that identifies the call (or session) to which this connection belongs.

Throws:

java.lang.IllegalArgumentException - Thrown if the call identifier is null-valued.

setConnectionIdentifier

public void setConnectionIdentifier(ConnectionIdentifier connectionIdentifier)
                             throws java.lang.IllegalArgumentException

Sets the Connection Identifier.

Parameters:

connectionIdentifier - Identifies the connection within the endpoint whose characteristics are being modified.

Throws:

java.lang.IllegalArgumentException - Thrown if the connection identifier is null-valued.

setLocalConnectionOptions

public void setLocalConnectionOptions(LocalOptionValue[] localConnectionOptions)

Sets the Local Connection Options parameter.

Parameters:

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.

setMode

public void setMode(ConnectionMode mode)

Sets the Mode parameter.

Parameters:

mode - Optional parameter. Indicates the mode of operation for this side of the connection; e.g., send, receive, etc.

setNotificationRequestParms

public void setNotificationRequestParms(NotificationRequestParms notificationRequestParms)

Sets the Notification Request parameters.

Parameters:

notificationRequestParms - Optional parameter. Used to encapsulate notification request parameters in this command.

See Also:

NotificationRequestParms

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.

setRemoteConnectionDescriptor

public void setRemoteConnectionDescriptor(ConnectionDescriptor remoteConnectionDescriptor)

Sets the Remote Connection Descriptor parameter.

Parameters:

remoteConnectionDescriptor - Optional parameter. The connection descriptor for the remote side of a connection, on the other side of the IP network.

toString

public java.lang.String toString()

Overrides java.lang.Object.toString().

Overrides:

toString in class java.util.EventObject