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

jain.protocol.ip.mgcp.message
Class CreateConnectionResponse

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

public final class CreateConnectionResponse
extends JainMgcpResponseEvent

The acknowledgment to an MGCP CreateConnection command.

See Also:
CreateConnection, Serialized Form

Fields inherited from class java.util.EventObject
source
 
Constructor Summary
CreateConnectionResponse(java.lang.Object source, ReturnCode returnCode, ConnectionIdentifier connectionIdentifier)
          Constructs a new CreateConnectionResponse Event object.

 
Method Summary
 ConnectionIdentifier getConnectionIdentifier()
          Gets the Connection Identifier.

 ConnectionDescriptor getLocalConnectionDescriptor()
          Gets the Local Connection Descriptor.

 ConnectionIdentifier getSecondConnectionIdentifier()
          Gets the second connection identifier.

 EndpointIdentifier getSecondEndpointIdentifier()
          Gets the Second Endpoint Identifier.

 EndpointIdentifier getSpecificEndpointIdentifier()
          Gets the Specific Endpoint Identifier.

 void setConnectionIdentifier(ConnectionIdentifier connectionIdentifier)
          Sets the Connection Identifier.

 void setLocalConnectionDescriptor(ConnectionDescriptor localConnectionDescriptor)
          Sets the Local Connection Descriptor string.

 void setSecondConnectionIdentifier(ConnectionIdentifier secondConnectionIdentifier)
          Sets the second connection identifier.

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

 java.lang.String toString()
          Overrides java.lang.Object.toString().
 
Methods inherited from class jain.protocol.ip.mgcp.JainMgcpResponseEvent
BuildResponseHeader, getReturnCode, setReturnCode
 
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

CreateConnectionResponse

public CreateConnectionResponse(java.lang.Object source,
                                ReturnCode returnCode,
                                ConnectionIdentifier connectionIdentifier)
                         throws java.lang.IllegalArgumentException
Constructs a new CreateConnectionResponse Event object.

Parameters:
returnCode - The return code.
transactionHandle - The transaction handle that corresponds to the Command Event that elicited this Response Event.
connectionIdentifier - A unique identifier for the connection within one endpoint.
Throws:
java.lang.IllegalArgumentException - Thrown if either the return code or the connection identifier parameter is null-valued.
Method Detail

getConnectionIdentifier

public ConnectionIdentifier getConnectionIdentifier()
Gets the Connection Identifier.

Returns:
The connection identifier.

getLocalConnectionDescriptor

public ConnectionDescriptor getLocalConnectionDescriptor()
Gets the Local Connection Descriptor.

Returns:
The session description that contains information about the addresses and RTP ports used for the connection.

getSecondConnectionIdentifier

public ConnectionIdentifier getSecondConnectionIdentifier()
Gets the second connection identifier.

Returns:
The second connection identifier.

getSecondEndpointIdentifier

public EndpointIdentifier getSecondEndpointIdentifier()
Gets the Second Endpoint Identifier.

Returns:
The second endpoint identifier.

getSpecificEndpointIdentifier

public EndpointIdentifier getSpecificEndpointIdentifier()
Gets the Specific Endpoint Identifier.

Returns:
The identifier for the responding endpoint.

setConnectionIdentifier

public void setConnectionIdentifier(ConnectionIdentifier connectionIdentifier)
                             throws java.lang.IllegalArgumentException
Sets the Connection Identifier.

Parameters:
connectionIdentifier - A unique identifier for the connection within one endpoint.
Throws:
java.lang.IllegalArgumentException - Thrown if the connection identifier parameter is null-valued.

setLocalConnectionDescriptor

public void setLocalConnectionDescriptor(ConnectionDescriptor localConnectionDescriptor)
Sets the Local Connection Descriptor string.

Parameters:
localConnectionDescriptor - Optional parameter. A session description that contains information about the addresses and RTP ports used for the connection. Must be set to null, if not used.

setSecondConnectionIdentifier

public void setSecondConnectionIdentifier(ConnectionIdentifier secondConnectionIdentifier)
Sets the second connection identifier.

Parameters:
secondConnectionIdentifier - Optional parameter. Identifies the second connection bound to the second endpoint, if that endpoint was specified in the CreateConnection command.

setSecondEndpointIdentifier

public void setSecondEndpointIdentifier(EndpointIdentifier secondEndpointIdentifier)
Sets the Second Endpoint Identifier. Used when two endpoints in the same gateway are to be connected.

Parameters:
secondEndpointIdentifier - Optional parameter. Reflects the second endpoint identifier that was specified in the CreateConnection command. Null, if none was specified.

setSpecificEndpointIdentifier

public void setSpecificEndpointIdentifier(EndpointIdentifier specificEndpointIdentifier)
EndpointIdentifier specificEndpointIdentifier Sets the Specific Endpoint Identifier.

Parameters:
specificEndpointIdentifier - Optional parameter. Identifies the responding endpoint. Must be set to null, if not used.

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.