com.kapowtech.robosuite.api.java.rql.construct

Class ShutdownRequest

java.lang.Object

com.kapowtech.robosuite.api.java.rql.construct.RQLConstruct

com.kapowtech.robosuite.api.java.rql.construct.RQLRequest

com.kapowtech.robosuite.api.java.rql.construct.ShutdownRequest

All Implemented Interfaces:

java.io.Serializable

public class ShutdownRequest
extends RQLRequest

Request object sent to RoboServer to Restart it or Shut it down

See Also:

Serialized Form

Field Summary

Fields inherited from class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest

AUTHENTICATION_ENABLED_PREFIX, TRIAL_VERSION_LIMITATION_PREFIX

Constructor Summary

Constructors

Constructor and Description
ShutdownRequest(ShutdownMethod method, int timeout) Creates a shutdown request
ShutdownRequest(ShutdownMethod argument, int timeout, java.lang.String hostName, java.lang.String ipAddress, java.lang.String username, java.lang.String password)
ShutdownRequest(ShutdownMethod method, java.lang.String hostName, java.lang.String ipAddress, java.lang.String username, java.lang.String password)

Method Summary

Modifier and Type	Method and Description
ShutdownMethod	getShutdownMethod() Get the argument for the shutdown
int	getTimeout() The timeout in Seconds.

Methods inherited from class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest

equals, getHostName, getIPAddress, getPassword, getUsername, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ShutdownRequest

public ShutdownRequest(ShutdownMethod argument,
                       int timeout,
                       java.lang.String hostName,
                       java.lang.String ipAddress,
                       java.lang.String username,
                       java.lang.String password)

Parameters:

argument - Controls whether the server should be shutdown or restarted and when

timeout - Timeout period in seconds before the server should force the shutdown/restart

hostName - hostname of destination

ipAddress - ip address of destination

username - the username used to authenticate

password - the password to use to authenticate

ShutdownRequest

public ShutdownRequest(ShutdownMethod method,
                       java.lang.String hostName,
                       java.lang.String ipAddress,
                       java.lang.String username,
                       java.lang.String password)

Parameters:

method - Controls whether the server should be shutdown or restarted and when

hostName - hostname of destination

ipAddress - ip address of destination

username - the username used to authenticate

password - the password to use to authenticate

ShutdownRequest

public ShutdownRequest(ShutdownMethod method,
                       int timeout)

Creates a shutdown request

Parameters:

method - to shutdown or restart?

timeout - timeout after which the server must force the action

Method Detail

getShutdownMethod

public ShutdownMethod getShutdownMethod()

Get the argument for the shutdown

Returns:

the argument

getTimeout

public int getTimeout()

The timeout in Seconds. The server should force a restart/shutdown when this timeout has elapsed

Returns:

the timeout value