com.kapowtech.robosuite.api.java.rest

Class QueuedRequest

java.lang.Object

com.kapowtech.robosuite.api.java.rest.QueuedRequest

public final class QueuedRequest
extends java.lang.Object

This request will use the Management Console queue mechanism to run the request.

The robot will be placed in the queue on the Management Console:

• Robots will queue, when certain resources (for instance devices) are not available.
• Many settings, such as clusters and servers, are managed on the project level by Management Console.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueuedRequest.Priority Queue priority for the robot.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_POLLING_INTERVAL

Constructor Summary

Constructors

Constructor and Description
QueuedRequest(java.lang.String managementConsoleUrl, java.lang.String robotPath, java.lang.String projectName, java.lang.String apiKey) Creates a new QueuedRequest with the specified robot URL.
QueuedRequest(java.lang.String managementConsoleUrl, java.lang.String robotPath, java.lang.String projectName, java.lang.String apiKey, QueuedRequest.Priority priority, long queueTimeout) Creates a new QueuedRequest with the specified Management Console, robot path and project, priority and timeout time.

Method Summary

Modifier and Type	Method and Description
void	cancel() Signals the execution to stop.
RpaObjectBuilder	createInputVariable(java.lang.String name) Creates a new input Object with the specified name, and returns an RpaObjectBuilder that can be used to build the object.
void	createInputVariable(java.lang.String name, RpaObject object) Creates a new Input Object with the specified name, from an RpaObject.
void	createOAuthInputVariable(java.lang.String name, java.lang.String userName, java.lang.String applicationName) Creates an input variable for an OAUTH input type, that will look up the OAuth details in Management Console based on the given username and application name.
ExecutionResult	execute() Executes the robot request.
void	execute(RobotResponseHandler handler) Executes the robot request, using a custom response handler.
java.util.List<Response>	getInterimResults() Retrieves intermediary results from an ongoing execution.
int	getPollingIntervalMillis() The current polling interval.
QueuedRequest.Priority	getPriority() The current priority.
java.lang.String	getProject() Get the project for this request
java.lang.String	getRobotURL() Returns the currently configured robotURL property.
long	getTimeout() Gets the current timeout.
void	setPollingIntervalMillis(int pollingIntervalMillis) Updates to the robot execution status as well as obtaining return values and API exception errors are updated by polling.
void	setPriority(QueuedRequest.Priority priority) Sets the priority of the queued task as long as it is in the Management Console queue.
void	setProject(java.lang.String project) Set the project name for this request.
void	setRobotURL(java.lang.String robotURL) Sets the robotURL property.
void	setStopRobotOnApiException(boolean stopOnError) Specifies whether robot execution should stop if an error occurs in the robot, corresponding to the 'API Exception' checkmark as specified on a robot step.
void	setTimeout(long timeout) Sets the timeout for how long the robot will stay in the queue while it waits for execution.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_POLLING_INTERVAL

public static final int DEFAULT_POLLING_INTERVAL

See Also:

Constant Field Values

Constructor Detail

QueuedRequest

public QueuedRequest(java.lang.String managementConsoleUrl,
                     java.lang.String robotPath,
                     java.lang.String projectName,
                     java.lang.String apiKey)

Creates a new QueuedRequest with the specified robot URL.

Parameters:

managementConsoleUrl - URL of the Management Console to use. E.g. 'http://localhost:8080/ManagementConsole'.

robotPath - the path of the robot to execute. E.g. 'Folder/Robot.robot'.

projectName - the project name of the robot. E.g. 'Default project'

apiKey - API key to use for authentication.

QueuedRequest

public QueuedRequest(java.lang.String managementConsoleUrl,
                     java.lang.String robotPath,
                     java.lang.String projectName,
                     java.lang.String apiKey,
                     QueuedRequest.Priority priority,
                     long queueTimeout)

Creates a new QueuedRequest with the specified Management Console, robot path and project, priority and timeout time. Uses the given API key for authentication.

Parameters:

managementConsoleUrl - URL of the Management Console to use. E.g. 'http://localhost:8080/ManagementConsole'.

robotPath - the path of the robot to execute. E.g. 'Folder/Robot.robot'.

projectName - the project name of the robot. E.g. 'Default project'

