com.kapowtech.robosuite.api.java.rql

Class RobotExecutor

java.lang.Object

com.kapowtech.robosuite.api.java.rql.RobotExecutor

Deprecated.

You should use the Request class class to execute robots. Check the Java Programmers Guide of the online documentation.

public final class RobotExecutor
extends java.lang.Object

Provides a convenient way to run RQL requests.

See Also:

Request

Method Summary

Modifier and Type	Method and Description
RQLResult	execute(ExecuteRequestBuilder executeRequestBuilder) Deprecated. Extracts an ExecuteRequest from the supplied ExecuteRequestBuilder, and executes it.
RQLResult	execute(java.lang.String robotUrl) Deprecated. Executes a robot specific robot with no input.
RQLResult	execute(java.lang.String robotUrl, RQLObject inputObject) Deprecated. will be removed in a future release, use execute(ExecuteRequestBuilder)
RQLResult	execute(java.lang.String robotUrl, RQLObjects inputObjects) Deprecated. will be removed in a future release, use execute(ExecuteRequestBuilder)
static RobotExecutor	getRobotExecuter(RQLEngine engine, RQLHandler handler) Deprecated. this method has been renamed to getRobotExecutor(com.kapowtech.robosuite.api.java.rql.engine.RQLEngine, com.kapowtech.robosuite.api.java.rql.engine.RQLHandler).
static RobotExecutor	getRobotExecutor() Deprecated. Returns a RobotExecutor instance that uses the default RQL engine.
static RobotExecutor	getRobotExecutor(RQLEngine engine) Deprecated. Returns a RobotExecutor instance that uses the specified RQL engine.
static RobotExecutor	getRobotExecutor(RQLEngine engine, RQLHandler handler) Deprecated. Returns a RobotExecutor instance that uses the specified RQL engine and RQL handler.
static RobotExecutor	getRobotExecutor(RQLHandler handler) Deprecated. Returns a RobotExecutor instance that uses the default RQL engine, and the specified RQL handler.
static RobotExecutor	getRobotExecutor(java.lang.String host, int port) Deprecated. Returns a RobotExecutor instance that uses a RemoteRQLEngine using a socket based protocol, and the specified host and port.
RQLEngine	getRQLEngine() Deprecated. Returns the RQLEngine that is used to execute the queries.
RQLHandler	getRQLHandler() Deprecated. Resutns the RQLHandler that is used to handle the RQLResponses and exceptions generated by the RQLEngine.
RQLResult	ping() Deprecated. Ping's RoboServer.
RQLResult	request(RQLRequest request) Deprecated. Processes an RQLRequest.
RQLResult	stop(java.lang.String executeId) Deprecated. Requests that a robot with a specific execution id is stopped.
RQLResult	stop(java.lang.String executeId, java.lang.String username, java.lang.String password) Deprecated. Requests that a robot with a specific execution id is stopped.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getRobotExecutor

public static RobotExecutor getRobotExecutor()

Deprecated.

Returns a RobotExecutor instance that uses the default RQL engine.

The default RQL Engine is a DeploymentSupportRQLEngine that can be configured by editing the resource: com.kapowtech.robosuite.api.java.rql.default-engine-deploy.xml. To override the default engine settings, place a file with an identical name in the classpath.

Returns:

a RobotExecutor instance that uses the default RQL engine.

See Also:

DeploymentSupportRQLEngine

getRobotExecutor

public static RobotExecutor getRobotExecutor(RQLEngine engine)

Deprecated.

Returns a RobotExecutor instance that uses the specified RQL engine.

Parameters:

engine - the RQLEngine that will process the requests.

Returns:

a RobotExecutor instance that uses the specified RQL engine.

getRobotExecutor

public static RobotExecutor getRobotExecutor(java.lang.String host,
                                             int port)

Deprecated.

Returns a RobotExecutor instance that uses a RemoteRQLEngine using a socket based protocol, and the specified host and port.

Parameters:

