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

jain.protocol.ip.mgcp.message
Class CreateConnection

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

public final class CreateConnection
extends JainMgcpCommandEvent

An MGCP CreateConnection command, expressed as an event object, sent by a Call Agent to a Media Gateway to request the Gateway to create a connection between two endpoints. This command elicits a CreateConnectionResponse event.

See Also:
CreateConnectionResponse, Serialized Form

Fields inherited from class java.util.EventObject
source
 
Constructor Summary
CreateConnection(java.lang.Object source, CallIdentifier callIdentifier, EndpointIdentifier endpointIdentifier, ConnectionMode mode)
          Constructs a new CreateConnection (Command) Event object.

 
Method Summary
 BearerInformation getBearerInformation()
          Gets the Bearer Information parameter.

 CallIdentifier getCallIdentifier()
          Gets the Call 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.

 EndpointIdentifier getSecondEndpointIdentifier()
          Gets the Second Endpoint Identifier.

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

 void setCallIdentifier(CallIdentifier callIdentifier)
          Sets the Call 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.

 void setSecondEndpointIdentifier(EndpointIdentifier secondEndpointIdentifier)
          Sets the Second Endpoint Identifier.

 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

CreateConnection

public CreateConnection(java.lang.Object source,
                        CallIdentifier callIdentifier,
                        EndpointIdentifier endpointIdentifier,
                        ConnectionMode mode)
                 throws java.lang.IllegalArgumentException
Constructs a new CreateConnection (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.
mode - Indicates the mode of operation for this side of the connection; e.g., send, receive, etc.
Throws:
java.lang.IllegalArgumentException - Thrown if the call identifier, endpoint identifier, or mode parameter is null-valued.
Method Detail

getBearerInformation

public BearerInformation getBearerInformation()
Gets the Bearer Information parameter.

Returns:
Returns a reference to the Bearer Information.

getCallIdentifier

public CallIdentifier getCallIdentifier()
Gets the Call Identifier.

Returns:
The Call 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.

getSecondEndpointIdentifier

public EndpointIdentifier getSecondEndpointIdentifier()
Gets the Second Endpoint Identifier.

Returns:
The Second Endpoint Identifier.

setBearerInformation

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

Parameters:
bearerInformation - Optional parameter, used to encapsulate bearer information (i.e., encoding method) in this command.

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 parameter 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)
             throws java.lang.IllegalArgumentException
Sets the Mode parameter.

Parameters:
mode - Indicates the mode of operation for this side of the connection; e.g., send, receive, etc.
Throws:
java.lang.IllegalArgumentException - Thrown if the mode parameter is null-valued.

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)
                                   throws ConflictingParameterException
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.
Throws:
ConflictingParameterException - Remote Connection Descriptor and Second Endpoint Identifier are mutually exclusive. This exception is thrown if Second Endpoint Identifier is already set and an attempt is made to set Remote Connection Descriptor.

setSecondEndpointIdentifier

public void setSecondEndpointIdentifier(EndpointIdentifier secondEndpointIdentifier)
                                 throws ConflictingParameterException
Sets the Second Endpoint Identifier.

Parameters:
secondEndpointIdentifier - Optional parameter. Used in conjunction with the endpointIdentifier to establish a connection between two endpoints located on the same gateway.
Throws:
ConflictingParameterException - Remote Connection Descriptor and Second Endpoint Identifier are mutually exclusive. This exception is thrown if Remote Connection Descriptor is already set and an attempt is made to set Second Endpoint Identifier .

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.