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

jain.protocol.ip.mgcp.message
Class AuditConnection

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

public final class AuditConnection
extends JainMgcpCommandEvent

An MGCP AuditConnection command, expressed as an event object, sent by a Call Agent to a Media Gateway to request the Gateway to send parameters of a connection. This command elicits an AuditConnectionResponse event.

See Also:
AuditConnectionResponse, Serialized Form

Fields inherited from class java.util.EventObject
source
 
Constructor Summary
AuditConnection(java.lang.Object source, EndpointIdentifier endpointIdentifier, ConnectionIdentifier connectionIdentifier, InfoCode[] requestedInfo)
          Constructs a new AuditConnection (Command) Event object.

 
Method Summary
 ConnectionIdentifier getConnectionIdentifier()
          Gets the Connection Identifier.

 InfoCode[] getRequestedInfo()
          Returns the list of connection parameters the gateway is to return in response to an AuditConnection command.
 void setConnectionIdentifier(ConnectionIdentifier connectionIdentifier)
          Sets the Connection Identifier.

 void setRequestedInfo(InfoCode[] requestedInfo)
          Sets the list of connection parameters the gateway is to return in response to an AuditConnection command.
 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

AuditConnection

public AuditConnection(java.lang.Object source,
                       EndpointIdentifier endpointIdentifier,
                       ConnectionIdentifier connectionIdentifier,
                       InfoCode[] requestedInfo)
                throws java.lang.IllegalArgumentException
Constructs a new AuditConnection (Command) Event object.

Parameters:
source - A reference to the object that fired this event. In the case where the JainMgcpProvider fires the event, this parameter should be a reference to the object that implements the JainMgcpProvider interface. In the case where the application (the JainMgcpListener) fires the event, this parameter should be a reference to the object that implements the JainMgcpListener interface.
endpointIdentifier - Name for the endpoint in the gateway where this command executes.
connectionIdentifier - Identifies the connection within the endpoint whose characteristics are being modified.
requestedInfo - Specifies which connection parameters are to be returned by the gateway in response to this command.
transactionHandle - A handle to be used in associating a Response Event object with the Command Event object that elicited it.
Throws:
java.lang.IllegalArgumentException - Thrown if:
  • Any one or all of the endpoint identifier, connection identifier, and the list of requested information parameters is (are) null-valued.
  • Any of the requested information parameters in the list of requested information parameters is null-valued.
  • Any of the requested information parameters in the list of requested information parameters is not valid for the AuditConnection command.
Method Detail

getConnectionIdentifier

public ConnectionIdentifier getConnectionIdentifier()
Gets the Connection Identifier.

Returns:
The Connection Identifier.

getRequestedInfo

public InfoCode[] getRequestedInfo()
Returns the list of connection parameters the gateway is to return in response to an AuditConnection command.

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 object reference is null.

setRequestedInfo

public void setRequestedInfo(InfoCode[] requestedInfo)
                      throws java.lang.IllegalArgumentException
Sets the list of connection parameters the gateway is to return in response to an AuditConnection command.
Parameters:
requestedInfo - The list of connection parameters.
Throws:
java.lang.IllegalArgumentException - Thrown if one or more of the requested connection parameters are not valid for the AuditConnection command, or if the requested information parameter object reference is null.

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.