host - the host name to connect to. A RoboServer running on the same machine will have a host name of localhost.

port - the port number that RoboServer listens on. RoboServers default listen port is 50000.

Returns:

a RobotExecutor instance that uses a RemoteRQLEngine using a socket based protocol, and the specified host and port.

getRobotExecutor

public static RobotExecutor getRobotExecutor(RQLHandler handler)

Deprecated.

Returns a RobotExecutor instance that uses the default RQL engine, and the specified RQL handler.

The default RQL Engine is a DeploymentSupportRQLEngine that can be configured by editing the resource: com.kapowtech.robosuite.api.java.rql.default-engine-deploy.xml. To override the default engine settings, place a file with an identical name in the classpath.

Parameters:

handler - the RQLHandler to use.

Returns:

a RobotExecutor instance that uses the default RQL engine.

See Also:

DeploymentSupportRQLEngine

getRobotExecutor

public static RobotExecutor getRobotExecutor(RQLEngine engine,
                                             RQLHandler handler)

Deprecated.

Returns a RobotExecutor instance that uses the specified RQL engine and RQL handler.

Parameters:

engine - the RQLEngine to use when executing the requests.

handler - the RQLHandler to use.

Returns:

a RobotExecutor instance that uses the default RQL engine.

See Also:

DeploymentSupportRQLEngine

getRobotExecuter

public static RobotExecutor getRobotExecuter(RQLEngine engine,
                                             RQLHandler handler)

Deprecated. this method has been renamed to getRobotExecutor(com.kapowtech.robosuite.api.java.rql.engine.RQLEngine, com.kapowtech.robosuite.api.java.rql.engine.RQLHandler).

Returns a RobotExecutor instance that uses the specified RQL engine and RQL handler.

Parameters:

engine - the RQLEngine to use when executing the requests.

handler - the RQLHandler to use.

Returns:

a RobotExecutor instance that uses the default RQL engine.

See Also:

DeploymentSupportRQLEngine

execute

public RQLResult execute(java.lang.String robotUrl,
                         RQLObjects inputObjects)
                  throws RQLException

Deprecated. will be removed in a future release, use execute(ExecuteRequestBuilder)

Executes a robot specific robot with input This is done by sending an ExecuteRequest to a RoboServer.

The objects that are extracted by the robot can be accessed by invoking the getObjects method on the returned RQLResult object.

Parameters:

robotUrl - the robot URL to request

inputObjects - the input objects to pass to the robot.

Returns:

an object representing the result of the execution.

Throws:

RQLException - if the execution fails for some reason.

java.lang.NullPointerException - if either of the parameters are null.

See Also:

ExecuteRequest, RQLResult.getObjects()

execute

public RQLResult execute(java.lang.String robotUrl,
                         RQLObject inputObject)
                  throws RQLException

Deprecated. will be removed in a future release, use execute(ExecuteRequestBuilder)

Executes a robot specific robot with one query parameter. This is done by sending an ExecuteRequest to a RoboServer.

The objects that are extracted by the robot can be accessed by invoking the getObjects method on the returned RQLResult object.

Parameters:

robotUrl - the robot URL to request

inputObject - the single input object to pass to the robot.

Returns:

an object representing the result of the execution.

Throws:

RQLException - if the execution fails for some reason.

java.lang.NullPointerException - if either of the parameters are null.

See Also:

ExecuteRequest, RQLResult.getObjects()

execute

public RQLResult execute(java.lang.String robotUrl)
                  throws RQLException

Deprecated.

Executes a robot specific robot with no input. This is done by sending an ExecuteRequest to a RoboServer.

The objects that are extracted by the robot can be accessed by invoking the getObjects method on the returned RQLResult object.

Parameters:

robotUrl - the robot URL to request

Returns:

an object representing the result of the execution.

Throws:

RQLException - if the execution fails for some reason.

java.lang.NullPointerException - if the robotUrl parameter is null.

See Also:

ExecuteRequest, RQLResult.getObjects()

execute