apiKey - API key to use for authentication.

priority - the priority of the robot to execute.

queueTimeout - the queue timeout of the robot to execute.

Method Detail

getPollingIntervalMillis

public int getPollingIntervalMillis()

The current polling interval.

Returns:

current polling interval.

setPollingIntervalMillis

public void setPollingIntervalMillis(int pollingIntervalMillis)

Updates to the robot execution status as well as obtaining return values and API exception errors are updated by polling.

This parameter sets the interval in milliseconds between polls. Short intervals may cause more load on the Management Console, but will increase the update rate of this request.

The default value is 1000 ms.

Parameters:

pollingIntervalMillis - the polling interval to use for this request, in milliseconds.

getRobotURL

public java.lang.String getRobotURL()

Returns the currently configured robotURL property.

Returns:

the currently configured robotURL property.

setRobotURL

public void setRobotURL(java.lang.String robotURL)

Sets the robotURL property.

Parameters:

robotURL - the new URL to the robot.

createInputVariable

public RpaObjectBuilder createInputVariable(java.lang.String name)

Creates a new input Object with the specified name, and returns an RpaObjectBuilder that can be used to build the object.

Parameters:

name - the name of the input object.

Returns:

an RpaObjectBuilder that can be used to build the object.

createInputVariable

public void createInputVariable(java.lang.String name,
                                RpaObject object)

Creates a new Input Object with the specified name, from an RpaObject. This is useful if responses from one Robot should be used as input to another.

Parameters:

name - the name of the input object.

object - the rpa object

getProject

public java.lang.String getProject()

Get the project for this request

Returns:

the project name or null if not configured

setProject

public void setProject(java.lang.String project)

Set the project name for this request.

Parameters:

project - the project name

execute

public ExecutionResult execute()
                        throws ApiException

Executes the robot request. This call will block until the robot has finished, or a terminating error occurs.

Returns:

the result of the request. This contains output objects, log messages, and possible errors.

Throws:

ApiException - if an error in the API occurs, or the thread is interrupted.

execute

public void execute(RobotResponseHandler handler)
             throws ApiException

Executes the robot request, using a custom response handler. All possible responses are passed through this handler - any result or error collection must be implemented there.

Parameters:

handler - the response handler that will receive all execution events.

Throws:

ApiException - if thrown by the handler.

cancel

public void cancel()
            throws ApiException

Signals the execution to stop. This call will terminate after sending the request, but the actual stop will be noticed by the response handler once it finishes.

Throws:

ApiException - if the execution was not in a state that could be stopped, or if the stop request could not be sent.

getInterimResults

public java.util.List<Response> getInterimResults()

Retrieves intermediary results from an ongoing execution. These will only be populated when executing the request through execute(), not when using a custom response handler.

Returns:

the current list of interim results.

setStopRobotOnApiException

public void setStopRobotOnApiException(boolean stopOnError)

Specifies whether robot execution should stop if an error occurs in the robot, corresponding to the 'API Exception' checkmark as specified on a robot step.

Parameters:

stopOnError - true if robot execution should stop if an 'API Exception' is thrown from a robot.

getPriority

public QueuedRequest.Priority getPriority()

The current priority.

Returns:

the priority.

setPriority

public void setPriority(QueuedRequest.Priority priority)

Sets the priority of the queued task as long as it is in the Management Console queue.

The priority defaults to MEDIUM.

Parameters:

priority - the priority for this request when submitted to the queue.

getTimeout

public long getTimeout()

Gets the current timeout.

Returns:

the timeout

setTimeout

public void setTimeout(long timeout)

Sets the timeout for how long the robot will stay in the queue while it waits for execution.

The default value is 600 seconds (10 minutes).

Parameters:

timeout - the timeout in seconds to use.

createOAuthInputVariable

public void createOAuthInputVariable(java.lang.String name,
                                     java.lang.String userName,
                                     java.lang.String applicationName)

Creates an input variable for an OAUTH input type, that will look up the OAuth details in Management Console based on the given username and application name. Remember, that in the Management Console the application and oauth user must be linked to the same project as the robot you are requesting to run.

Parameters:

name - the name of the input variable

userName - the name of the user, as registered in the management console

applicationName - the name of the application as registered on the project in the management console