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

jain.protocol.ip.mgcp.message
Class AuditEndpoint

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

public class AuditEndpoint
extends JainMgcpCommandEvent

An MGCP AuditEndpoint command, expressed as an event object, sent by a Call Agent to a Media Gateway to request the Gateway to send status information about one or more endpoints. This command elicits an AuditEndpointResponse event.

See Also:
AuditEndpointResponse, Serialized Form

Fields inherited from class java.util.EventObject
source
 
Constructor Summary
AuditEndpoint(java.lang.Object source, EndpointIdentifier endpointIdentifier)
          Constructs a new AuditEndpoint (Command) Event object that does not specify requested information.

AuditEndpoint(java.lang.Object source, EndpointIdentifier endpointIdentifier, InfoCode[] requestedInfo)
          Constructs a new AuditEndpoint (Command) Event object that specifies requested information.

 
Method Summary
 void clearAllReqInfoItems()
          Clears all the requested information items.
 InfoCode[] getRequestedInfo()
          Gets the currently set endpoint parameters to be returned by the gateway.
 void setRequestedInfo(InfoCode[] requestedInfo)
          Sets the endpoint parameters to be returned by the gateway.
 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

AuditEndpoint

public AuditEndpoint(java.lang.Object source,
                     EndpointIdentifier endpointIdentifier)
              throws java.lang.IllegalArgumentException
Constructs a new AuditEndpoint (Command) Event object that does not specify requested information.

Parameters:
endpointIdentifier - Name for the endpoint in the gateway where this command executes. This parameter may be specified using the "all of" wildcard convention. If this convention is used, the gateway should return the list of endpoint identifiers that match the wildcard. If a single endpoint is identified, the gateway should return a positive acknowledgment, with no additional information.
Throws:
java.lang.IllegalArgumentException - Thrown if the endpoint identifier parameter object reference is null-valued.

AuditEndpoint

public AuditEndpoint(java.lang.Object source,
                     EndpointIdentifier endpointIdentifier,
                     InfoCode[] requestedInfo)
              throws WildcardNotPermittedException,
                     java.lang.IllegalArgumentException
Constructs a new AuditEndpoint (Command) Event object that specifies requested information.

Parameters:
endpointIdentifier - Name for the endpoint in the gateway where this command executes. The "all of" wildcard convention must not be used with this form of constructor. If the endpoint identifier uses the wildcard convention, a WildcardNotPermittedException will be thrown.
requestedInfo - Specifies what information about the designated endpoint is to be returned by the gateway.
Throws:
WildcardNotPermittedException - Thrown if the endpoint identifier is specified using the wildcard convention.
java.lang.IllegalArgumentException - Thrown if:
  • the object reference for either the endpoint identifier or the requested information parameters is null-valued
  • or, the list of requested information parameters contains one or more parameters that are not valid for the AuditEndpoint command.
Method Detail

clearAllReqInfoItems

public void clearAllReqInfoItems()
Clears all the requested information items.

getRequestedInfo

public InfoCode[] getRequestedInfo()
Gets the currently set endpoint parameters to be returned by the gateway.

setRequestedInfo

public void setRequestedInfo(InfoCode[] requestedInfo)
                      throws java.lang.IllegalArgumentException
Sets the endpoint parameters to be returned by the gateway.
Parameters:
requestedInfo - Specifies what information about the designated endpoint is to be returned by the gateway.
Throws:
java.lang.IllegalArgumentException - Thrown if the list of requested information parameters contains one or more parameters that are not valid for the AuditEndpoint command or if the object reference to the requested information parameter is null-valued.

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.