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

jain.protocol.ip.mgcp.message
Class RestartInProgress

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

public final class RestartInProgress
extends JainMgcpCommandEvent

An MGCP RestartInProgress command. Sent by a Gateway to signal that an endpoint, or a group of endpoints, are being taken through a restart. This command elicits a RestartInProgressResponse event.

See Also:
RestartInProgressResponse, Serialized Form

Fields inherited from class java.util.EventObject
source
 
Constructor Summary
RestartInProgress(java.lang.Object source, EndpointIdentifier endpointIdentifier, RestartMethod restartMethod)
          Constructs a new RestartInProgress (Command) Event object.

 
Method Summary
 ReasonCode getReasonCode()
          Gets the Reason Code.

 int getRestartDelay()
          Gets the Restart Delay.

 RestartMethod getRestartMethod()
          Gets the Restart Method.

 void setReasonCode(ReasonCode reasonCode)
          Sets the Reason Code.

 void setRestartDelay(int restartDelay)
          Sets the Restart Delay.

 void setRestartMethod(RestartMethod restartMethod)
          Sets the Restart Method parameter.

 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

RestartInProgress

public RestartInProgress(java.lang.Object source,
                         EndpointIdentifier endpointIdentifier,
                         RestartMethod restartMethod)
                  throws java.lang.IllegalArgumentException
Constructs a new RestartInProgress (Command) Event object.

Parameters:
endpointIdentifier - Name for the endpoint in the gateway where this command executes.
restartMethod - Identifies the type of restart being done.
Throws:
java.lang.IllegalArgumentException - Thrown if the endpoint identifier or the restart method parameter is null-valued.
Method Detail

getReasonCode

public ReasonCode getReasonCode()
Gets the Reason Code.

Returns:
The Reason Code.

getRestartDelay

public int getRestartDelay()
Gets the Restart Delay.

Returns:
The Restart Delay.

getRestartMethod

public RestartMethod getRestartMethod()
Gets the Restart Method.

Returns:
The Restart Method.

setReasonCode

public void setReasonCode(ReasonCode reasonCode)
Sets the Reason Code.

Parameters:
reasonCode - Optional parameter. The Reason Code.

setRestartDelay

public void setRestartDelay(int restartDelay)
                     throws java.lang.IllegalArgumentException
Sets the Restart Delay.

Parameters:
restartDelay - Optional parameter. The Restart Delay, in seconds.
Throws:
java.lang.IllegalArgumentException - Thrown if restart delay is not in the range 0-999999.

setRestartMethod

public void setRestartMethod(RestartMethod restartMethod)
                      throws java.lang.IllegalArgumentException
Sets the Restart Method parameter.

Parameters:
restartMethod - Identifies the type of restart being done.
Throws:
java.lang.IllegalArgumentException - Thrown if the restart method 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.