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

jain.protocol.ip.mgcp.message
Class AuditConnectionResponse

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

public final class AuditConnectionResponse
extends JainMgcpResponseEvent

The acknowledgment to an MGCP AuditConnection command.

See Also:
AuditConnection, Serialized Form

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

 
Method Summary
 CallIdentifier getCallIdentifier()
          Gets the Call Identifier.

 ConnectionParm[] getConnectionParms()
          Gets the Connection Parameters.

 ConnectionDescriptor getLocalConnectionDescriptor()
          Gets the Local Connection Descriptor.

 LocalOptionValue[] getLocalConnectionOptions()
          Gets the Local Connection Options.

 ConnectionMode getMode()
          Gets the mode.

 NotifiedEntity getNotifiedEntity()
          Gets the Notified Entity.

 ConnectionDescriptor getRemoteConnectionDescriptor()
          Gets the Remote Connection Descriptor.

 void setCallIdentifier(CallIdentifier callIdentifier)
          Sets the Call Identifier.

 void setConnectionParms(ConnectionParm[] connectionParms)
          Sets the Connection Parameters.

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

 void setLocalConnectionOptions(LocalOptionValue[] localConnectionOptions)
          Sets the Local Connection Options.

 void setMode(ConnectionMode mode)
          Sets the mode.

 void setNotifiedEntity(NotifiedEntity notifiedEntity)
          Sets the Notified Entity.

 void setRemoteConnectionDescriptor(ConnectionDescriptor remoteConnectionDescriptor)
          Sets the Remote Connection Descriptor string.

 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

AuditConnectionResponse

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

Parameters:
returnCode - The return code.
transactionHandle - The transaction handle that corresponds to the Command Event that elicited this Response Event.
Throws:
java.lang.IllegalArgumentException - Thrown if return code parameter object reference is null-valued.
Method Detail

getCallIdentifier

public CallIdentifier getCallIdentifier()
Gets the Call Identifier.

Returns:
The current call identifier for this connection.

getConnectionParms

public ConnectionParm[] getConnectionParms()
Gets the Connection Parameters.

Returns:
The current set of parameters that describe the status of this connection.

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.

getLocalConnectionOptions

public LocalOptionValue[] getLocalConnectionOptions()
Gets the Local Connection Options.

Returns:
The list of current Local Connection Options for this connection.

getMode

public ConnectionMode getMode()
Gets the mode.

Returns:
The current mode for this connection.

getNotifiedEntity

public NotifiedEntity getNotifiedEntity()
Gets the Notified Entity.

Returns:
The current notified entity for this connection.

getRemoteConnectionDescriptor

public ConnectionDescriptor getRemoteConnectionDescriptor()
Gets the Remote Connection Descriptor.

Returns:
The current description of the remote connection.

setCallIdentifier

public void setCallIdentifier(CallIdentifier callIdentifier)
Sets the Call Identifier.

Parameters:
callIdentifier - The current call identifier for this connection.

setConnectionParms

public void setConnectionParms(ConnectionParm[] connectionParms)
Sets the Connection Parameters.

Parameters:
connectionParms - The current list of connection parameters that describe the status of the connection.

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.

setLocalConnectionOptions

public void setLocalConnectionOptions(LocalOptionValue[] localConnectionOptions)
Sets the Local Connection Options.

Parameters:
localConnectionOptions - The list of current Local Connection Options for this connection.

setMode

public void setMode(ConnectionMode mode)
Sets the mode.

Parameters:
mode - The current mode for this connection.

setNotifiedEntity

public void setNotifiedEntity(NotifiedEntity notifiedEntity)
Sets the Notified Entity.

Parameters:
notifiedEntity - The current notified entity for this connection.

setRemoteConnectionDescriptor

public void setRemoteConnectionDescriptor(ConnectionDescriptor remoteConnectionDescriptor)
Sets the Remote Connection Descriptor string.

Parameters:
remoteConnectionDescriptor - The current description of the remote connection.

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.