jain.protocol.ip.mgcp.message
Class AuditEndpointResponse

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ip.mgcp.JainMgcpEvent
              |
              +--jain.protocol.ip.mgcp.JainMgcpResponseEvent
                    |
                    +--jain.protocol.ip.mgcp.message.AuditEndpointResponse

All Implemented Interfaces:

java.io.Serializable

public final class AuditEndpointResponse

extends JainMgcpResponseEvent

The acknowledgment to an MGCP AuditEndpoint command.

See Also:

AuditEndpoint, Serialized Form

Fields inherited from class java.util.EventObject

source

Constructor Summary

AuditEndpointResponse(java.lang.Object source, ReturnCode returnCode)
Constructs a new AuditEndpointResponse Event object that either returns positive acknowledgment, if none of the optional parameters are set, or returns whatever optional parameters are set, along with the Return Code.

AuditEndpointResponse(java.lang.Object source, ReturnCode returnCode, EndpointIdentifier[] endpointIdentifierList)
Constructs a new AuditEndpointResponse Event object that returns a list of endpoint identifiers in response to an AuditEndpoint command in which the Endpoint Identifier parameter was specified using the wildcard convention.

Method Summary

BearerInformation	getBearerInformation() Gets the Bearer Information.
CapabilityValue[]	getCapabilities() Gets the list of endpoint capabilities.
ConnectionIdentifier[]	getConnectionIdentifiers() Gets the Connection Identifiers.
EventName[]	getDetectEvents() Gets the list of MGCP events that the endpoint has been instructed to detect.
DigitMap	getDigitMap() Gets the Digit Map.
EndpointIdentifier[]	getEndpointIdentifierList() Gets the Endpoint Identifier list.
EventName[]	getEventStates() Gets the Event States.
NotifiedEntity	getNotifiedEntity() Gets the NotifiedEntity.
EventName[]	getObservedEvents() Gets the Observed Events.
ReasonCode	getReasonCode() Gets the Reason Code.
RequestedEvent[]	getRequestedEvents() Gets the Requested Events.
RequestIdentifier	getRequestIdentifier() Gets the Request Identifier.
int	getRestartDelay() Gets the Restart Delay.
RestartMethod	getRestartMethod() Gets the Restart Method.
EventName[]	getSignalRequests() Gets the Signal Requests.
void	setBearerInformation(BearerInformation bearerInformation) Sets the Bearer Information.
void	setCapabilities(CapabilityValue[] capabilities) Sets the endpoint capabilities parameter.
void	setConnectionIdentifiers(ConnectionIdentifier[] connectionIdentifiers) Sets the Connection Identifiers.
void	setDetectEvents(EventName[] detectEvents) Sets the list of MGCP events that the endpoint has been instructed to detect.
void	setDigitMap(DigitMap digitMap) Sets the Digit Map.
void	setEndpointIdentifierList(EndpointIdentifier[] endpointIdentifierList) Sets the Endpoint Identifier list.
void	setEventStates(EventName[] eventStates) Sets the Event States.
void	setNotifiedEntity(NotifiedEntity notifiedEntity) Sets the NotifiedEntity.
void	setObservedEvents(EventName[] observedEvents) Sets the Observed Events.
void	setReasonCode(ReasonCode reasonCode) Sets the Reason Code.
void	setRequestedEvents(RequestedEvent[] requestedEvents) Sets the Requested Events.
void	setRequestIdentifier(RequestIdentifier requestIdentifier) Sets the Request Identifier.
void	setRestartDelay(int restartDelay) Sets the Restart Delay.
void	setRestartMethod(RestartMethod restartMethod) Sets the Restart Method.
void	setSignalRequests(EventName[] signalRequests) Sets the Signal Requests.
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

AuditEndpointResponse

public AuditEndpointResponse(java.lang.Object source,
                             ReturnCode returnCode)
                      throws java.lang.IllegalArgumentException

Constructs a new AuditEndpointResponse Event object that either returns positive acknowledgment, if none of the optional parameters are set, or returns whatever optional parameters are set, along with the Return Code.

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 the return code parameter object reference is null-valued.

AuditEndpointResponse

public AuditEndpointResponse(java.lang.Object source,
                             ReturnCode returnCode,
                             EndpointIdentifier[] endpointIdentifierList)
                      throws java.lang.IllegalArgumentException

Constructs a new AuditEndpointResponse Event object that returns a list of endpoint identifiers in response to an AuditEndpoint command in which the Endpoint Identifier parameter was specified using the wildcard convention.

Parameters:

returnCode - The return code.

transactionHandle - The transaction handle that corresponds to the Command Event that elicited this Response Event.

endpointIdentifierList - An array of endpoint identifiers. The endpoint identifiers are those that match the wildcard specification given in the eliciting AuditEndpoint command.

Throws:

java.lang.IllegalArgumentException - Thrown if the object reference to the return code parameter or to the list of endpoint identifiers is null-valued, or if any of the endpoint identifiers in the list of endpoint identifiers is null-valued.

Method Detail

getBearerInformation

public BearerInformation getBearerInformation()

Gets the Bearer Information.

