jain.protocol.ip.mgcp.message
Class DeleteConnection

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

All Implemented Interfaces:

java.io.Serializable

public final class DeleteConnection

extends JainMgcpCommandEvent

An MGCP DeleteConnection command. Sent by a Call Agent to request a Gateway to delete a connection, or multiple connections. Sent by a Gateway to a Call Agent to signify that a connection can no longer be sustained. This command elicits a DeleteConnectionResponse event.

See Also:

DeleteConnectionResponse, Serialized Form

Fields inherited from class java.util.EventObject

source

Constructor Summary

DeleteConnection(java.lang.Object source, CallIdentifier callIdentifier, EndpointIdentifier endpointIdentifier)
Constructs a new DeleteConnection (Command) Event object, used by a Call Agent to delete all connections that relate to a given call.

DeleteConnection(java.lang.Object source, CallIdentifier callIdentifier, EndpointIdentifier endpointIdentifier, ConnectionIdentifier connectionIdentifier)
Constructs a new DeleteConnection (Command) Event object, used by a Call Agent to delete a single connection.

DeleteConnection(java.lang.Object source, CallIdentifier callIdentifier, EndpointIdentifier endpointIdentifier, ConnectionIdentifier connectionIdentifier, ReasonCode reasonCode, ConnectionParm[] connectionParms)
Constructs a new DeleteConnection (Command) Event object, used by a VOIP Gateway to indicate to a Call Agent that a connection can no longer be sustained.

DeleteConnection(java.lang.Object source, EndpointIdentifier endpointIdentifier)
Constructs a new DeleteConnection (Command) Event object, used by a Call Agent to delete all connections related to a specified endpoint.

Method Summary

BearerInformation	getBearerInformation() Gets the Bearer Information.
CallIdentifier	getCallIdentifier() Gets the Call Identifier.
ConnectionIdentifier	getConnectionIdentifier() Gets the Connection Identifier.
ConnectionParm[]	getConnectionParms() Gets the Connection Parameters.
NotificationRequestParms	getNotificationRequestParms() Gets the Notification Request parameters.
ReasonCode	getReasonCode() Gets the Reason Code.
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	setConnectionParms(ConnectionParm[] connectionParms) Sets the Connection Parameters.
void	setNotificationRequestParms(NotificationRequestParms notificationRequestParms) Sets the Notification Request parameters.
void	setReasonCode(ReasonCode reasonCode) Sets the Reason Code.
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

DeleteConnection

public DeleteConnection(java.lang.Object source,
                        CallIdentifier callIdentifier,
                        EndpointIdentifier endpointIdentifier)
                 throws java.lang.IllegalArgumentException

Constructs a new DeleteConnection (Command) Event object, used by a Call Agent to delete all connections that relate to a given call.

Parameters:

callIdentifier - Identifies the call for which the connections are being deleted.

endpointIdentifier - Name for the endpoint in the gateway where this command executes.

Throws:

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

DeleteConnection

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

Constructs a new DeleteConnection (Command) Event object, used by a Call Agent to delete a single connection.

Parameters:

callIdentifier - Identifies the call for which the connection is being deleted.

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.

DeleteConnection

public DeleteConnection(java.lang.Object source,
                        CallIdentifier callIdentifier,
                        EndpointIdentifier endpointIdentifier,
                        ConnectionIdentifier connectionIdentifier,
                        ReasonCode reasonCode,
                        ConnectionParm[] connectionParms)
                 throws java.lang.IllegalArgumentException

Constructs a new DeleteConnection (Command) Event object, used by a VOIP Gateway to indicate to a Call Agent that a connection can no longer be sustained.

Parameters:

callIdentifier - Identifies the call for which the connection is being deleted.

endpointIdentifier - Name for the endpoint in the gateway where this command executes.

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

reasonCode - Identifies the reason that the connection can no longer be sustained.

connectionParms - A list of connection parameters that describe the status of the connection.

Throws:

java.lang.IllegalArgumentException - Thrown if the call identifier, the endpoint identifier, the connection identifier, the reason code, or the list of connection parameters (or any of the entries in that list) is null-valued.

DeleteConnection

public DeleteConnection(java.lang.Object source,
                        EndpointIdentifier endpointIdentifier)
                 throws java.lang.IllegalArgumentException

Constructs a new DeleteConnection (Command) Event object, used by a Call Agent to delete all connections related to a specified endpoint.

Parameters:

endpointIdentifier - Name for the endpoint in the gateway where this command executes.

Throws:

java.lang.IllegalArgumentException - Thrown if the endpoint 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.

getConnectionParms

public ConnectionParm[] getConnectionParms()

Gets the Connection Parameters.

Returns:

The list of Connection Parameters.

getNotificationRequestParms

public NotificationRequestParms getNotificationRequestParms()

Gets the Notification Request parameters.

Returns:

The Notification Request parameters.

See Also:

NotificationRequestParms

getReasonCode

public ReasonCode getReasonCode()

Gets the Reason Code.

Returns:

The Reason Code.

setBearerInformation

public void setBearerInformation(BearerInformation bearerInformation)

Sets the Bearer Information.

Parameters:

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

setCallIdentifier

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

Sets the Call Identifier.

Parameters:

callIdentifier - Identifies the call on which the connection is being deleted.

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.

setConnectionParms

public void setConnectionParms(ConnectionParm[] connectionParms)
                        throws java.lang.IllegalArgumentException

Sets the Connection Parameters.

Parameters:

connectionParms - A list of connection parameters that describe the status of the connection.

Throws:

java.lang.IllegalArgumentException - Thrown if the connection parameters list is null-valued, or if any of the entries in the list is null-valued.

setNotificationRequestParms

public void setNotificationRequestParms(NotificationRequestParms notificationRequestParms)

Sets the Notification Request parameters.

Parameters:

notificationRequestParms - Optional parameter. Encapsulated Notification Request parameters.

See Also:

NotificationRequestParms

setReasonCode

public void setReasonCode(ReasonCode reasonCode)
                   throws java.lang.IllegalArgumentException

Sets the Reason Code.

Parameters:

reasonCode - Identifies the reason that the connection can no longer be sustained.

Throws:

java.lang.IllegalArgumentException - Thrown if the reason code parameter is null-valued.

toString

public java.lang.String toString()

Overrides java.lang.Object.toString().

Overrides:

toString in class java.util.EventObject