public RQLResult execute(ExecuteRequestBuilder executeRequestBuilder)
                  throws RQLException

Deprecated.

Extracts an ExecuteRequest from the supplied ExecuteRequestBuilder, and executes it. This convenience method performs the equivalent action as a call to execute(executeRequestBuilder.toExecuteRequest().

Parameters:

executeRequestBuilder - a mutable version of an ExecuteRequest that is provided for convenience.

Returns:

an object representing the result of the execution.

Throws:

RQLException - if the execution fails for some reason.

java.lang.IllegalArgumentException - if the robotUrl parameter is not set in the ExecuteRequestBuilder.

See Also:

ExecuteRequest, RQLResult.getObjects()

stop

public RQLResult stop(java.lang.String executeId)
               throws RQLException

Deprecated.

Requests that a robot with a specific execution id is stopped. This is done by sending an StopRequest to a RoboServer.

Normally this method does not make much sense when executing robots synchronously. When a robot is executed synchronously with a call to RobotExecutor.request(), the execution has ended when the method returns. It can be used to stop robots that are being run by another thread. Use a status request to get a snapshot of all executing robots and their ids, and invoke this method to stop them.

Parameters:

executeId - the execution Id of the robot. This id is the same as the one returned from an ServerExecutionEventResponse. It can also be obtained from an asynchronously executing robot by calling getExecutionId on its FutureRQLResult.

Returns:

an object representing the result of the stop request.

Throws:

RQLException - if the execution fails for some reason.

java.lang.NullPointerException - if executeId parameter is null.

See Also:

StopRequest

stop

public RQLResult stop(java.lang.String executeId,
                      java.lang.String username,
                      java.lang.String password)
               throws RQLException

Deprecated.

Requests that a robot with a specific execution id is stopped. This is done by sending an StopRequest to a RoboServer.

Normally this method does not make much sense when executing robots synchronously. When a robot is executed synchronously with a call to RobotExecutor.request(), the execution has ended when the method returns. It can be used to stop robots that are being run by another thread. Use a status request to get a snapshot of all executing robots and their ids, and invoke this method to stop them.

Parameters:

executeId - the execution Id of the robot. This id is the same as the one returned from an ServerExecutionEventResponse. It can also be obtained from an asynchronously executing robot by calling getExecutionId on its FutureRQLResult.

username - userName if RoboServer authentication is enabled

password - password if password authentication is enabled

Returns:

an object representing the result of the stop request.

Throws:

RQLException - if the execution fails for some reason.

java.lang.NullPointerException - if executeId parameter is null.

See Also:

StopRequest

ping

public RQLResult ping()
               throws RQLException

Deprecated.

Ping's RoboServer. This can be done to check whether RoboServer is listening on a given protocol.

Returns:

an object representing the result of the execution, possibly containing one or more PingResponse objects.

Throws:

RQLException - if the execution fails for some reason.

See Also:

PingRequest, PingResponse

request

public RQLResult request(RQLRequest request)
                  throws RQLException

Deprecated.

Processes an RQLRequest. This method is more general than the other methods in this class.

Parameters:

request - the RQLRequest to send to the RoboServer.

Returns:

an object representing the result of the request.

Throws:

RQLException - if the execution fails for some reason.

java.lang.NullPointerException - if either of the parameters are null.

See Also:

ExecuteRequest, StopRequest

getRQLEngine

public RQLEngine getRQLEngine()

Deprecated.

Returns the RQLEngine that is used to execute the queries.

This method provides a way to access the default RQL engine:

   RQLEngine defaultEngine = RobotExecutor.getRobotQuery().getRQLEngine();
 

Returns:

the RQLEngine that is used to execute the queries.

getRQLHandler

public RQLHandler getRQLHandler()

Deprecated.

Resutns the RQLHandler that is used to handle the RQLResponses and exceptions generated by the RQLEngine.

Returns:

the RQLHandler that is used to handle the RQLResponses and exceptions generated by the RQLEngine.