Returns:

The Bearer Information

getCapabilities

public CapabilityValue[] getCapabilities()

Gets the list of endpoint capabilities.

Returns:

The list of endpoint capability values.

getConnectionIdentifiers

public ConnectionIdentifier[] getConnectionIdentifiers()

Gets the Connection Identifiers.

Returns:

The Connection Identifiers as an array of ConnectionId objects.

getDetectEvents

public EventName[] getDetectEvents()

Gets the list of MGCP events that the endpoint has been instructed to detect.

Returns:

The list of MGCP events that the endpoint has been instructed to detect.

getDigitMap

public DigitMap getDigitMap()

Gets the Digit Map.

Returns:

The Digit Map.

getEndpointIdentifierList

public EndpointIdentifier[] getEndpointIdentifierList()

Gets the Endpoint Identifier list.

Returns:

An array of endpoint identifiers.

getEventStates

public EventName[] getEventStates()

Gets the Event States.

Returns:

The Event States

getNotifiedEntity

public NotifiedEntity getNotifiedEntity()

Gets the NotifiedEntity.

Returns:

The Notified Entity.

getObservedEvents

public EventName[] getObservedEvents()

Gets the Observed Events.

Returns:

The Observed Events.

getReasonCode

public ReasonCode getReasonCode()

Gets the Reason Code.

Returns:

The Reason Code

getRequestedEvents

public RequestedEvent[] getRequestedEvents()

Gets the Requested Events.

Returns:

The Requested Events.

getRequestIdentifier

public RequestIdentifier getRequestIdentifier()

Gets the Request Identifier.

Returns:

The Request Identifier.

getRestartDelay

public int getRestartDelay()

Gets the Restart Delay.

Returns:

The Restart Delay

getRestartMethod

public RestartMethod getRestartMethod()

Gets the Restart Method.

Returns:

The Restart Method

getSignalRequests

public EventName[] getSignalRequests()

Gets the Signal Requests.

Returns:

The Signal Requests

setBearerInformation

public void setBearerInformation(BearerInformation bearerInformation)

Sets the Bearer Information.

Parameters:

bearerInformation - The Bearer Information.

setCapabilities

public void setCapabilities(CapabilityValue[] capabilities)

Sets the endpoint capabilities parameter.

Parameters:

capabilities - A list of endpoint capability values.

setConnectionIdentifiers

public void setConnectionIdentifiers(ConnectionIdentifier[] connectionIdentifiers)

Sets the Connection Identifiers.

Parameters:

connectionIdentifiers - The Connection Identifiers

setDetectEvents

public void setDetectEvents(EventName[] detectEvents)

Sets the list of MGCP events that the endpoint has been instructed to detect.

Parameters:

detectEvents - The list of MGCP events that the endpoint has been instructed to detect.

setDigitMap

public void setDigitMap(DigitMap digitMap)

Sets the Digit Map.

Parameters:

digitMap - The Digit Map.

setEndpointIdentifierList

public void setEndpointIdentifierList(EndpointIdentifier[] endpointIdentifierList)
                               throws java.lang.IllegalArgumentException

Sets the Endpoint Identifier list.

Parameters:

endpointIdentifierList - An array of endpoint identifiers.

Throws:

java.lang.IllegalArgumentException - Thrown if the object reference to the list of endpoint identifiers is null-valued, or if any of the endpoint identifiers in the list of endpoint identifiers is null-valued.

setEventStates

public void setEventStates(EventName[] eventStates)

Sets the Event States.

Parameters:

eventStates - The Event States

setNotifiedEntity

public void setNotifiedEntity(NotifiedEntity notifiedEntity)

Sets the NotifiedEntity.

Parameters:

notifiedEntity - The Notified Entity.

setObservedEvents

public void setObservedEvents(EventName[] observedEvents)

Sets the Observed Events.

Parameters:

observedEvents - The Observed Events

setReasonCode

public void setReasonCode(ReasonCode reasonCode)

Sets the Reason Code.

Parameters:

reasonCode - The Reason Code

setRequestedEvents

public void setRequestedEvents(RequestedEvent[] requestedEvents)

Sets the Requested Events.

Parameters:

requestedEvents - The Requested Events.

setRequestIdentifier

public void setRequestIdentifier(RequestIdentifier requestIdentifier)

Sets the Request Identifier.

Parameters:

requestIdentifier - The Request Identifier

setRestartDelay

public void setRestartDelay(int restartDelay)
                     throws java.lang.IllegalArgumentException

Sets the Restart Delay.

Parameters:

restartDelay - The Restart Delay

Throws:

java.lang.IllegalArgumentException - Thrown if restart delay is not in the range 0-999999.

setRestartMethod

public void setRestartMethod(RestartMethod restartMethod)

Sets the Restart Method.

Parameters:

restartMethod - The Restart Method

setSignalRequests

public void setSignalRequests(EventName[] signalRequests)

Sets the Signal Requests.

Parameters:

signalRequests - The Signal Requests.

toString

public java.lang.String toString()

Overrides java.lang.Object.toString().

Overrides:

toString in class java.util.EventObject