RoboSuite Java API, v1.87
A B C D E F G H I J K L M N O P R S T U V W X

A

AbstractFailFastRobotResponseHandler - Class in com.kapowtech.robosuite.api.java.rql.engine.hotstandby
An abstract RobotResponseHandler that implements a FailFast behavior, so you only need to implement response handling
AbstractFailFastRobotResponseHandler() - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.AbstractFailFastRobotResponseHandler
Creates a new instance.
AbstractRepositoryClient - Class in com.kapowtech.robosuite.api.java.repository.engine
The abstract client doesn't specify who the data is transported to the repository, which allow us to mock this part for tests.
AbstractRepositoryClient() - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Creates a new instance
AbstractRQLEngine - Class in com.kapowtech.robosuite.api.java.rql.engine
An RQLEngine that allows the user to get a handle for the request, This is useful, in situations where it is necessary to send the request, and receive the responses in two separate transactions (such as when using JMS for a protocol in a J2EE transaction).
AbstractRQLEngine() - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.AbstractRQLEngine
Creates a new AbstractRQLEngine instance.
AbstractXMLBasedDeploymentDescriptorProvider - Class in com.kapowtech.robosuite.api.java.rql.engine.deploy
Deployment descriptor provider that reads its contents from an XML stream.
AbstractXMLBasedDeploymentDescriptorProvider(InputStreamProvider, ResourceProvider) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.AbstractXMLBasedDeploymentDescriptorProvider
Constructor.
AbstractXMLBasedDeploymentDescriptorProvider(ReaderProvider, ResourceProvider) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.AbstractXMLBasedDeploymentDescriptorProvider
Constructor.
ACTION - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Deprecated. as Clipping has been removed.
addEnvironment(Environment) - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Adds a new Environment.
addRoboServer(RoboServer) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Adds a RoboServer to the RoboServer Cluster.
APP_KEY_PROPERTY_NAME - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AppKeyCustomEnvironment
Name of the appKey property name
AppKeyCustomEnvironment - Class in com.kapowtech.robosuite.api.java.rql.construct
Application key environment.
AppKeyCustomEnvironment(Properties) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.AppKeyCustomEnvironment
Constructor.
AppKeyCustomEnvironment(String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.AppKeyCustomEnvironment
Constructor.
Attribute - Class in com.kapowtech.robosuite.api.java.repository.construct
An attribute of a type.
Attribute(String, AttributeType, boolean) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.Attribute
Creates a new Attribute.
Attribute - Class in com.kapowtech.robosuite.api.java.rql.construct
Represents an attribute as an entry in an ExtractedObject or a QueryParameter.
Attribute(String, Object) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Attribute
Creates a new Attribute representing an attribute in an object model.
Attribute(String, String, AttributeType) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Attribute
Creates a new Attribute representing an attribute in an object model.
Attribute(String, AttributeType) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Attribute
Creates a new Attribute representing an attribute with the value null in an object model.
Attribute(String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Attribute
Creates a new Attribute representing an attribute in an object model.
ATTRIBUTE_TYPES - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
A list of all allowed attribute types.
AttributeParseException - Exception in com.kapowtech.robosuite.api.java.rql.construct
Signals an error when converting an attribute from a string to a given type.
AttributeParseException(AttributeType, String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.construct.AttributeParseException
Creates a new AttributeParseException.
AttributeType - Class in com.kapowtech.robosuite.api.java.repository.construct
A class modeling the data types used by Robots.
AttributeType - Class in com.kapowtech.robosuite.api.java.rql.construct
Represents type-information about the attributes in Input or Output Objects.
AUTHENTICATION_ENABLED_PREFIX - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest
The prefix for all error messages which is a result of invalid authentication

B

BINARY - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Binary used in Design Studio types
BINARY - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Represents the Binary data type in RoboSuite.
Binary - Class in com.kapowtech.robosuite.api.java.rql.construct
Represents a Binary RoboSuite value.
Binary(byte[]) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Binary
Creates a new binary object from a byte array.
Binary(byte[], int, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Binary
Creates a new binary object from a byte array.
Binary(InputStream) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Binary
Creates a new binary object from a byte input stream.
Binary(String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Binary
Creates a new byte array from a base 64 encoded string.
BOOLEAN - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Boolean used in Design Studio types
BOOLEAN - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Represents the Boolean data type in RoboSuite.

C

CACERTS - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerTrustMaterial
Used if the client should only trust servers whos public certificate has been loaded into the executing JVMs cacerts certificate store found in "$JAVA_HOME/jre/lib/security/cacerts"
CachingDeploymentDescriptorProvider - Class in com.kapowtech.robosuite.api.java.rql.engine.deploy
Used as a wrapper around another DeploymentDescriptorProvider to cache the DeploymentDescriptors that it returns.
CachingDeploymentDescriptorProvider(DeploymentDescriptorProvider, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.CachingDeploymentDescriptorProvider
Creates a new CachingDeploymentDescriptorProvider that wraps another provider and uses a specified time to live value.
CachingDeploymentDescriptorProvider(DeploymentDescriptorProvider) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.CachingDeploymentDescriptorProvider
Creates a new CachingDeploymentDescriptorProvider that wraps another provider and uses a default time-to-live of 5 minutes.
CapacityExceededException - Exception in com.kapowtech.robosuite.api.java.rql.engine.hotstandby
Exception that signals that the capacity has somehow been exceeded.
CapacityExceededException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.hotstandby.CapacityExceededException
 
CHANGES - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Deprecated. as Clipping has been removed.
CHARACTER - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Character used in Design Studio types
CHARACTER - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Represents the Character data type in RoboSuite.
clear() - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Clears this object for reuase.
clearAttributes() - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Clears all attributes from the object being constructed.
clearEnvironments() - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Clears the list of environments.
clearInputObjects() - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Clears the list of input objects.
ClientCertificate - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
A ClientCertificate is used by the client to encrypt the data sent to RoboServer.
ClientCertificate(byte[], char[]) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ClientCertificate
Creates a ClientCertificate from the certificate bytes and the certificate password
ClientCertificate(File, char[]) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ClientCertificate
Creates a ClientCertificate from a certificate file and a certificate password
ClientSideDistributingRQLEngine - Class in com.kapowtech.robosuite.api.java.rql.engine.dist
An RQL engine that uses a distribution policy to choose the underlying RQL Engine to send the request to.
ClientSideDistributingRQLEngine(DistributionPolicy, boolean) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.dist.ClientSideDistributingRQLEngine
Constructor.
ClientSideDistributingRQLEngine(DistributionPolicy) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.dist.ClientSideDistributingRQLEngine
Creates a new ClientSideDistributingRQLEngine that does not re-submit requests to another RoboServer if the connection is lost.
clone() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Binary
Creates and returns a copy of this object.
close() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MultiplexingRQLProtocol
MUST be called when you are done using the multiplexing protocol.
close() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MultiplexingSocketObjectProtocol
 
close() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SecureSocketBasedObjectRQLProtocol
 
close() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.remote.RQLSession
Closes the RQL session.
close() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.RQLRequestHandle
Closes this handle, disposing of all resources held by it.
Cluster - Class in com.kapowtech.robosuite.api.java.repository.construct
Models a cluster of RoboServers in the Management Console
Cluster(String, RoboServer[], boolean) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.Cluster
creates a new instance
ClusterAlreadyDefinedException - Exception in com.kapowtech.robosuite.api.java.rql
Exception thrown when a cluster with the given name is already configured
ClusterAlreadyDefinedException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.ClusterAlreadyDefinedException
Constructs a new instance
ClusterNotFoundException - Exception in com.kapowtech.robosuite.api.java.rql
thrown if a cluster han not been defined
ClusterNotFoundException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.ClusterNotFoundException
Creates a new instance
coerceToAcceptedValue(Object) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.Attribute
Coerces a value into a value accepted by the API.
com.kapowtech.robosuite.api.java.repository.construct - package com.kapowtech.robosuite.api.java.repository.construct
Provides classes which may be returned by the API when querying the Repository
com.kapowtech.robosuite.api.java.repository.engine - package com.kapowtech.robosuite.api.java.repository.engine
Contains the RepositoryClient class which provides communication with the repository.
com.kapowtech.robosuite.api.java.rql - package com.kapowtech.robosuite.api.java.rql
The root package of the RoboSuite Java API provides utility classes for interacting with RoboSuite through the Robot Query Language (RQL).
com.kapowtech.robosuite.api.java.rql.construct - package com.kapowtech.robosuite.api.java.rql.construct
Provides classes for the language constructs in the Robot Query Language (RQL).
com.kapowtech.robosuite.api.java.rql.engine - package com.kapowtech.robosuite.api.java.rql.engine
Provides classes and interfaces for executing RQL requests.
com.kapowtech.robosuite.api.java.rql.engine.deploy - package com.kapowtech.robosuite.api.java.rql.engine.deploy
Provides a means to specify deployment information about a RoboSuite application without hard-wiring it into the Java code.
com.kapowtech.robosuite.api.java.rql.engine.dist - package com.kapowtech.robosuite.api.java.rql.engine.dist

Provides support for simple client-side distribution policies.

com.kapowtech.robosuite.api.java.rql.engine.hotstandby - package com.kapowtech.robosuite.api.java.rql.engine.hotstandby
Provides a RequestExecutor which has a built in distribution policy, that keeps track of how many slots are available on each roboServer
com.kapowtech.robosuite.api.java.rql.engine.remote - package com.kapowtech.robosuite.api.java.rql.engine.remote
Provides classes for executing RQL requests remotely at a server.
com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing - package com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
Contains classes for Multiplexing RQL messages over a single socket connection
com.kapowtech.robosuite.api.java.rql.engine.remote.socket - package com.kapowtech.robosuite.api.java.rql.engine.remote.socket
Protocol for executing RQL requests via a socket based protocol.
CommonRobotEnvironment - Class in com.kapowtech.robosuite.api.java.rql.construct
The CommonRobotEnvironment is an Environment that applies the following special conditions to the execution of a robot: totalTimeLimit is a time limit on the total robot execution time.
CommonRobotEnvironment() - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Creates a CommonRobotEnvironment where the totalTimeLimit is set to 86400 (24 hours), objectTimeLimit is set to 600 (10 minutes), minObjectsLimit is set to 1, and maxObjectsLimit is set to 1000000 (one million).
CommonRobotEnvironment(boolean, int, int, int, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Creates a CommonRobotEnvironment with the specified property values.
CommonRobotEnvironment(boolean, int, int, int, int, boolean, int, int, int, int, int, boolean, boolean) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Creates a CommonRobotEnvironment with the specified property values.
COMMONS_CODEC_FOUND - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.remote.StartupCheck
 
COMMONS_LOGGING_FOUND - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.remote.StartupCheck
 
COMMONS_SSL_FOUND - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.remote.StartupCheck
 
COMPLETED - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus
The robot has completed executing.
COMPLETED - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotDoneEvent
Specifies that the robot has completed it execution in a normal fashion, as all steps has been executed.
ConcurrentRobotExecutor - Class in com.kapowtech.robosuite.api.java.rql
Deprecated. You should not use this class for robot execution. If you need to execute Robots concurrently, you should use a Threadpool and execute each Robot in a Runnable. In Java 1.5 you can use java.util.concurrent.ThreadPoolExecutor.
ConnectionException - Exception in com.kapowtech.robosuite.api.java.rql.engine
Signals a problem with a connection to RoboServer.
ConnectionException(Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.ConnectionException
Constructs a new ConnectionLostException with the specified cause and a detail message of (cause==null ? null : cause.toString()).
ConnectionException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.ConnectionException
Constructs a new ConnectionLostException with the specified detail message.
ConnectionException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.ConnectionException
Constructs a new ConnectionLostException with the specified detail message and cause.
ConnectionLostException - Exception in com.kapowtech.robosuite.api.java.rql.engine
Signals that the underlying connection to RoboServer was lost for some reason.
ConnectionLostException(Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.ConnectionLostException
Constructs a new ConnectionLostException with the specified cause and a detail message of (cause==null ? null : cause.toString()).
ConnectionLostException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.ConnectionLostException
Constructs a new ConnectionLostException with the specified detail message.
ConnectionLostException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.ConnectionLostException
Constructs a new ConnectionLostException with the specified detail message and cause.
ConnectionLostException(Throwable, boolean) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.ConnectionLostException
Constructs a new ConnectionLostException which was caused by a read timeout.
ConnectionLostException(String, Throwable, boolean) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.ConnectionLostException
Constructs a new ConnectionLostException which was caused by a read timeout.
Cookie - Class in com.kapowtech.robosuite.api.java.rql.construct
Represents a cookie held by the robot.
Cookie(String, String, String, String, boolean, int, String, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Constructor.
Cookie(String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Creates a new cookie with the given name and value, but no domain, path or comment specified.
COOKIES - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Deprecated. as Clipping has been removed.
Cookies - Class in com.kapowtech.robosuite.api.java.rql.construct
An immutable list of Cookies.
Cookies(List) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Cookies
Constructor.
COUNTRY - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Country used in Design Studio types
createEngine(RoboServer, boolean) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RQLEngineFactory
Creates a new Engine
createEngine(RoboServer, boolean) - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.DefaultRQLEngineFactory
 
createInputObject(String) - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Creates a new Input Object with the specified name, and returns an RQLObjectBuilder that can be used to build the object.
createInputObject(RQLObject) - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Creates a new Input Object with the specified name, and returns an RQLObjectBuilder that can be used to build the object.
createInputVariable(String) - Method in class com.kapowtech.robosuite.api.java.rql.Request
Creates a new Input Object with the specified name, and returns an RQLObjectBuilder that can be used to build the object.
createInputVariable(String, RQLObject) - Method in class com.kapowtech.robosuite.api.java.rql.Request
Creates a new Input Object with the specified name, from an RQLObject.
createReaderWriterPair(RemoteEndpoint) - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ObjectReaderWriterPairFactory
 
createReaderWriterPair(RemoteEndpoint) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ReaderWriterPairFactory
 
createReaderWriterPair(RemoteEndpoint) - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SecureReaderWriterPairFactory
 
createRepositoryClient(String, String, String) - Static method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientFactory
Creates a new Repository Client
createRepositoryClient(String, String, String, ProxyServerConfiguration) - Static method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientFactory
Creates a new Repository Client
CURRENCY - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Currency used in Design Studio types
CustomEnvironment - Class in com.kapowtech.robosuite.api.java.rql.construct
A CustomEnvironment can be used to send custom environments to RoboServer.
CustomEnvironment(Properties) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.CustomEnvironment
Creates a new CustomEnvironment with the specified set of properties.

D

DATE - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Date used in Design Studio types
DATE - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Represents the Date data type in RoboSuite.
DebugExecutorLogger - Class in com.kapowtech.robosuite.api.java.rql.engine.hotstandby
Default event logger callback, that logs to the debug mechanism.
DebugExecutorLogger() - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DebugExecutorLogger
Creates a new instance.
DEFAULT - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerTrustMaterial
Used if the client should only trust servers whos public certificate has been loaded into the executing JVMs jssecacerts or cacerts certificate store.
DEFAULT_BYPASS_OBJECT_REFINDER - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Default setting for the bypassObjectRefinder property is false.
DEFAULT_MAX_EMAILS - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Default setting for maxEmails property is -1 (no limit).
DEFAULT_MAX_EXECUTED_STEPS - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Default setting for maxExecutedSteps property is -1 (no limit).
DEFAULT_MAX_HTTP_REQUESTS - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Default setting for maxHttpRequests property is -1 (no limit).
DEFAULT_MAX_JAVA_SCRIPT_INSTRUCTIONS - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Default setting for maxJavaScriptInstructions property is -1 (no limit).
DEFAULT_MAX_LOADED_BYTES - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Default setting for maxLoadedBytes property is -1 (no limit).
DEFAULT_MAX_OBJECTS_LIMIT - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Default setting for the maxObjectsLimit property is 1000000.
DEFAULT_MIN_OBJECTS_LIMIT - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Default setting for the minObjectsLimit property is 1.
DEFAULT_OBJECT_TIME_LIMIT - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Default setting for the objectTimeLimit property is 10 minutes.
DEFAULT_STOP_ROBOT_WHEN_MAX_OBJECT - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Default setting for stopRobotWhenMaxEntity property is false.
DEFAULT_TOTAL_TIME_LIMIT - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Default setting for the totalTimeLimit property is 24 hours.
DefaultExecutorLogger - Class in com.kapowtech.robosuite.api.java.rql.engine.hotstandby
Default event logger callback, that logs to the debug mechanism
DefaultExecutorLogger() - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DefaultExecutorLogger
 
DefaultRobotLibrary - Class in com.kapowtech.robosuite.api.java.rql.construct
Represents RoboServer's Default Project Robot Library.
DefaultRobotLibrary() - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.DefaultRobotLibrary
Constructor.
DefaultRQLEngineFactory - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
Default factory for creating RQLEngines.
DefaultRQLEngineFactory() - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.DefaultRQLEngineFactory
 
DefaultRQLHandler - Class in com.kapowtech.robosuite.api.java.rql.engine
This handler defines the default behaviour for the RQLHandler.
DefaultRQLHandler() - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.DefaultRQLHandler
Constructor.
DefaultStoppable - Class in com.kapowtech.robosuite.api.java.rql.engine.hotstandby
Once a robot requests has been accepted by RoboServer, a Stoppable object will be passed to the RobotResponseHandler with each event, you may use this object to stop the robot in response to an event, such as an error
DefaultStoppable(String, String, String, RQLEngine) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DefaultStoppable
 
deleteResource(String, String, boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Deletes a resource from the repository
deleteResource(String, String, boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Deletes a resource from the repository
deleteRobot(String, String, boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Deletes a robot from the repository
deleteRobot(String, String, boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Deletes a robot from the repository
deleteSnippet(String, String, boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Deletes a Snippet from the repository
deleteSnippet(String, String, boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Deletes a Snippet from the repository
deleteType(String, String, boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Deletes a type from the repository
deleteType(String, String, boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Deletes a type from the repository
DemultiplexingRQLHandler - Class in com.kapowtech.robosuite.api.java.rql.engine
Demultiplexes received RQLResponses based on their class, and provides empty implementations for all methods in the implemented interface.
DemultiplexingRQLHandler() - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Constructor.
deployLibrary(String, EmbeddedFileBasedRobotLibrary, boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Deploys an Embedded RoboLibrary to the repository
deployLibrary(String, EmbeddedFileBasedRobotLibrary, boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Deploys an Embedded RoboLibrary to the repository
DeploymentDescriptor - Class in com.kapowtech.robosuite.api.java.rql.engine.deploy
Deployment information to configure a DeploymentSupportRQLEngine.
DeploymentDescriptor(RQLEngine, RobotLibrary, CommonRobotEnvironment, MessageEnvironment, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentDescriptor
Creates a new DeploymentDescriptor with the specified settings.
DeploymentDescriptor(RQLEngine, RobotLibrary, Environments, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentDescriptor
Creates a new DeploymentDescriptor with the specified settings.
DeploymentDescriptorProvider - Interface in com.kapowtech.robosuite.api.java.rql.engine.deploy
Used by a DeploymentSupportRQLEngine to provide a DeploymentDescriptor.
DeploymentException - Exception in com.kapowtech.robosuite.api.java.rql.engine.deploy
Signals that an error occured when accessing deployment settings.
DeploymentException(Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentException
Constructs a new DeploymentException with the specified cause and a detail message of (cause==null ? null : cause.toString()).
DeploymentException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentException
Constructs a new DeploymentException with the specified detail message.
DeploymentException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentException
Constructs a new DeploymentException with the specified detail message and cause.
DeploymentSupportRQLEngine - Class in com.kapowtech.robosuite.api.java.rql.engine.deploy
Provides support for specifying deployment information.
DeploymentSupportRQLEngine(DeploymentDescriptorProvider) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentSupportRQLEngine
Creates a new DeploymentSupportRQLEngine.
deployResource(String, String, byte[], boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Deploys a resource in a repository.
deployResource(String, String, byte[], boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Deploys a resource in a repository.
deployRobot(String, String, byte[], boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Deploys a robot in a repository.
deployRobot(String, String, byte[], boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Deploys a robot in a repository.
deploySnippet(String, String, byte[], boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Deploys a snippet to a repository.
deploySnippet(String, String, byte[], boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Deploys a snippet to a repository.
deployType(String, String, byte[], boolean) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Deploys a type to a repository.
deployType(String, String, byte[], boolean) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Deploys a type in a repository.
DistributionPolicy - Interface in com.kapowtech.robosuite.api.java.rql.engine.dist
A distribution policy is an algorithm for choosing an RQL engine.
doDeploy(String, String, byte[], boolean, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Deploys a resource/robot or type in a repository.

E

EmailMessageEnvironment - Class in com.kapowtech.robosuite.api.java.rql.construct
The Email Message Environment is a Message Environment that sends a email if any error messages were generated during the robot execution.
EmailMessageEnvironment(String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.EmailMessageEnvironment
Creates a new EmailMessageEnvironment with the specified properties.
EMAILS_SENT - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
EmbeddedFileBasedRobotLibrary - Class in com.kapowtech.robosuite.api.java.rql.construct
Represents a robot library that will be embedded in the ExecuteRequest that is sent to the robot server.
EmbeddedFileBasedRobotLibrary(InputStream) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.EmbeddedFileBasedRobotLibrary
Creates a new robot library that will be embedded in the message sent to RoboServer.
EmbeddedFileBasedRobotLibrary(byte[]) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.EmbeddedFileBasedRobotLibrary
Creates a new robot library that will be embedded in the message sent to RoboServer.
EmbeddedFileBasedRobotLibrary(Binary) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.EmbeddedFileBasedRobotLibrary
Creates a new robot library that will be embedded in the message sent to RoboServer.
ENDED - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
The execution has ended.
Environment - Interface in com.kapowtech.robosuite.api.java.rql.construct
Represents a specific setting that is passed to the robot before it begins execution.
Environments - Class in com.kapowtech.robosuite.api.java.rql.construct
A robot is always run using a list of environments.
Environments() - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Environments
Creates a new empty Environments.
Environments(Environment) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Environments
Creates an Enviroments object holding one Environment.
Environments(List) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Environments
Creates an Enviroments object from a list of Environment objects.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.repository.construct.RoboServer
tests for equality with other objects
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Attribute
Compares the specified object with this entry for equality.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Binary
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookies
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.CustomEnvironment
Tests whether this object is equal to another.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.DefaultRobotLibrary
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmailMessageEnvironment
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmbeddedFileBasedRobotLibrary
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.InputObjectEnvironment
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.InternalRequest
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.InternalResponse
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.MultiplexingRQLConstruct
Tests for equality.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingRequest
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RepositoryRobotLibrary
Tests for equality.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotErrorResponse
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotMessageResponse
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotOutputObjectResponse
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotResponse
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLConstruct
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLObject
Tests whether this object is equal to another.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLResponse
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerErrorResponse
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerExecutionEventResponse
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerInfoResponse
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerResponse
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Session
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.StopRequest
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.ThreadDumpRequest
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.URLFileBasedRobotLibrary
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.URLFolderBasedRobotLibrary
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ClientCertificate
Returns true if this object and the specified object have the same property values, and false otherwise.
equals(Object) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MultiplexingRQLProtocol
Checks if two protocols instances are equal
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerTrustMaterial
 
equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
Returns true if this object and the specified object have the same property values, and false otherwise.
ErrorResponse - Interface in com.kapowtech.robosuite.api.java.rql.construct
The error response interface provides a common view of the two types of error responses - RobotErrorResponse and ServerErrorResponse.
EVENT_OBJECTS - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
A list of all the supported ExecutionEvent types.
EXCEL - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Excel used in Design Studio types.
EXCEPTION_FORMAT - Static variable in exception com.kapowtech.robosuite.api.java.rql.ClusterAlreadyDefinedException
This string is used to generate the exception message using String.format()
EXCEPTION_FORMAT - Static variable in exception com.kapowtech.robosuite.api.java.rql.ClusterNotFoundException
The format of the exception logged.
execute(String) - Method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Executes a robot with no input objects.
execute(String, RQLObjects) - Method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Executes a robot with a set of input objects.
execute(String, RQLObject) - Method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Executes a robot specific robot with one specified RqlObject.
execute(Request) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Executes a new Execute request on the cluster.
execute(Request, RobotResponseHandler) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Executes a new robot request.
execute(String) - Method in class com.kapowtech.robosuite.api.java.rql.Request
Executes a new Execute request on the named cluster.
execute(String, RobotResponseHandler) - Method in class com.kapowtech.robosuite.api.java.rql.Request
Executes a new robot request on the named cluster.
execute(String, RQLObjects) - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. will be removed in a future release, use execute(ExecuteRequestBuilder)
execute(String, RQLObject) - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. will be removed in a future release, use execute(ExecuteRequestBuilder)
execute(String) - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Executes a robot specific robot with no input.
execute(ExecuteRequestBuilder) - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Extracts an ExecuteRequest from the supplied ExecuteRequestBuilder, and executes it.
EXECUTED_STEPS - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
ExecuteRequest - Class in com.kapowtech.robosuite.api.java.rql.construct
The ExecuteRequest is an RQLRequest that requests a robot to be executed on a server.
ExecuteRequest(String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Deprecated. This will be removed in a future release, use ExecuteRequestBuilder to construct requests
ExecuteRequest(String, RQLObjects) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Deprecated. This will be removed in a future release, use ExecuteRequestBuilder to construct requests
ExecuteRequest(String, RQLObjects, RobotLibrary) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Deprecated. This will be removed in a future release, use ExecuteRequestBuilder to construct requests
ExecuteRequest(String, RQLObjects, RobotLibrary, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Deprecated. This will be removed in a future release, use ExecuteRequestBuilder to construct requests
ExecuteRequest(String, RQLObjects, RobotLibrary, MessageEnvironment, CommonRobotEnvironment) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Deprecated. This will be removed in a future release, use ExecuteRequestBuilder to construct requests
ExecuteRequest(String, RQLObjects, RobotLibrary, MessageEnvironment, CommonRobotEnvironment, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Deprecated. This will be removed in a future release, use ExecuteRequestBuilder to construct requests
ExecuteRequest(String, RQLObjects, RobotLibrary, MessageEnvironment, CommonRobotEnvironment, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Deprecated. This will be removed in a future release, use ExecuteRequestBuilder to construct requests
ExecuteRequest(String, RQLObjects, RobotLibrary, MessageEnvironment, CommonRobotEnvironment, String, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Deprecated. This will be removed in a future release, use ExecuteRequestBuilder to construct requests
ExecuteRequest(String, RobotLibrary, Environments) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Deprecated. This will be removed in a future release, use ExecuteRequestBuilder to construct requests
ExecuteRequest(String, String, String, RobotLibrary, Environments) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Deprecated. This will be removed in a future release, use ExecuteRequestBuilder to construct requests
ExecuteRequest(String, String, String, RobotLibrary, Environments, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Deprecated. This will be removed in a future release, use ExecuteRequestBuilder to construct requests
ExecuteRequest(String, String, String, RobotLibrary, Environments, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Deprecated. This will be removed in a future release, use ExecuteRequestBuilder to construct requests
ExecuteRequestBuilder - Class in com.kapowtech.robosuite.api.java.rql
Deprecated. This belong to the old API, check the online Java Programmers Guide at http://help.kapowtech.com for details
ExecuteRequestBuilder(String) - Constructor for class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Creates a new ExecuteRequestBuilder with the specified robot URL.
ExecuteRequestBuilder() - Constructor for class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Creates a new ExecuteRequestBuilder with no specified robot URL.
ExecuteRequestBuilder(ExecuteRequest) - Constructor for class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Constructs a new builder from an existing request
EXECUTION_ID - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
EXECUTION_PATH - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
ExecutionEvent - Class in com.kapowtech.robosuite.api.java.rql.construct
Typesafe enumeration representing an execution event.
ExecutionStatus - Class in com.kapowtech.robosuite.api.java.rql.construct
Typesafe enumeration representing an execution status.
ExecutorLogger - Interface in com.kapowtech.robosuite.api.java.rql.engine.hotstandby
callback Interface for LoadBalancedRobotExecutor, this callback is notified in response to events that occur in the executor, like if there are not enough standby server, or if a server has been invalidly configured The callback is invoked synchronously by the same thread that processes responses from RoboServer, it is therefore important that implemented methods execute quickly, or you will slow down response processing
EXTRACTED_ENTITIES - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
ExtractedObject - Class in com.kapowtech.robosuite.api.java.rql.construct
Deprecated. The term Extracted Object has been replaced with Output Object. Use the RQLObject class instead.
ExtractedObject(String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExtractedObject
Deprecated. Creates a new ExtractedObject with no attributes.
ExtractedObject(String, List) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExtractedObject
Deprecated. Creates a new ExtractedObject with the given list of attribute entries.
ExtractedObject(String, List, List) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExtractedObject
Deprecated. Creates a new ExtractedObject with the given list of attributes.
ExtractedObject(String, String[], Object[]) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExtractedObject
Deprecated. Creates a new ExtractedObject with the given list of attributes.

F

FAILED - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
The execution has failed.
FAILED - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotDoneEvent
Specifies that a robot has failed it execution, usually due to the robot generating an API exception
FileAlreadyExistsException - Exception in com.kapowtech.robosuite.api.java.repository.engine
Signals that a file already exists
FileAlreadyExistsException(String) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.FileAlreadyExistsException
Constructs a new instance
FileBasedRobotLibrary - Interface in com.kapowtech.robosuite.api.java.rql.construct
Represents a single packed (zipped) robot library.
FileDeploymentDescriptorProvider - Class in com.kapowtech.robosuite.api.java.rql.engine.deploy
Provides a DeploymentDescriptor that is read from an XML file.
FileDeploymentDescriptorProvider(File) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.FileDeploymentDescriptorProvider
Creates a new deployment descriptor provider that reads the DeploymentDescriptor from a file.
filterResponse(RQLResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.ResponseCollectingRQLHandler
 
filterResponse(RQLResponse) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.ResponseFilteringRQLHandler
Whether to filter out the response from the list of responses returned from the RQLEngine.
filterResponse(RQLResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.RQLHandlerDecorator
Whether to filter out the response from the list of responses returned from the RQLEngine.
finalize() - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
 
FolderBasedRobotLibrary - Interface in com.kapowtech.robosuite.api.java.rql.construct
Represents a robot library in unpacked form.
fromInt(int) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.ShutdownMethod
Creates a shutdown method from an int.
fromString(String) - Method in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Parses a value to an object of the correct Java class.
FutureRQLResult - Class in com.kapowtech.robosuite.api.java.rql
Deprecated. This was used with the deprecated ConcurrentRobotExecutor to execute robots in parallel

G

get(int) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Binary
Returns the byte at the specified index.
get(int) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookies
 
get(int) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Environments
Returns the Environment at the specified position in this list.
get(String) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
Get method that will cast to the expected type.
get(String) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLObject
Returns the value of the attribute with the specified name, or null if not found.
get(int) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLObjects
Returns the input object at the specified position in this list.
get() - Method in class com.kapowtech.robosuite.api.java.rql.FutureRQLResult
Deprecated. Returns the RQLResult that is the result of the original query.
getAppKey() - Method in class com.kapowtech.robosuite.api.java.rql.construct.AppKeyCustomEnvironment
Returns the application key.
getAttribute(String) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLObject
Returns the Attribute object that represents the attribute with the specified name, or null if not found.
getAttributeByName(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputObject
finds a attribute with a given name
getAttributeByName(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.Type
finds a attribute with a given name
getAttributes() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputObject
get the attributes of this input object
getAttributes() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Type
get the attributes of this returned object
getAttributes() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLObject
Returns a map view of the attributes in the object.
getAttributeType() - Method in exception com.kapowtech.robosuite.api.java.rql.construct.AttributeParseException
Returns the attribute type that was expected.
getAuthentications() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Session
Returns an opaque value representing the current authentications held by the robot.
getBooleanValue(String) - Method in class com.kapowtech.robosuite.api.java.rql.construct.CustomEnvironment
Returns the boolean value of the property with the specified name.
getByName(String) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLObjects
Returns a sublist of the RQLObjects in this list that have the specified name.
getBypassObjectRefinder() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns whether the robot shall bypass the Object Refinder tag.
getBySignature(List) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLObjects
Returns a sublist of the RQLObjects in this list that have all the specified attributes.
getBytes() - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmbeddedFileBasedRobotLibrary
Deprecated. This method has been renamed EmbeddedFileBasedRobotLibrary.toByteArray(). The name getBytes implied a low- or no-cost operation. In fact the operation entailed copying the internal byte array.
getCacheTimeout() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RepositoryRobotLibrary
Get the cache timeout value.
getCacheTimeout() - Method in class com.kapowtech.robosuite.api.java.rql.construct.URLFileBasedRobotLibrary
Returns the time in seconds that RoboServer should cache the library.
getClientCertificate() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
Get the configured clientCertificate
getClusterLicense() - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Get the license for the cluster.
getClusterName() - Method in exception com.kapowtech.robosuite.api.java.rql.ClusterAlreadyDefinedException
The name of the cluster that already exists
getClusterName() - Method in exception com.kapowtech.robosuite.api.java.rql.ClusterNotFoundException
get the name of the cluster
getCommandLine() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
get the command line RoboServer was started with
getComment() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Returns a comment describing the purpose of this cookie, or null if the cookie has no comment.
getCommonRobotEnvironment() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Returns the common robot environment, or null if none.
getConcurrentRobotExecutor() - Static method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Returns a ConcurrentRobotExecutor instance that uses the default RQL engine.
getConcurrentRobotExecutor(RQLEngine) - Static method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Returns a ConcurrentRobotExecutor instance that uses the specified RQL engine.
getConcurrentRobotExecutor(String, int) - Static method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Returns a ConcurrentRobotExecutor instance that uses a RemoteRQLEngine using a socket based protocol, and the specified host and port.
getConcurrentRobotExecutor(RQLHandler) - Static method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Returns a ConcurrentRobotExecutor instance that uses the default RQL engine, and the specified RQLHandler.
getConcurrentRobotExecutor(RQLEngine, RQLHandler) - Static method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Returns a ConcurrentRobotExecutor instance that uses the specified RQL engine, and RQLHandler.
getConstruct() - Method in class com.kapowtech.robosuite.api.java.rql.construct.MultiplexingRQLConstruct
The construct being sent
getCookies() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Session
Returns a list of cookies currently held by the robot.
getCpuCount() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Get the number of CPUs assigned to the roboServer process
getData() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Session
Returns an opaque value containing the current document of the session.
getDate() - Method in interface com.kapowtech.robosuite.api.java.rql.construct.ErrorResponse
Returns the date at which the response was created at the server.
getDate() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLResponse
Returns the date at which the response was created at the server.
getDecorated() - Method in class com.kapowtech.robosuite.api.java.rql.engine.RQLHandlerDecorator
Returns the decorated RQL handler.
getDeploymentDescriptor() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.AbstractXMLBasedDeploymentDescriptorProvider
 
getDeploymentDescriptor() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.CachingDeploymentDescriptorProvider
Returns a DeploymentDescriptor to be used by a deployment supporting engine.
getDeploymentDescriptor() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentDescriptorProvider
Returns a DeploymentDescriptor to be used by a deployment supporting engine.
getDeploymentDescriptor() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.SimpleDeploymentDescriptorProvider
Returns a DeploymentDescriptor to be used by a deployment supporting engine.
getDescription() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
Returns a short description of the execution event.
getDescription() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus
Returns a short description of the execution status.
getDescriptorFile() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.FileDeploymentDescriptorProvider
Returns the file that the DeploymentDescriptor is read from.
getDescriptorURL() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.ServletDeploymentDescriptorProvider
Returns the path to the resource to read the XML file from.
getDescriptorURL() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.URLDeploymentDescriptorProvider
Returns the URL used to get the descriptor.
getDocumentURL() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Session
Returns the current document URL.
getDomain() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Returns the domain name for this cookie.
getEmailAddress() - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmailMessageEnvironment
Returns the e-mail address that the messages will be sent to.
getEngines() - Method in class com.kapowtech.robosuite.api.java.rql.engine.dist.LoadBalancingRoundRobinDistributionPolicy
 
getEnvironment(int) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Environments
Returns the Environment at the specified position in this list.
getEnvironmentByClass(Class) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Environments
Returns the first environment in the list that is of a specific class, or null if no such environment was found.
getEnvironments() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Returns all the environments.
getEnvironments() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentDescriptor
Returns a list of execution environments to pass to the robot before execution.
getErrorLocation() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotErrorResponse
Returns the error location.
getErrorLocationCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotErrorResponse
Returns the error location code.
getErrorMessage() - Method in interface com.kapowtech.robosuite.api.java.rql.construct.ErrorResponse
Returns the error message.
getErrorMessage() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotErrorResponse
Returns the error message.
getErrorMessage() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerErrorResponse
Returns the error message.
getErrors() - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Returns a list of ErrorResponse objects.
getEventCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
Returns the event code for this execution event.
getExecutionCount() - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Get the number of robots executed by this RequestExecutor
getExecutionEvent() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerExecutionEventResponse
Returns the event type.
getExecutionId() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
The client-side created execution id
getExecutionId() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotResponse
Returns the execution id.
getExecutionId() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerExecutionEventResponse
Returns the execution id.
getExecutionId() - Method in class com.kapowtech.robosuite.api.java.rql.construct.StopRequest
Returns the execution id.
getExecutionId() - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Get the executionId
getExecutionId() - Method in class com.kapowtech.robosuite.api.java.rql.FutureRQLResult
Deprecated. Returns the executionId of an executing robot, or null if an ServerStatusEventResponse has not been received yet.
getExecutionId() - Method in class com.kapowtech.robosuite.api.java.rql.Request
Get the executionId
getExecutionId() - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Returns the executionId of the robot, This will return null if the request that generated this result was not an ExecuteRequest, or if it did not contain a response that had an executionId property.
getExecutionIds() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Deprecated. use getRunningExecutionIds() or getQueuedExecutionIds()
getExecutionStatus() - Method in class com.kapowtech.robosuite.api.java.rql.FutureRQLResult
Deprecated. Returns the current execution status of a robot.
getHost() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RoboServer
Get the name of this RoboServer
getHost() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MultiplexingRQLProtocol
Get the Host name that this protocol instance is connected to
getHost() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MultiplexingSocketObjectProtocol
Get the Host name that this protocol instance is connected to
getHost() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SecureSocketBasedObjectRQLProtocol
Get the Host name that this protocol instance is connected to
getHost() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketBasedRQLProtocol
Returns the host name to connect to.
getHostName() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest
Returns the host name of the machine that created the request.
getInputObjects() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature
Get the input objects used by this robot
getInputObjects() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Returns a list of input objects that is part of the request.
getInputObjects() - Method in class com.kapowtech.robosuite.api.java.rql.construct.InputObjectEnvironment
Returns a list of the RQLObjects in this environment.
getInputStream() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Binary
Returns an input stream that can be used to read from the internal byte array.
getInputStream() - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmbeddedFileBasedRobotLibrary
Returns a byte input stream that can be used to read the raw, packed robot library.
getInputStream() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.deploy.InputStreamProvider
Returns a byte input stream that a deployment descriptor can be read from.
getIntegerProperty(String) - Method in class com.kapowtech.robosuite.api.java.rql.construct.CustomEnvironment
Returns the integer value of the property with the specified name.
getInvalidType() - Method in exception com.kapowtech.robosuite.api.java.rql.construct.InvalidAttributeTypeException
Returns the type (or class) of the invalid attribute.
getInvalidTypeName() - Method in exception com.kapowtech.robosuite.api.java.rql.construct.InvalidAttributeTypeException
Returns the type name of the invalid type parameter.
getIPAddress() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Returns the IP address of the RoboServer that responded to the Ping Request.
getIPAddress() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest
Returns the IP address as a dot-separated string.
getKey() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Attribute
Returns the name of the attribute that is used as a key for this entry.
getKeys() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
getLastModified() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot
gets date when the robot was last modified
getLastModified() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature
Get the last modified date of the robot
getLibraryURL() - Method in class com.kapowtech.robosuite.api.java.rql.construct.URLFileBasedRobotLibrary
Returns a URL to a packed library.
getLibraryURL() - Method in class com.kapowtech.robosuite.api.java.rql.construct.URLFolderBasedRobotLibrary
Returns the name of the directory where the unpacked robot library resides.
getLicenseType() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
The type of license used by the responding RoboServer
getMailServer() - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmailMessageEnvironment
Returns the mail server to use when sending the mail.
getMaxAge() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Returns the maximum age in seconds for this cookie.
getMaxConcurrentRobots() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
The server max number of concurrent requests the server can handle
getMaxEmails() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns the maximum number of emails the robot is allowed to send.
getMaxExecutedSteps() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns the maximum number of steps the robot is allowed to execute.
getMaxExecutionTime() - Method in class com.kapowtech.robosuite.api.java.rql.Request
Get the maximum execution time configured for this robot request
getMaxExecutionTime() - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutionParameterBuilder
the the value of the maxExecutionTime property
getMaxHttpRequests() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns the maximum number of HTTP requests the robot is allowed to perform.
-1 is returned if there is no limit.
getMaxJavaScriptInstructions() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns the maximum number of JavaScripts instruction the robot is allowed to execute.
-1 is returned if there is no limit.
getMaxJVMMemory() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
get the maximum Memory configured for the JVM RS is running in
getMaxLoadedBytes() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns the maximum number of bytes the robot is allowed to load.
-1 is returned if there is no limit.
getMaxObjectsLimit() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns the maximum objects limit.
getMaxQueueSize() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Get the maximum number of requests the server will queue
getMessage() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotMessageResponse
Returns the message.
getMessageEnvironment() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Returns the message environment, or null if none.
getMessages() - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Returns a list of strings containing the logging messages sent by the robot.
getMinObjectsLimit() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns the minimum objects limit.
getMuxId() - Method in class com.kapowtech.robosuite.api.java.rql.construct.MultiplexingRQLConstruct
Get the muxId
getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Attribute
get the name of this attribute
getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
Get the name of the Attribute type
getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Cluster
Get the name of the cluster
getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputAttribute
get the name of this attribute
getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Project
Get the name of this project
getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot
Gets the name of the robot
getName() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Attribute
Returns the name of the attribute that is used as a key for this entry.
getName() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Returns the name of the cookie.
getName() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLObject
Returns the name of the object.
getName() - Method in exception com.kapowtech.robosuite.api.java.rql.engine.deploy.MissingDeploymentDescriptorException
Returns the name of the deployment descriptor that could not be found.
getName() - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Returns the name of the object under construction.
getObject(int) - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLObjects
Returns the input object at the specified position in this list.
getObjectByName(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature
finds a input object with a give name
getObjects() - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Deprecated. The ExtractedObject class has been deprecated due to terminology changes. Use the RQLResult.getOutputObjects() method instead.
getObjectsByName(String) - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Deprecated. The ExtractedObject class has been deprecated due to terminology changes. Use the method RQLResult.getOutputObjects() combined with RQLObjects.getByName(String) instead.
getObjectsBySignature(List) - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Deprecated. The ExtractedObject class has been deprecated due to terminology changes. Use the method RQLResult.getOutputObjects() combined with RQLObjects.getBySignature(List) instead.
getObjectTimeLimit() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns the object time limit.
getOemKey() - Method in class com.kapowtech.robosuite.api.java.rql.Request
Get the configured OEM key
getOutputObject() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotOutputObjectResponse
Returns the output object.
getOutputObjects() - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Returns the output objects as an RQLObjects list.
getOutputObjectsByName(String) - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Returns the output objects as an RQLObjects list.
getOutputObjectsBySignature(List) - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Returns the output objects as an RQLObjects list.
getPassword() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RepositoryRobotLibrary
get the password used for authentication with the repository
getPassword() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest
 
getPassword() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentDescriptor
gets the password
getPassword() - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. gets the password
getPassword() - Method in class com.kapowtech.robosuite.api.java.rql.Request
gets the configured password
getPath() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Returns the path on the server to which this cookie is returned.
getPingResponses() - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Returns all PingResponses in the result.
getPort() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RoboServer
Get the port number
getPort() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MultiplexingRQLProtocol
Returns the port number that this protocol instance is connected to
getPort() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MultiplexingSocketObjectProtocol
Returns the port number that this protocol instance is connected to
getPort() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SecureSocketBasedObjectRQLProtocol
Returns the port number that this protocol instance is connected to
getPort() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketBasedRQLProtocol
Returns the port number that RoboServer listens on.
getProject() - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Get the project for this request
getProject() - Method in class com.kapowtech.robosuite.api.java.rql.Request
Get the project for this request
getProjectName() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Returns the project associated with this execute request.
getProjectName() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RepositoryRobotLibrary
Get the project name
getProjects() - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
 
getProjects() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Retrieves the projects available in the repository.
getProperties() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CustomEnvironment
Returns a copy of the Properties object that contains the settings for this object.
getProperty(String) - Method in class com.kapowtech.robosuite.api.java.rql.construct.CustomEnvironment
Returns the value of the property with the specified name.
getProvider() - Method in exception com.kapowtech.robosuite.api.java.rql.engine.deploy.MissingDeploymentDescriptorException
Returns the deployment descriptor provider that was unable to locate the deployment descriptor.
getProxyHost() - Method in class com.kapowtech.robosuite.api.java.repository.engine.ProxyServerConfiguration
get the proxy server host
getProxyPassword() - Method in class com.kapowtech.robosuite.api.java.repository.engine.ProxyServerConfiguration
get the proxy password
getProxyPort() - Method in class com.kapowtech.robosuite.api.java.repository.engine.ProxyServerConfiguration
get the proxy server port
getProxyUser() - Method in class com.kapowtech.robosuite.api.java.repository.engine.ProxyServerConfiguration
get the proxy server user
getQueuedExecutionIds() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Returns the set of execution ids for queued robots
getReader() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.deploy.ReaderProvider
Returns a character input stream that a deployment descriptor can be read from.
getReferrerURL() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Session
Returns the current referrer URL.
getRepositoryURL() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RepositoryRobotLibrary
get the repository URL
getRequestObject() - Method in class com.kapowtech.robosuite.api.java.rql.construct.InternalRequest
Returns the request object that describes the internal request.
getResourceAsStream(String) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.deploy.ResourceProvider
Returns an input stream containing the resource.
getResponseObject() - Method in class com.kapowtech.robosuite.api.java.rql.construct.InternalResponse
Returns the internal object that makes up this response.
getReturnedTypes() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature
Returns the types returned by the robot.
getRoboServerClusters() - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Get a list of the clusters and RoboServers that are registered with the Management Console running the repository
getRoboServerClusters() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Get a list of the clusters and RoboServers that are registered with the Management Console running the repository
getRobosuiteVersion() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Returns the RoboSuite version of the RoboServer that responded to the Ping Request.
getRobotErrorResponse() - Method in exception com.kapowtech.robosuite.api.java.rql.RobotErrorResponseException
Returns the RobotErrorResponse object that generated this exception.
getRobotExecuter(RQLEngine, RQLHandler) - Static method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. this method has been renamed to RobotExecutor.getRobotExecutor(com.kapowtech.robosuite.api.java.rql.engine.RQLEngine, com.kapowtech.robosuite.api.java.rql.engine.RQLHandler).
getRobotExecutor() - Static method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Returns a RobotExecutor instance that uses the default RQL engine.
getRobotExecutor(RQLEngine) - Static method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Returns a RobotExecutor instance that uses the specified RQL engine.
getRobotExecutor(String, int) - Static method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Returns a RobotExecutor instance that uses a RemoteRQLEngine using a socket based protocol, and the specified host and port.
getRobotExecutor(RQLHandler) - Static method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Returns a RobotExecutor instance that uses the default RQL engine, and the specified RQL handler.
getRobotExecutor(RQLEngine, RQLHandler) - Static method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Returns a RobotExecutor instance that uses the specified RQL engine and RQL handler.
getRobotId() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotResponse
Returns the robot id.
getRobotLibrary() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Returns the robot library, that holds the robot and related path models.
getRobotLibrary() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentDescriptor
Returns a RobotLibrary to use when executing robots.
getRobotLibrary() - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Returns the robot library that will be used to execute the request.
getRobotLibrary() - Method in class com.kapowtech.robosuite.api.java.rql.Request
Returns the robot library that will be used to execute the request.
getRobotName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature
Get the name of the robot
getRobotRunId() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotResponse
Returns the robot run id.
getRobotSignature(String, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Returns the robot signature for a given robot
getRobotSignature(String, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Returns the robot signature for a given robot
getRobotsInProject(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Retrieves the robots in a given project.
getRobotsInProject(String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Retrieves the robots in a given project.
getRobotStatuses() - Method in class com.kapowtech.robosuite.api.java.rql.construct.StatusResponse
Return the robot statuses as a list.
getRobotURL() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Returns the robot URL.
getRobotURL() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotResponse
Returns the robot file URL.
getRobotURL() - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Returns the currently configured robotURL property.
getRobotURL() - Method in class com.kapowtech.robosuite.api.java.rql.Request
Returns the currently configured robotURL property.
getRQLEngine() - Method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Returns the RQLEngine that is used to execute the queries.
getRQLEngine() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentDescriptor
Returns the RQLEngine to use when executing robots.
getRQLEngine() - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Returns the RQLEngine that is used to execute the queries.
getRQLHandler() - Method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Resutns the RQLHandler that is used to handle the RQLResponses and exceptions generated by the RQLEngine.
getRQLHandler() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.RQLRequestHandle
Returns the RQLHandler that is used to process RQL Responses and error conditions.
getRQLHandler() - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Resutns the RQLHandler that is used to handle the RQLResponses and exceptions generated by the RQLEngine.
getRQLProtocol() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.RemoteRQLEngine
Returns the RQL Protocol that this engine uses to communicate with RoboServer.
getRQLRequest() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.RQLRequestHandle
Returns the RQLRequest that this handle contains responses to.
getRQLRequest() - Method in class com.kapowtech.robosuite.api.java.rql.FutureRQLResult
Deprecated. Returns the RQLRequest that is generating the future result.
getRQLRequest() - Method in exception com.kapowtech.robosuite.api.java.rql.RQLException
Returns the RQLRequest that generated this error.
getRQLRequest() - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Returns the RQLRequest that this result was generated by.
getRQLResponse() - Method in exception com.kapowtech.robosuite.api.java.rql.RQLResponseException
Returns the RQLResponse that triggered the exception.
getRQLResponses() - Method in class com.kapowtech.robosuite.api.java.rql.engine.ResponseCollectingRQLHandler
Returns a list of RQLResponses that this handler has been notified of.
getRQLResponses() - Method in exception com.kapowtech.robosuite.api.java.rql.RQLException
Returns a list of RQLResponses that were received from an engine as a result.
getRQLResponses() - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Returns the raw RQLResponses that make up the result.
getRQLResponsesByClass(Class) - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Returns a list of RQLResponses that satisfies the condition: responseType.isInstance(response).
getRunningExecutionIds() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Return the set of execution ids for running robots
getServerCerticicate() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
Get the configured ServerCertificate
getServerErrorResponse() - Method in exception com.kapowtech.robosuite.api.java.rql.ServerErrorResponseException
Returns the ServerErrorResponse object that generated this exception.
getServerExecutionEventResponse() - Method in exception com.kapowtech.robosuite.api.java.rql.ServerExecutionEventResponseException
Returns the ServerExecutionEventResponse that triggered this exception.
getServerInstanceId() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Get the servers instance id.
getServers() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Cluster
Get the list of servers in this cluster
getServletContext() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.ServletDeploymentDescriptorProvider
Returns the servlet context object used to access the resource.
getShutdownMethod() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ShutdownRequest
Get the argument for the shutdown
getSize() - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmbeddedFileBasedRobotLibrary
Returns the number of bytes in the embedded packed library.
getSocketTimeout() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketBasedRQLProtocol
Returns the socket timeout value (in milliseconds).
getSource() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.StringSourceServletDeploymentDescriptorProvider
Returns the source XML string.
getStatus() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Get the status of the server
getStatusCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus
Returns the status code for this execution status.
getStopIfConnectionLost() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
get the value of the stopIfClientDies property
getStopOnAPIException() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
get the value of the stopRobotOnAPIException property
getStopRobotIfConnectionLost() - Method in class com.kapowtech.robosuite.api.java.rql.Request
get the value of the getStopIfConnectionLost property
getStopRobotIfConnectionLost() - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutionParameterBuilder
get the value of the stopRobotIfConnectionLost property
getStopRobotOnApiException() - Method in class com.kapowtech.robosuite.api.java.rql.Request
get the value of the stopRobotOnAPIException property
getStopRobotOnApiException() - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutionParameterBuilder
get the value of the stopRobotOnAPIException property
getStopRobotWhenMaxObject() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns true if the robot should be stopped when the maximum number of returned objects is reached.
getStoredTypes() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature
Returns the types stored by the robot.
getThreadDump() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ThreadDumpResponse
 
getTimeout() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ShutdownRequest
The timeout in Seconds.
getTimestamp() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Session
Returns a timestamp indicating when the session was last modified.
getTimeToLive() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.CachingDeploymentDescriptorProvider
Returns the maximum age (in seconds) a cached DeploymentDescriptor can have before it is reloaded from the wrapped DeploymentDescriptorProvider.
getTotalAvailableSlots() - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Returns the number of total available slots the cluster has.
getTotalTimeLimit() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns the total time limit.
getType() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Attribute
Get the type of this attribute
getType() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputAttribute
Get the type of this attribute
getType() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Attribute
Returns the type of the attribute.
getType() - Method in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Returns the Java class of the type.
getTypeName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputObject
The name of the Type
getTypeName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Type
The name of the Type
getTypeName() - Method in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Returns a string description of the type name.
getUptime() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
The uptime of the RoboServer, in miliseconds
getUserName() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RepositoryRobotLibrary
get the user name used for authentication with the repository
getUsername() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest
 
getUsername() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentDescriptor
gets the username used for authenticating
getUsername() - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. gets username
getUsername() - Method in class com.kapowtech.robosuite.api.java.rql.Request
gets the configured user name
getValue() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Attribute
Returns the attribute value corresponding to this entry.
getValue() - Method in exception com.kapowtech.robosuite.api.java.rql.construct.AttributeParseException
Returns the value that could not be parsed into the correct type.
getValue() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Returns the value of the cookie.
getValue() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ShutdownMethod
 
getVariableName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputObject
Get the name of the input variable.
getVersion() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot
get the version
getVersion() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature
Get the version of Design Studio the robot was last saved with.
getVersion() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Returns the cookie's version.

H

handleError(RQLException) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DefaultRQLHandler
Provides a default handler for non-fatal exceptions.
handleError(RQLException) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Receive notification of an exception the engine can recover from.
handleError(RQLException, Stoppable) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.AbstractFailFastRobotResponseHandler
Throws the exception
handleError(RQLException, Stoppable) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotResponseHandler
Called if an exception has occurred inside the API.
handleError(RQLException) - Method in class com.kapowtech.robosuite.api.java.rql.engine.ResponseCollectingRQLHandler
Receive notification of an exception the engine can recover from.
handleError(RQLException) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.RQLHandler
Receive notification of an exception the engine can recover from.
handleError(RQLException) - Method in class com.kapowtech.robosuite.api.java.rql.engine.RQLHandlerDecorator
Invokes the decorated handler.
handleFatal(RQLException) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DefaultRQLHandler
Provides a default handler for fatal exceptions.
handleFatal(RQLException) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Receive notification of an handleFatal exception that the RQLEngine cannot recover from.
handleFatal(RQLException) - Method in class com.kapowtech.robosuite.api.java.rql.engine.ResponseCollectingRQLHandler
Receive notification of an handleFatal exception that the RQLEngine cannot recover from.
handleFatal(RQLException) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.RQLHandler
Receive notification of an handleFatal exception that the RQLEngine cannot recover from.
handleFatal(RQLException) - Method in class com.kapowtech.robosuite.api.java.rql.engine.RQLHandlerDecorator
Invokes the decorated handler.
handlePingResponse(PingResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Receive notification when the server responds to a ping.
handleResponse(RQLResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Receive notification when an RQLResponse is generated.
handleResponse(RQLResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.ResponseCollectingRQLHandler
Receive notification when an RQLResponse is generated, delegating the responsibility for handling the response to the wrapped RQLHandler.
handleResponse(RQLResponse) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.RQLHandler
Receive notification when an RQLResponse is generated.
handleResponse(RQLResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.RQLHandlerDecorator
Invokes the decorated handler.
handleReturnedValue(RobotOutputObjectResponse, Stoppable) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotResponseHandler
Receive notification when the robot executes the Return Value action.
handleRobotError(RobotErrorResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DefaultRQLHandler
Provides a default handler for robot error responses.
handleRobotError(RobotErrorResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Receive notification when a robot error response is generated.
handleRobotError(RobotErrorResponse, Stoppable) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.AbstractFailFastRobotResponseHandler
throws RobotErrorResponseException in response to an error (stops the robot)
handleRobotError(RobotErrorResponse, Stoppable) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotResponseHandler
Receive notification when a robot has generated an API exception.
handleRobotExtractedObject(RobotOutputObjectResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DefaultRQLHandler
Provides a default handler for when the robot extracts an object.
handleRobotExtractedObject(RobotOutputObjectResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Receive notification when the robot extracts an object.
handleRobotMessage(RobotMessageResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DefaultRQLHandler
Provides a default handler for processing robot messages.
handleRobotMessage(RobotMessageResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Receive notification when the robot sends back a message.
handleRobotOutputObject(RobotOutputObjectResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Receive notification when the robot extracts an object.
handleServerError(ServerErrorResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DefaultRQLHandler
Provides a default strategy for dealing with server error response, which is to throw a ServerErrorResponseException.
handleServerError(ServerErrorResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Receive notification when the server generates an error response.
handleServerError(ServerErrorResponse, Stoppable) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.AbstractFailFastRobotResponseHandler
Throws a ServerErrorResponseException
handleServerError(ServerErrorResponse, Stoppable) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotResponseHandler
Receive notification when the server generates an error response.
handleServerExecutionEvent(ServerExecutionEventResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DefaultRQLHandler
Provides a default handler for dealing with server execution events.
handleServerExecutionEvent(ServerExecutionEventResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Receive notification when the server reports an execution event.
handleServerExecutionEvent(ServerExecutionEventResponse, Stoppable) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.AbstractFailFastRobotResponseHandler
Throws RobotStoppedException when the robot is stopped, and RobotFailedException if the robot fails.
handleStatusResponse(StatusResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Notification that RoboServer has responded to the StatusRequest.
handleThreadDumpResponse(ThreadDumpResponse) - Method in class com.kapowtech.robosuite.api.java.rql.engine.DemultiplexingRQLHandler
Notification that the RoboServer has responded to the ThreadDumpRequest
handleWriteLog(RobotMessageResponse, Stoppable) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.AbstractFailFastRobotResponseHandler
Does nothing, if you want to be notified when a Robot executes the Write Log action
handleWriteLog(RobotMessageResponse, Stoppable) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotResponseHandler
Receive notification when the robot executes the Write Log action.
hashCode() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RoboServer
returns hashcode, symmetric with equals
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Attribute
Returns the hash code value for this map entry.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Binary
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookies
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CustomEnvironment
Returns a hash code value for the object.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.DefaultRobotLibrary
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmailMessageEnvironment
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmbeddedFileBasedRobotLibrary
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
Returns a hash code value for the object.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus
Returns a hash code value for the object.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.InputObjectEnvironment
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.InternalRequest
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.InternalResponse
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.MultiplexingRQLConstruct
get the hascode, forwards to the wrapped construct
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingRequest
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RepositoryRobotLibrary
 
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotErrorResponse
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotMessageResponse
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotOutputObjectResponse
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotResponse
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLConstruct
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLObject
Returns a hash code value for the object.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLResponse
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerErrorResponse
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerExecutionEventResponse
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerInfoResponse
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerResponse
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Session
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.StopRequest
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ThreadDumpRequest
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.URLFileBasedRobotLibrary
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.URLFolderBasedRobotLibrary
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ClientCertificate
Returns the hash code of this object based on property values.
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerTrustMaterial
 
hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
Returns the hash code of this object based on property values.
hasNextRQLResponse() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.RQLRequestHandle
Checks whether there are more RQLResponses available from the request.
HTML - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Html used in Design Studio types
HTTP_CLIENT_FOUND - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.remote.StartupCheck
 
HTTP_CORE_CLIENT_FOUND - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.remote.StartupCheck
 

I

IMAGE - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Image used in Design Studio types
IMMEDIATE - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ShutdownMethod
RoboServer must stop immediately
IMMEDIATE_RESTART - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ShutdownMethod
RoboServer must restart immediately
IncompatibleJavaVersionError - Error in com.kapowtech.robosuite.api.java.rql.engine
Error thrown if the current Java version is incompatible with this API most commonly thrown if SSL/multiplexing is used and the java version is not 1.5 or above
IncompatibleJavaVersionError(String) - Constructor for error com.kapowtech.robosuite.api.java.rql.engine.IncompatibleJavaVersionError
Creates a new IncompatibleJavaVersionError with a error message
init() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.remote.RQLSession
Initializes the RQL session.
initRQLConstructs(RQLRequest, List) - Method in exception com.kapowtech.robosuite.api.java.rql.RQLException
Initializes the RQLConstructs that make up the execution details.
InputAttribute - Class in com.kapowtech.robosuite.api.java.repository.construct
An attribute of a type of a variable used as input to a robot.
InputAttribute(String, AttributeType, boolean) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.InputAttribute
Creates a new InputAttribute.
InputObject - Class in com.kapowtech.robosuite.api.java.repository.construct
A description of the name and type of a variable used as input to a robot.
InputObject(String, String, InputAttribute[]) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.InputObject
Constructs a new InputObject
InputObjectEnvironment - Class in com.kapowtech.robosuite.api.java.rql.construct
The Input Object Environment passes on Input Objects to a robot that requires them as parameters.
InputObjectEnvironment(RQLObjects) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.InputObjectEnvironment
Creates a new InputObjectEnvironment containing the specified input objects.
InputStreamProvider - Interface in com.kapowtech.robosuite.api.java.rql.engine.deploy
Provides a byte input stream that a deployment descriptor can be read from.
INTEGER - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Integer used in Design Studio types
INTEGER - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Represents the Integer data type in RoboSuite.
InternalRequest - Class in com.kapowtech.robosuite.api.java.rql.construct
This request is used to transport internal RoboSuite RQL Requests from one RoboSuite application to another.
InternalRequest(Object) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.InternalRequest
Creates a new InternalRequest object with the specified requestObject as parameter.
InternalRequest(Object, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.InternalRequest
Package private constructor that is used to initialize an RQL Request with the specified host name and IP address.
InternalRequest(String, String, String, String, Object) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.InternalRequest
Constructor used to initialize an RQL Request with Credentials
InternalResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
This response is used to transport internal RoboSuite RQL Responses from one RoboSuite application to another.
InternalResponse(Object, Date) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.InternalResponse
Creates a new InternalResponse used to transmit internal codes.
InvalidAttributeTypeException - Exception in com.kapowtech.robosuite.api.java.rql.construct
Signals that an invalid attribute type was inserted into a QueryParameter or ExtractedObject.
InvalidAttributeTypeException(Class) - Constructor for exception com.kapowtech.robosuite.api.java.rql.construct.InvalidAttributeTypeException
Constructs an InvalidAttributeTypeException.
InvalidAttributeTypeException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.construct.InvalidAttributeTypeException
Constructs an InvalidAttributeTypeException.
isCachingEnabled() - Method in class com.kapowtech.robosuite.api.java.rql.construct.URLFileBasedRobotLibrary
Returns true if RoboServer should cache the packed robot library referenced by the URL, otherwise false.
isCheckCRL() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
Should server certificate be checked against CRL
isCheckExpiry() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
Should servers certificate be check for expiry
isCheckHostName() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
Should server certificates host name be verified
isComplex() - Method in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Checks whether the attribute type represent attributes that are complex.
isConnectionLostException(IOException) - Static method in class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketUtil
Checks if the exception indicates that the connection was lost
isEmpty() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Binary
Returns true if this object contains no bytes.
isReadTimeout() - Method in exception com.kapowtech.robosuite.api.java.rql.engine.ConnectionLostException
Returns true if the connection was lost due to a read timeout
isReady() - Method in class com.kapowtech.robosuite.api.java.rql.FutureRQLResult
Deprecated. Returns true if the result of the execution is ready.
isRequired() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Attribute
checks if the attribute is required
isRequired() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputAttribute
checks if the attribute is required
isSecure() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Checks whether this cookie was set using a secure protocol.
isSocketTimeoutException(IOException) - Static method in class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketUtil
Utility method to find out if an exception was raised due to socket timeout
isSsl() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Cluster
Is the Cluster configured for SSL (secure socket layer)

J

JSON - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Json used in Design Studio types.
JSSE_CACERTS - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerTrustMaterial
Used if the client should only trust servers whos public certificate has been loaded into the executing JVMs jssecacerts certificate store found in "$JAVA_HOME/jre/lib/security/jssecacerts"
JVM_1_5_OR_HIGHER - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.remote.StartupCheck
 

K

KCU_POINT_COST - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
KCU_WAIT_MILLIS - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 

L

LANGUAGE - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Language used in Design Studio types
LICENSE_PRE_8_3 - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
The license type for RoboServer prior to 8.3, where the license type was not sent by RoboServer
LICENSE_TYPE_NON_PRODUCTION - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
The value returned getLicenseType() when the RoboServer uses a Non production license
LICENSE_TYPE_PRODUCTION - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
The value returned getLicenseType() when the RoboServer uses a production license
LoadBalancingRoundRobinDistributionPolicy - Class in com.kapowtech.robosuite.api.java.rql.engine.dist
A round-robin distribution policy picks one of a list of RQL engines in sequence, taking into account the current load of the RoboServer, by selecting from the RoboServers with fewest outstanding requests from this client.
LoadBalancingRoundRobinDistributionPolicy(List) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.dist.LoadBalancingRoundRobinDistributionPolicy
Constructor.
LOADED_BYTES - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
LOCATION_CODE - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
LONG_TEXT - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Long Text used in Design Studio types

M

main(String[]) - Static method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MultiplexingSocketObjectProtocol
 
MAX_EXECUTED_STEPS - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
MAX_OBJECTS_RETURNED - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
MAX_RUNTIME - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
MessageEnvironment - Interface in com.kapowtech.robosuite.api.java.rql.construct
The MessageEnvironment specifies how robot generated status messages are handled, such as stored in a database, written to a file, or sent via email.
MissingDeploymentDescriptorException - Exception in com.kapowtech.robosuite.api.java.rql.engine.deploy
Raised when a deployment descriptor is unable to locate a deployment descriptor.
MissingDeploymentDescriptorException(String, DeploymentDescriptorProvider) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.deploy.MissingDeploymentDescriptorException
Constructor.
MissingDeploymentDescriptorException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.deploy.MissingDeploymentDescriptorException
Constructor.
MissingDeploymentDescriptorException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.deploy.MissingDeploymentDescriptorException
Constructor.
MissingJarFileError - Error in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
Error thrown when a required API dependency (a jar file) is missing Most commonly thrown if SSL is used and commons-ssl is not found in the class path
MissingJarFileError(String) - Constructor for error com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MissingJarFileError
Creates a new MissingJarFileError with an error message
MultiplexingHandshakeException - Exception in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
A specific RQLProtocolException which is thrown when setting up a multiplexing connection fails
MultiplexingHandshakeException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MultiplexingHandshakeException
Creates a new MultiplexingHandshakeException wrapping another exception
MultiplexingHandshakeException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MultiplexingHandshakeException
Creates a new MultiplexingHandshakeException
MultiplexingRQLConstruct - Class in com.kapowtech.robosuite.api.java.rql.construct
A wrapper for RQLConstructs when used with a MultiplexingRQLProtocol.
MultiplexingRQLConstruct(String, RQLConstruct) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.MultiplexingRQLConstruct
creates a new Multiplexing construct
MultiplexingRQLProtocol - Interface in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
An RQLProtocol that creates a single socket connection to a RoboServer.
MultiplexingSocketObjectProtocol - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
A protocol that sends RQL using a socket connection to RoboServer.
In most cases you should use the simpler SocketBasedObjectRQLProtocol instead of this protocol.
This is a multiplexing protocol, which means that for a given host and port, the socket connection will be reused if you create two protocol instances to the same RoboServer.
MultiplexingSocketObjectProtocol(String, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MultiplexingSocketObjectProtocol
Creates a new SecureSocketBasedObjectRQLProtocol connecting to the given host and port, with the given SSLConfiguration
MultiplexingVirtualConnectionClosed - Class in com.kapowtech.robosuite.api.java.rql.construct
A Marker response sent by the server to indicate the all responses related to the current request have been sent This is to let the client know that there is no more data on the virtual connection
MultiplexingVirtualConnectionClosed(Date) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.MultiplexingVirtualConnectionClosed
Constructor.

N

newRQLSession() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.MultiplexingSocketObjectProtocol
Returns a new session.
newRQLSession() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SecureSocketBasedObjectRQLProtocol
Returns a new session.
newRQLSession() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.remote.RQLProtocol
Returns a new session.
newRQLSession() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketBasedObjectRQLProtocol
Returns a new session.
newRQLSession() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketBasedXMLRQLProtocol
Returns a new session.
nextRQLEngine() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.dist.DistributionPolicy
Returns the next RQL engine according to the distribution policy.
nextRQLEngine() - Method in class com.kapowtech.robosuite.api.java.rql.engine.dist.LoadBalancingRoundRobinDistributionPolicy
 
nextRQLEngine() - Method in class com.kapowtech.robosuite.api.java.rql.engine.dist.RandomDistributionPolicy
 
nextRQLEngine() - Method in class com.kapowtech.robosuite.api.java.rql.engine.dist.RoundRobinDistributionPolicy
 
nextRQLResponse() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.RQLRequestHandle
Returns the next RQLResponse from the request.
NoRQLEngineAvailableException - Exception in com.kapowtech.robosuite.api.java.rql.engine.dist
Signals that a ClientSideDistributingRQLEngine could not find an available RQLEngine.
NoRQLEngineAvailableException() - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.dist.NoRQLEngineAvailableException
Constructor.
NUMBER - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Number used in Design Studio types
NUMBER - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Represents the Number data type in RoboSuite.

O

ObjectReaderWriterPairFactory - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
 
ObjectReaderWriterPairFactory() - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ObjectReaderWriterPairFactory
 
onInvalidLicense(RoboServer, String) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DebugExecutorLogger
 
onInvalidLicense(RoboServer, String) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DefaultExecutorLogger
 
onInvalidLicense(RoboServer, String) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.ExecutorLogger
Called if the executor detects that a servers license is not in compliance with the operation mode.
onNotEnoughStandbyServers(int, int) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DebugExecutorLogger
 
onNotEnoughStandbyServers(int, int) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DefaultExecutorLogger
 
onNotEnoughStandbyServers(int, int) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.ExecutorLogger
Deprecated. 
onRepositoryException(RepositoryClientException) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DebugExecutorLogger
 
onRepositoryException(RepositoryClientException) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DefaultExecutorLogger
 
onRepositoryException(RepositoryClientException) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.ExecutorLogger
Called if the executor is configured to auto-synchronize with a cluster found in the ManagementConsole repository, and an exception occurred (connection error, or if the cluster no longer exists)
onServerOffline(RoboServer, String) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DebugExecutorLogger
 
onServerOffline(RoboServer, String) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DefaultExecutorLogger
 
onServerOffline(RoboServer, String) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.ExecutorLogger
When the cluster detects a RoboServer goes offline
onShutDownNotCalled(String) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DebugExecutorLogger
 
onShutDownNotCalled(String) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DefaultExecutorLogger
 
onShutDownNotCalled(String) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.ExecutorLogger
Called if the executor is GarbageCollected without shutdown() being called.

P

parallelExecute(List, RQLObjects) - Method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Executes in parallel a number of robots with the same set of RQLObjects as input
parallelExecute(List, RQLObject) - Method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Executes in parallel a number of robots with the same set of RQLObjects as input
parallelExecute(List) - Method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Executes in parallel a number of robots with no input.
parallelRequests(List) - Method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Executes a number of RQLRequests in parallel, returning after all requests have been processed.
parseAttributeType(String) - Static method in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
Parses an attribute type from a name.
parseAttributeType(String) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Returns the AttributeType associated with the given type name.
parseAttributeType(Class) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Returns the AttributeType associated with the given Java class.
parseExecutionEvent(int) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
Returns the ExecutionEvent corresponding to a given event code.
parseExecutionEvent(String) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
Returns the ExecutionEvent corresponding to a given event description.
parseExecutionStatus(int) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus
Returns the ExecutionStatus corresponding to a given status code.
parseExecutionStatus(String) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus
Returns the ExecutionStatus corresponding to a given event description.
PASSWORD - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Password used in Design Studio types
PDF - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type PDF used in Design Studio types
PENDING - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus
The request request has been received, and that the robot is pending execution.
ping() - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Ping's RoboServer.
pingRepository() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
Ping the repository server
PingRequest - Class in com.kapowtech.robosuite.api.java.rql.construct
The Ping Request can be used to ping a RoboServer.
PingRequest() - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.PingRequest
Constructor.
PingRequest(String, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.PingRequest
Deprecated. 
PingResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
A Ping Response is returned by RoboServer, after it receives a Ping Request.
PingResponse(Date, String, String, int, int, int, String, Set<String>, Set<String>, String, long, String, long, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Creates a new ping response As this is a server response, it is subject to change, and backwards compatibility is not guaranteed
Project - Class in com.kapowtech.robosuite.api.java.repository.construct
A project Object, describes a project located in the repository
Project(String) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.Project
Constructs a new Project object
PROJECT_NAME - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
PROPERTIES - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Properties used in Design Studio types
ProxyServerConfiguration - Class in com.kapowtech.robosuite.api.java.repository.engine
A login handler that decorates another LoginHander to add proxy support
ProxyServerConfiguration(String, int, String, String) - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.ProxyServerConfiguration
Constructs a new proxy configuration

R

RandomDistributionPolicy - Class in com.kapowtech.robosuite.api.java.rql.engine.dist
A random distribution policy picks one of a list of RQL engines at random.
RandomDistributionPolicy(List) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.dist.RandomDistributionPolicy
Constructor.
ReaderProvider - Interface in com.kapowtech.robosuite.api.java.rql.engine.deploy
Provides a character input stream that a deployment descriptor can be read from.
ReaderWriterPairFactory - Interface in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
 
readResolve() - Method in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Resolves this object correctly when serializing.
readResolve() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
Resolves this object correctly when serializing.
readResolve() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus
Resolves this object correctly when serializing.
receive() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.remote.RQLSession
Returns a received RQL response, or null if no more RQL responses.
REFIND_KEY - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Refind Key used in Design Studio types
registerCluster(Cluster) - Static method in class com.kapowtech.robosuite.api.java.rql.Request
Registers a cluster so it can receive requests.
registerCluster(Cluster, ExecutorLogger) - Static method in class com.kapowtech.robosuite.api.java.rql.Request
Registers a cluster so it can receive requests.
registerCluster(RepositoryClient, String) - Static method in class com.kapowtech.robosuite.api.java.rql.Request
Registers a cluster defined in a Management Console repository.
registerCluster(RepositoryClient, String, ExecutorLogger) - Static method in class com.kapowtech.robosuite.api.java.rql.Request
Registers a cluster defined in a Management Console repository.
RemoteRQLEngine - Class in com.kapowtech.robosuite.api.java.rql.engine.remote
A RemoteRQLEngine is an RQLEngine that executes RQLRequests by forwarding them to a remote RoboServer via an RQLProtocol.
RemoteRQLEngine(RQLProtocol) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.RemoteRQLEngine
Constructs a new RemoteRQLEngine that will use the specified protocol.
removeRoboServer(RoboServer) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Removes a RoboServer from the cluster.
replaceEngines(List) - Method in class com.kapowtech.robosuite.api.java.rql.engine.dist.LoadBalancingRoundRobinDistributionPolicy
Replace the engines, any new engines will be added, douplicate engines will remain, and engines that don't exits in the replacement list will be removed
RepositoryClient - Interface in com.kapowtech.robosuite.api.java.repository.engine
The interface which defines the RepositoryClient API.
RepositoryClientException - Exception in com.kapowtech.robosuite.api.java.repository.engine
General Client error when communicating with the Repository
RepositoryClientException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientException
constructs a new instance
RepositoryClientException(String) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientException
Constructs a new RepositoryClientException with the specified detail message.
RepositoryClientException(Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientException
constructs a new instance from another exception
RepositoryClientFactory - Class in com.kapowtech.robosuite.api.java.repository.engine
A factory form creating Repository Clients,

RepositoryClient client = RepositoryClientFactory.createRepositoryClient("http://localhost:50080", null, null);

RepositoryRobotLibrary - Class in com.kapowtech.robosuite.api.java.rql.construct
A Robot Library which uses the Platform repository.
RepositoryRobotLibrary(String, String, long) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RepositoryRobotLibrary
Creates a new Repository Robot Library without credentials (
RepositoryRobotLibrary(String, String, long, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RepositoryRobotLibrary
Creates a new Repository Robot Library, with credentials for the repository
request(RQLRequest) - Method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Processes an RQLRequest.
request(RQLRequest, RQLHandler) - Method in class com.kapowtech.robosuite.api.java.rql.engine.AbstractRQLEngine
Executes an RQLRequest.
request(RQLRequest, RQLHandler) - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentSupportRQLEngine
Executes an RQLRequest.
request(RQLRequest, RQLHandler) - Method in class com.kapowtech.robosuite.api.java.rql.engine.dist.ClientSideDistributingRQLEngine
 
request(RQLRequest, RQLHandler) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.RQLEngine
Executes an RQLRequest.
Request - Class in com.kapowtech.robosuite.api.java.rql
A requests that will run a Robot on a RoboServer.
Request(String) - Constructor for class com.kapowtech.robosuite.api.java.rql.Request
Creates a new Request with the specified robot URL.
Request() - Constructor for class com.kapowtech.robosuite.api.java.rql.Request
Creates a new Request with no specified robot URL.
Request(Request) - Constructor for class com.kapowtech.robosuite.api.java.rql.Request
Creates a new Request from an existing Request (Copy constructor)
request(RQLRequest) - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Processes an RQLRequest.
requestAccepted(String) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.AbstractFailFastRobotResponseHandler
Doe nothing.
requestAccepted(String) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotResponseHandler
Called when the request has been accepted, and has placed in RoboServers queue.
RequestExecutor - Class in com.kapowtech.robosuite.api.java.rql.engine.hotstandby
A RobotExecutor that can execute robots in a load balanced fashion across the RoboServers in a cluster.
RequestExecutor(Cluster) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Create a RoboServerCluster from a static Cluster (you may add/remove servers programmatically later) When the RoboServerCluster is create it pings all known RoboServer, this may block fo a some time if hostname is not found
RequestExecutor(Cluster, ExecutorLogger) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Create a RoboServerCluster from a static Cluster (you may add/remove servers programmatically later) When the RoboServerCluster is create it pings all known RoboServer, this may block fo a some time if hostname is not found
RequestExecutor(Cluster, ExecutorLogger, RQLEngineFactory) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Create a RoboServerCluster from a static Cluster (you may add/remove servers programmatically later) When the RoboServerCluster is create it pings all known RoboServer, this may block fo a some time if hostname is not found
RequestExecutor(RepositoryClient, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Create a RoboServerCluster from a cluster loaded through the repository API.
RequestExecutor(RepositoryClient, String, long) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Create a RoboServerCluster from a cluster loaded through the repository API.
RequestExecutor(RepositoryClient, String, long, ExecutorLogger) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Create a RoboServerCluster from a cluster loaded through the repository API.
RequestExecutor(RepositoryClient, String, long, RQLEngineFactory, ExecutorLogger) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Create a RoboServerCluster from a cluster loaded through the repository API.
requestHandle(RQLRequest, RQLHandler) - Method in class com.kapowtech.robosuite.api.java.rql.engine.AbstractRQLEngine
Executes an RQLRequest and returns a handle to the received RQLResponses.
requestHandle(RQLRequest, RQLHandler) - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.RemoteRQLEngine
 
requestSent(RoboServer, ExecuteRequest) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.AbstractFailFastRobotResponseHandler
does nothing, override if you wish to be notified when the request has been sent to a RoboServer
requestSent(RoboServer, ExecuteRequest) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotResponseHandler
Receive notification that the request has been sent to a RoboServer
ResourceDeploymentDescriptorProvider - Class in com.kapowtech.robosuite.api.java.rql.engine.deploy
Reads a deployment descriptor from a resource in the the classpath.
ResourceDeploymentDescriptorProvider(Class, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.ResourceDeploymentDescriptorProvider
Creates a new DeploymentDescriptorProvider that reads a DeploymentDescriptor from a resource in the classpath.
ResourceProvider - Interface in com.kapowtech.robosuite.api.java.rql.engine.deploy
Provides access to named resources in a given context.
ResponseCollectingRQLHandler - Class in com.kapowtech.robosuite.api.java.rql.engine
Wraps another RQLHandler instance, collecting all generated RQLResponses, and properly initializes all RQLExceptions thrown by the wrapped handler.
ResponseCollectingRQLHandler(RQLRequest, RQLHandler) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.ResponseCollectingRQLHandler
Creates a new ResponseCollectingRQLHandler.
ResponseFilteringRQLHandler - Interface in com.kapowtech.robosuite.api.java.rql.engine
In addition to receiving notifications about RQLResponses this handler decides whether to include the response in the list of responses returned from RQLEngine.execute.
RoboServer - Class in com.kapowtech.robosuite.api.java.repository.construct
Models a RoboServer associated with a cluster on the Management Console
RoboServer(String, int) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.RoboServer
Creates a new instance
RoboServer(String, int, boolean) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.RoboServer
Deprecated. this constructor is deprecated. Use RoboServer.RoboServer(String, int) and remove the third argument as it is no longer used.
ROBOSUITE_5_0 - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Deprecated. 
ROBOSUITE_6_0 - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Deprecated. 
ROBOSUITE_6_1 - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Deprecated. 
ROBOSUITE_6_2 - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Deprecated. 
ROBOSUITE_6_3 - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Deprecated. 
ROBOSUITE_6_4 - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Deprecated. 
ROBOSUITE_6_5 - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Deprecated. 
ROBOSUITE_7_0 - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Deprecated. 
ROBOSUITE_7_1 - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Deprecated. 
ROBOSUITE_7_2 - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Deprecated. 
ROBOSUITE_8_0 - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Deprecated. 
Robot - Class in com.kapowtech.robosuite.api.java.repository.construct
A robot object, describes a robot in the Robot repository.
Robot(String, String, Date) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.Robot
Constructs a new Robot object.
ROBOT_LIBRARY - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
ROBOT_STOP_REQUESTED - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
ROBOT_URL - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
robotDone(RobotDoneEvent) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.AbstractFailFastRobotResponseHandler
Does nothing.
robotDone(RSInfo, String) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
tells the executor that a Robot has completed
robotDone(RobotDoneEvent) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotResponseHandler
Called when the API has detected that the robot is done executing
RobotDoneEvent - Class in com.kapowtech.robosuite.api.java.rql.engine.hotstandby
Specifies why a robot is done running on RoboServer
RobotErrorResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
A RobotErrorResponse is a RobotResponse that contains a robot generated error status message.
RobotErrorResponse(Date, String, String, int, int, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RobotErrorResponse
Creates a RobotMessageResponse with the specified property values.
RobotErrorResponseException - Exception in com.kapowtech.robosuite.api.java.rql
Signals that a RobotErrorResponse has raised an exception.
RobotErrorResponseException(RobotErrorResponse) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RobotErrorResponseException
Constructs a new RobotErrorResponseException with the specified detail message.
RobotErrorResponseException(RobotErrorResponse, RQLRequest, List) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RobotErrorResponseException
Constructs a new RobotErrorResponseException with the specified detail message, and execution details.
RobotExecutionParameterBuilder - Class in com.kapowtech.robosuite.api.java.rql
Controls the execution of a Robot on RoboServer.
RobotExecutionParameterBuilder() - Constructor for class com.kapowtech.robosuite.api.java.rql.RobotExecutionParameterBuilder
Constructor
RobotExecutionParameterBuilder(RobotExecutionParameterBuilder) - Constructor for class com.kapowtech.robosuite.api.java.rql.RobotExecutionParameterBuilder
Create a new instance form an existing one
RobotExecutor - Class in com.kapowtech.robosuite.api.java.rql
Deprecated. You should use the Request class class to execute robots. Check the Java Programmers Guide of the online documentation.
RobotFailedException - Exception in com.kapowtech.robosuite.api.java.rql
Signals that the robot failed for some reason.
RobotFailedException(ServerExecutionEventResponse) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RobotFailedException
Constructs a new ServerExecutionEventResponseException with the specified detail message and RQLResponse.
RobotFailedException(ServerExecutionEventResponse, RQLRequest, List) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RobotFailedException
Constructs a new ServerExecutionEventResponseException with the specified detail message, RQLResponse and execution details.
RobotLibrary - Interface in com.kapowtech.robosuite.api.java.rql.construct
Represents a robot library or workspace.
RobotMessageResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
A RobotMessageResponse is a RobotResponse that contains a robot generated non-error status message.
RobotMessageResponse(Date, String, String, int, int, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RobotMessageResponse
Creates a RobotMessageResponse with the specified property values.
RobotOutputObjectResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
A RobotOutputObjectResponse is a RobotResponse that contains an extracted object.
RobotOutputObjectResponse(Date, String, String, int, int, RQLObject) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RobotOutputObjectResponse
Creates a RobotOutputObjectResponse with the specified property values.
RobotResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
A RobotResponse is an RQLResponse that contains information related to the execution of a robot.
RobotResponseHandler - Interface in com.kapowtech.robosuite.api.java.rql.engine.hotstandby
An interface that will receive events when responses are returned by a robot
RobotSignature - Class in com.kapowtech.robosuite.api.java.repository.construct
Models a robot signature, detailing the input needed to execute the robot
RobotSignature(String, String, Date, InputObject[]) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature
Deprecated. use the constructor that also specifies the returned and stored types.
RobotSignature(String, String, Date, InputObject[], Type[], Type[]) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature
Creates a new RobotSignature
robotStarted(Stoppable) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.AbstractFailFastRobotResponseHandler
Does nothing.
robotStarted(Stoppable) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotResponseHandler
Called when the robot starts to execute on RoboServer
RobotStatus - Class in com.kapowtech.robosuite.api.java.rql.construct
The status of a robot on RoboServer.
RobotStatus(AbstractMap<String, Object>) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
RobotStoppedException - Exception in com.kapowtech.robosuite.api.java.rql
Signals that robot execution was stopped following a StopRequest.
RobotStoppedException(ServerExecutionEventResponse) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RobotStoppedException
Constructs a new RobotStoppedException from the specified ServerExecutionEventResponse with the specified detail message and RQLResponse.
RobotStoppedException(ServerExecutionEventResponse, RQLRequest, List) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RobotStoppedException
Constructs a new RobotStoppedException with the specified detail message, RQLResponse and execution details.
RoundRobinDistributionPolicy - Class in com.kapowtech.robosuite.api.java.rql.engine.dist
A round-robin distribution policy picks one of a list of RQL engines in sequence.
RoundRobinDistributionPolicy(List) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.dist.RoundRobinDistributionPolicy
Constructor.
RoundRobinDistributionPolicy(List, long, long) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.dist.RoundRobinDistributionPolicy
Constructor.
RQLConstruct - Class in com.kapowtech.robosuite.api.java.rql.construct
An RQLConstruct is an object representation of a language construct of the Robot Query Language (RQL).
RQLEngine - Interface in com.kapowtech.robosuite.api.java.rql.engine
Represents an engine that generates a number of RQLResponses when it receives a RQLRequest.
RQLEngineFactory - Interface in com.kapowtech.robosuite.api.java.rql.engine.hotstandby
Interface for creating the RQLEngine used by the RequestExecutor Class must be thread safe!
RQLException - Exception in com.kapowtech.robosuite.api.java.rql
Base class for all checked exceptions in the RoboSuite Java API.
RQLException(String, Throwable, RQLRequest, List) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RQLException
Constructs a new RQLException with the specified detail message, cause and execution details.
RQLException(String, RQLRequest, List) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RQLException
Constructs a new RQLException with the specified detail message, and execution details.
RQLException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RQLException
Constructs a new RQLException with the specified detail message and cause.
RQLException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RQLException
Constructs a new RQLException with the specified detail message.
RQLException(Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RQLException
Constructs a new RQLException with the specified cause and a detail message of (cause==null ? null : cause.toString()).
RQLHandler - Interface in com.kapowtech.robosuite.api.java.rql.engine
Receive notification of RQLResponses generated by an RQLEngine.
RQLHandlerDecorator - Class in com.kapowtech.robosuite.api.java.rql.engine
Support class for implementing RQL Handlers that decorate (wraps) another RQL handler.
RQLHandlerDecorator(RQLHandler) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.RQLHandlerDecorator
Constructor.
RQLObject - Class in com.kapowtech.robosuite.api.java.rql.construct
Represents an object that can be passed as input to a robot, or returned as output when the robot is executed.
RQLObject(String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RQLObject
Creates a new RQLObject with no attributes.
RQLObject(String, List) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RQLObject
Creates a new RQLObject with the given list of attribute entries.
RQLObject(String, List, List) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RQLObject
Creates a new RQLObject with the given list of attributes.
RQLObject(String, String[], Object[]) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RQLObject
Creates a new RQLObject with the given list of attributes.
RQLObject(RQLObject) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RQLObject
Simple copy constructor, which can be used to create RQLObjects from ExtractedObjects or QueryParameters.
RQLObjectBuilder - Class in com.kapowtech.robosuite.api.java.rql
Used to build RQL Objects, typically for use as input objects to a robot.
RQLObjectBuilder(String) - Constructor for class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Creates a new RQLObjectBuilder that creates an RQLObject with the given name.
RQLObjectBuilder(RQLObject) - Constructor for class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Creates a new RQLObjectBuilder that creates an RQLObject from a specified prototype.
RQLObjects - Class in com.kapowtech.robosuite.api.java.rql.construct
Represents a collection of Input or Output Objects sent to or received from a robot.
RQLObjects() - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RQLObjects
Creates an empty RQLObjects object.
RQLObjects(RQLObject) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RQLObjects
Creates an RQLObjects parameter containing a single object.
RQLObjects(List) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RQLObjects
Creates an RQLObjects that contains the following list of objects.
RQLProtocol - Interface in com.kapowtech.robosuite.api.java.rql.engine.remote
An RQLProtocol offers a means of transporting RQLConstructs across some medium.
RQLProtocolException - Exception in com.kapowtech.robosuite.api.java.rql
Signals an error in the underlying communications protocol.
RQLProtocolException(Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RQLProtocolException
Constructs a new RQLProtocolException with the specified cause and a detail message of (cause==null ? null : cause.toString()).
RQLProtocolException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RQLProtocolException
Constructs a new RQLProtocolException with the specified detail message.
RQLProtocolException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RQLProtocolException
Constructs a new RQLProtocolException with the specified detail message and cause.
RQLProtocolException(String, Throwable, RQLRequest, List) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RQLProtocolException
Constructs a new RQLProtocolException with the specified detail message, cause and execution details.
RQLProtocolException(String, RQLRequest, List) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RQLProtocolException
Constructs a new RQLProtocolException with the specified detail message, and execution details.
RQLRequest - Class in com.kapowtech.robosuite.api.java.rql.construct
An RQLRequest is an RQLConstruct that request some service.
RQLRequest() - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest
Constructor.
RQLRequest(String, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest
Constructs a RQLRequest with a destination which can be validated by the receiver
RQLRequestHandle - Interface in com.kapowtech.robosuite.api.java.rql.engine
Represents a handle that can be used to query for more requests.
RQLResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
An RQLResponse is an RQLConstruct sent as a response to an RQLRequest.
RQLResponse(Date) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.RQLResponse
Constructor.
RQLResponseException - Exception in com.kapowtech.robosuite.api.java.rql
Base class for exceptions that are raised as a result of an RQLResponse.
RQLResponseException(String, RQLResponse) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RQLResponseException
Constructs a new RQLResponseException with the specified detail message and RQLResponse.
RQLResponseException(String, RQLResponse, RQLRequest, List) - Constructor for exception com.kapowtech.robosuite.api.java.rql.RQLResponseException
Constructs a new RQLResponseException with the specified detail message, RQLResponse and execution details.
RQLResult - Class in com.kapowtech.robosuite.api.java.rql
Encapsulates the result of a robot execution.
RQLResult(RQLRequest, List) - Constructor for class com.kapowtech.robosuite.api.java.rql.RQLResult
Creates a new RQLResult object based on the result of processing an RQLRequest.
RQLSession - Interface in com.kapowtech.robosuite.api.java.rql.engine.remote
An RQLSession can send RQLRequests and receive RQLResponses via some medium of transport defined by an RQLProtocol.
RUNNING - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus
Signals that the robot is currently executing.

S

SecureReaderWriterPairFactory - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
 
SecureReaderWriterPairFactory() - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SecureReaderWriterPairFactory
 
SecureSocketBasedObjectRQLProtocol - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
A protocol that sends RQL using a secure socket connection to RoboServer.
SecureSocketBasedObjectRQLProtocol(String, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SecureSocketBasedObjectRQLProtocol
Creates a new SecureSocketBasedObjectRQLProtocol connecting to the given host and port.
SecureSocketBasedObjectRQLProtocol(String, int, SSLConfiguration) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SecureSocketBasedObjectRQLProtocol
Creates a new SecureSocketBasedObjectRQLProtocol connecting to the given host and port, with the given SSLConfiguration
selectAvailableRQLEngines() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.dist.DistributionPolicy
Selects all available RQL engines, and returns them as a list.
selectAvailableRQLEngines() - Method in class com.kapowtech.robosuite.api.java.rql.engine.dist.LoadBalancingRoundRobinDistributionPolicy
 
selectAvailableRQLEngines() - Method in class com.kapowtech.robosuite.api.java.rql.engine.dist.RandomDistributionPolicy
 
selectAvailableRQLEngines() - Method in class com.kapowtech.robosuite.api.java.rql.engine.dist.RoundRobinDistributionPolicy
 
selectAvailableRQLEngines() - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Returns a list of online RQLEngines This is used for multicast requests, so engines that have no available slots are also returned
send(RQLRequest) - Method in interface com.kapowtech.robosuite.api.java.rql.engine.remote.RQLSession
Sends the specified RQL request.
sendXML(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
Sends the XML document to the repository.
ServerErrorResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
A ServerErrorResponse is a ServerResponse that contains error information related to the operation of the server sending the response.
ServerErrorResponse(Date, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ServerErrorResponse
Creates a ServerErrorResponse with the specified property values.
ServerErrorResponseException - Exception in com.kapowtech.robosuite.api.java.rql
Signals that a ServerErrorResponse has raised an exception.
ServerErrorResponseException(ServerErrorResponse) - Constructor for exception com.kapowtech.robosuite.api.java.rql.ServerErrorResponseException
Constructs a new ServerErrorResponseException with the specified detail message.
ServerErrorResponseException(ServerErrorResponse, RQLRequest, List) - Constructor for exception com.kapowtech.robosuite.api.java.rql.ServerErrorResponseException
Constructs a new ServerErrorResponseException with the specified detail message, and execution details.
ServerExecutionEventResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
A ServerExecutionEventResponse is a ServerInfoResponse that contains event information related to the execution of a robot, such as it being started and stopped.
ServerExecutionEventResponse(Date, ExecutionEvent, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ServerExecutionEventResponse
Creates a ServerExecutionEventResponse with the specified property values.
ServerExecutionEventResponseException - Exception in com.kapowtech.robosuite.api.java.rql
Base class for all exceptions that are triggered by a ServerExecutionEventResponse.
ServerExecutionEventResponseException(String, ServerExecutionEventResponse) - Constructor for exception com.kapowtech.robosuite.api.java.rql.ServerExecutionEventResponseException
Constructs a new ServerExecutionEventResponseException with the specified detail message and RQLResponse.
ServerExecutionEventResponseException(String, ServerExecutionEventResponse, RQLRequest, List) - Constructor for exception com.kapowtech.robosuite.api.java.rql.ServerExecutionEventResponseException
Constructs a new ServerExecutionEventResponseException with the specified detail message, RQLResponse and execution details.
ServerInfoResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
A ServerInfoResponse is a ServerResponse that contains non-error information related to the operation of the server sending the response.
ServerResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
A ServerResponse is an RQLResponse that contains information related to the operation of the server sending the response.
ServerTrustMaterial - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
This class controls the what servers the client trusts.
ServerTrustMaterial(byte[], char[]) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerTrustMaterial
Creates ServerTrustMaterial based on certificate bytes and the password of the certificate
ServerTrustMaterial(byte[]) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerTrustMaterial
Creates ServerTrustMaterial based on certificate bytes which doesn't have a password
ServerTrustMaterial(File, char[]) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerTrustMaterial
Creates ServerTrustMaterial based on a server certificate file and the password of the certificate
ServerTrustMaterial(File) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerTrustMaterial
Creates ServerTrustMaterial based on a server certificate file with no password
ServletDeploymentDescriptorProvider - Class in com.kapowtech.robosuite.api.java.rql.engine.deploy
Provides special processing for reading a deployment descriptor in a web application context.
ServletDeploymentDescriptorProvider(String, ServletContext) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.ServletDeploymentDescriptorProvider
Creates a new deployment descriptor provider that reads the DeploymentDescriptor from a resource accessible from a ServletContext.
SESSION - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Session used in Design Studio types
SESSION - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Represents the Session complex data type in RoboSuite.
Session - Class in com.kapowtech.robosuite.api.java.rql.construct
Represents a session held by a robot.
Session(Binary, String, String, List, Binary, Date) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Session
Creates a new robot session.
Session(String, String, List, Binary, Date) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Session
Creates a new robot session.
Session(List) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Session
Creates a new robot session, containing the specified cookies, no authentications, empty document and referrer URLs and a timestamp equal to the current system time.
setAttribute(String, Object) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Adds a new attribute with the given name and value to the RQL Object under construction.
setAttribute(String, String) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Adds a new attribute with the given name and value to the RQL Object that is under construction.
setAttribute(String, long) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Adds a new integer type attribute with the given name and value to the RQL Object that is under construction.
setAttribute(String, boolean) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Adds a new boolean type attribute with the given name and value to the RQL Object that is under construction.
setAttribute(String, char) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Adds a new character type attribute with the given name and value to the RQL Object that is under construction.
setAttribute(String, double) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Adds a new number type attribute with the given name and value to the RQL Object that is under construction.
setAttribute(String, Date) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Adds a new date type attribute with the given name and value to the RQL Object that is under construction.
setAttribute(String, Binary) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Adds a new binary type attribute with the given name and value to the RQL Object that is under construction.
setAttribute(String, byte[]) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Adds a new binary type attribute with the given name and value to the RQL Object that is under construction.
setAttribute(Attribute) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Adds a new attribute to the RQL Object that is under construction.
setAttributes(Map) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Sets several attributes, initialized from the names and values of a java.util.Map.
setDeploymentDescriptor(DeploymentDescriptor) - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.SimpleDeploymentDescriptorProvider
Sets the DeploymentDescriptor to return when the getDeploymentDescriptor method is invoked.
setExecutionId(String) - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Allows the client to set the executionId, instead of having one generated automatically on the server.
setExecutionId(String) - Method in class com.kapowtech.robosuite.api.java.rql.Request
Allows the client to set the executionId, instead of having one generated automatically on the server.
setMaxExecutionTime(int) - Method in class com.kapowtech.robosuite.api.java.rql.Request
Set the maximum execution time for this robot, when the robot starts executed a timer is started, when the given time period has elapsed the robot is stopped by RoboServer.
setMaxExecutionTime(int) - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutionParameterBuilder
set the maxExecutionTime property
setName(String) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Returns the name of the object under construction.
setOEMKey(String) - Method in class com.kapowtech.robosuite.api.java.rql.Request
Sets an OEM KEY.
setPassword(String) - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Sets the password used for authenticating this request
setPassword(String) - Method in class com.kapowtech.robosuite.api.java.rql.Request
Sets the password used for authenticating this request on RoboServer
setProject(String) - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Set the project name that this request.
setProject(String) - Method in class com.kapowtech.robosuite.api.java.rql.Request
Set the project name that this request.
setRobotLibrary(RobotLibrary) - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Specify what robot library to use in the execute request.
setRobotLibrary(RobotLibrary) - Method in class com.kapowtech.robosuite.api.java.rql.Request
Specify what robot library to use in the execute request.
setRobotURL(String) - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Returns the currently configured robotURL property.
setRobotURL(String) - Method in class com.kapowtech.robosuite.api.java.rql.Request
Returns the currently configured robotURL property.
setStopOnConnectionLost(boolean) - Method in class com.kapowtech.robosuite.api.java.rql.Request
When set, the Robot will be stopped on RoboServer if the connection to the client is lost.
setStopRobotIfConnectionLost(boolean) - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutionParameterBuilder
set the value of the stopRobotIfConnectionLost property
setStopRobotOnApiException(boolean) - Method in class com.kapowtech.robosuite.api.java.rql.Request
When set, the robot will be stopped on RoboServer after the first API exception is sent back to the client.
setStopRobotOnApiException(boolean) - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutionParameterBuilder
set the value of the stopRobotOnApiException property
setTimeToLive(int) - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.CachingDeploymentDescriptorProvider
Sets the maximum age (in seconds) a cached DeploymentDescriptor can have before it is reloaded from the wrapped DeploymentDescriptorProvider.
setUsername(String) - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. sets username user for authenticate the request
setUsername(String) - Method in class com.kapowtech.robosuite.api.java.rql.Request
sets user name used for authenticate the request on RoboServer
setValue(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Attribute
This operation is not supported by this class, always throwing an UnsupportedOperationException.
SHORT_TEXT - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type Short Text used in Design Studio types
shutdown() - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
Shuts down the RoboServerCluster.
shutdown() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RQLEngineFactory
Shuts down the Factory.
shutdown() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.DefaultRQLEngineFactory
 
shutdown() - Static method in class com.kapowtech.robosuite.api.java.rql.Request
Shuts down any registered clusters and repositories, this should be called when your application exists (If you have called Request.registerCluster()).
ShutdownMethod - Class in com.kapowtech.robosuite.api.java.rql.construct
Argument controling how RoboServer should shutdown
ShutdownRequest - Class in com.kapowtech.robosuite.api.java.rql.construct
Request object sent to RoboServer to Restart it or Shut it down
ShutdownRequest(ShutdownMethod, int, String, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ShutdownRequest
 
ShutdownRequest(ShutdownMethod, String, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ShutdownRequest
 
ShutdownRequest(ShutdownMethod, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ShutdownRequest
Creates a shutdown request
SimpleDeploymentDescriptorProvider - Class in com.kapowtech.robosuite.api.java.rql.engine.deploy
Simple implementation of a DeploymentDescriptorProvider that returns a preconfigured DeploymentDescriptor.
SimpleDeploymentDescriptorProvider(DeploymentDescriptor) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.SimpleDeploymentDescriptorProvider
Creates a new SimpleDeploymentDescriptorProvider that will return a specific DeploymentDescriptor when invoked.
size() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Binary
Returns the number of bytes in the array.
size() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookies
 
size() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Environments
Returns the number of environments in this collection.
size() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLObjects
Returns the number of input objects in this list.
SocketBasedObjectRQLProtocol - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.socket
A socket based protocol sends RQLRequest and receives RQLResponses as serialized objects.
SocketBasedObjectRQLProtocol(String, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketBasedObjectRQLProtocol
Creates a new socket / serialized object based protocol.
SocketBasedObjectRQLProtocol(String, int, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketBasedObjectRQLProtocol
Deprecated. Has been deprecated because socket-keep-alive is preferred over read timeout
SocketBasedRQLProtocol - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.socket
Abstract base class for all socket based protocols.
SocketBasedXMLRQLProtocol - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.socket
A socket based protocol using XML to encode the RQLRequest and RQLResponses.
SocketBasedXMLRQLProtocol(String, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketBasedXMLRQLProtocol
Creates a new socket / XML based protocol.
SocketBasedXMLRQLProtocol(String, int, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketBasedXMLRQLProtocol
Deprecated. Has been deprecated because socket-keep-alive is preferred over read timeout
SocketUtil - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.socket
Utility class for dealing with sockets
SocketUtil() - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketUtil
 
SSLConfiguration - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
Used to configure SSL connections to RoboServer.
SSLConfiguration(ServerTrustMaterial, ClientCertificate) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
Creates a new SSLConfiguration with the given server trust material and client certificate CRL, Hostname and certificate expiry will not be enforced.
SSLConfiguration(ServerTrustMaterial, ClientCertificate, boolean, boolean, boolean) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
Creates a SSLConfiguration
START_REQUESTED - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
The robot has been queued for execution.
START_TIME_CLIENT - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
STARTED - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
The robot has started executing.
StartupCheck - Class in com.kapowtech.robosuite.api.java.rql.engine.remote
Utility for checking java version and required jar files
StartupCheck() - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.StartupCheck
 
STATUS - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
STATUS_AWAITING_ACTIVATION - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
The status when the server has not yet been activated
STATUS_OBJECTS - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus
A list of all the supported ExecutionStatus types.
STATUS_RUNNING - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
The status when the server is running
STATUS_SHUTTING_DOWN - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
The status when the server is shutting down
StatusRequest - Class in com.kapowtech.robosuite.api.java.rql.construct
Requests that causes RoboServer to send back a StatusResponse with details about executing Robots.
StatusRequest() - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.StatusRequest
Constructs a new requests without credentials
StatusRequest(String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.StatusRequest
Creates a new request with credentials
StatusRequest(String, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.StatusRequest
Constructor with host/IP and credentials
StatusResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
Response containing runtime data for the robots executing on RoboServer
StatusResponse(List<RobotStatus>, Date) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.StatusResponse
 
STEP_EXECUTION_TIME - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
stop(String) - Method in class com.kapowtech.robosuite.api.java.rql.ConcurrentRobotExecutor
Deprecated. Requests that a robot with a specific execution id is stopped.
stop() - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.DefaultStoppable
Sends a stop request to the RoboServer executing this robot.
stop() - Method in interface com.kapowtech.robosuite.api.java.rql.engine.hotstandby.Stoppable
Sends the stop request to RoboServer.
stop() - Method in class com.kapowtech.robosuite.api.java.rql.FutureRQLResult
Deprecated. Requests that the execution of this request be cancelled.
stop(String) - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Requests that a robot with a specific execution id is stopped.
stop(String, String, String) - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
Deprecated. Requests that a robot with a specific execution id is stopped.
STOP_EXECUTIONS_FIRST - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ShutdownMethod
RoboServer must stop all executing robots, and then stop
STOP_EXECUTIONS_FIRST_THEN_RESTART - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ShutdownMethod
RoboServer must stop all executing robots before restarting
STOP_IF_CONNECTION_LOST - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
STOP_ON_API_EXCEPTION - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
STOP_REQUESTED - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
The robot has been requested to stop with a StopRequest.
Stoppable - Interface in com.kapowtech.robosuite.api.java.rql.engine.hotstandby
An object that allows you to stop a robot that is executing on RoboServer.
STOPPED - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
The execution has stopped in response to a StopRequest.
STOPPED - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotDoneEvent
Specifies that the robot has ended its execution because it was stopped
StopRequest - Class in com.kapowtech.robosuite.api.java.rql.construct
The StopRequest is an RQLRequest that requests a robot to stop executing on a server.
StopRequest(String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.StopRequest
Creates a StopRequest with the specified execution id.
StopRequest(String, String, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.StopRequest
Package private constructor for initializing ipAddress and hostName properties with credentials.
StringSourceServletDeploymentDescriptorProvider - Class in com.kapowtech.robosuite.api.java.rql.engine.deploy
Provides special processing for reading a deployment descriptor from a string source in a web application context.
StringSourceServletDeploymentDescriptorProvider(String, ServletContext) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.StringSourceServletDeploymentDescriptorProvider
Creates a new deployment descriptor provider that reads its deployment descriptor from an XML string, resolving relative URLs relative to a web application servlet context.
StringSourceServletDeploymentDescriptorProvider(String, String, ServletContext) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.StringSourceServletDeploymentDescriptorProvider
Creates a new deployment descriptor provider that reads its deployment descriptor from an XML string, resolving relative URLs relative to a web application servlet context.

T

TEXT - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Corresponds to the ShortText and LongText data types in RoboSuite.
ThreadDumpRequest - Class in com.kapowtech.robosuite.api.java.rql.construct
Request sent to RoboServer to perform a thread dump of all threads, and return them as a ThreadDumpResponse
ThreadDumpRequest() - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ThreadDumpRequest
Constructor.
ThreadDumpRequest(String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ThreadDumpRequest
Constructs a PingRequest with credentials.
ThreadDumpResponse - Class in com.kapowtech.robosuite.api.java.rql.construct
Response from RoboServer containing Thread dump string
ThreadDumpResponse(Date, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ThreadDumpResponse
 
TIME_OF_LAST_EXTRACTED_VALUE - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
toBase64String() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Binary
Returns a Base64 encoded representation of the bytes in the array.
toBase64String() - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmbeddedFileBasedRobotLibrary
Returns a Base64 encoded representation of the bytes in the embedded library.
toByteArray() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Binary
Returns the bytes in the object as a byte[] instance.
toByteArray() - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmbeddedFileBasedRobotLibrary
Returns the embedded robot library, as an array of bytes.
toCommonEnvironment() - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutionParameterBuilder
convert to Legacy environment
toExecuteRequest() - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
Deprecated. Creates a new ExecuteRequest initialized with the current settings of this object.
toExecuteRequest() - Method in class com.kapowtech.robosuite.api.java.rql.Request
Creates a new ExecuteRequest initialized with the current settings of this object.
toRQLObject() - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
Creates a new RQLObject initialized with the the values placed in this object.
toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Attribute
 
toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
returns a string with all property values (subject to change, do not parse this string)
toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Cluster
returns a string with all property values (subject to change, do not parse this string)
toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputAttribute
returns a string with all property values (subject to change, do not parse this string)
toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.InputObject
returns a string with all property values (subject to change, do not parse this string)
toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Project
returns a string with all property values (subject to change, do not parse this string)
toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RoboServer
returns a string with all property values (subject to change, do not parse this string)
toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot
returns a string with all property values (subject to change, do not parse this string)
toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RobotSignature
returns a string with all property values (subject to change, do not parse this string)
toString() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Type
returns a string with all property values (subject to change, do not parse this string)
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Attribute
Returns a string representation of the object.
toString(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Returns a string representation of the given value, formatted with the settings given in this attribute type.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
Returns a string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Binary
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CommonRobotEnvironment
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Cookies
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.CustomEnvironment
Returns a string representation of the object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.DefaultRobotLibrary
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmailMessageEnvironment
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmbeddedFileBasedRobotLibrary
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionEvent
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.InputObjectEnvironment
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.InternalRequest
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.InternalResponse
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.MultiplexingRQLConstruct
 
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingRequest
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
Prints values of properties.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RepositoryRobotLibrary
 
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotErrorResponse
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotMessageResponse
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotOutputObjectResponse
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotResponse
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotStatus
 
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLConstruct
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLObject
Returns a string representation of the object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RQLResponse
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerErrorResponse
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerExecutionEventResponse
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerInfoResponse
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ServerResponse
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Session
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.StatusResponse
 
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.StopRequest
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ThreadDumpRequest
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ThreadDumpResponse
 
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.URLFileBasedRobotLibrary
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.URLFolderBasedRobotLibrary
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentDescriptor
Returns a string representation of the object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.DeploymentSupportRQLEngine
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RobotDoneEvent
 
toString() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.RemoteRQLEngine
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.socket.SocketBasedRQLProtocol
Returns a human readable string representation of this object.
toString() - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
Returns a string representation of the object.
TRIAL_VERSION_LIMITATION_PREFIX - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.RQLRequest
Deprecated. Trial version has been removed The prefix for all error messages which is a result of the trial version limitations.
TRUST_ALL - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerTrustMaterial
Used if the client should trust any server it connects to
TRUST_ALL - Static variable in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
A configuration that doesn't validate the certificate used by RoboServer, and doesn't use a client certificate.
Type - Class in com.kapowtech.robosuite.api.java.repository.construct
A description of a type returned or stored by the robot.
Type(String, Attribute[]) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.Type
Constructs a new type.

U

UnableToConnectException - Exception in com.kapowtech.robosuite.api.java.rql.engine
Signals that a connection could not be opened to a Connector Server.
UnableToConnectException(Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.UnableToConnectException
Constructs a new UnableToConnectException with the specified cause and a detail message of (cause==null ? null : cause.toString()).
UnableToConnectException(String) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.UnableToConnectException
Constructs a new UnableToConnectException with the specified detail message.
UnableToConnectException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.rql.engine.UnableToConnectException
Constructs a new UnableToConnectException with the specified detail message and cause.
UNKNOWN - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
An unknown attribute type
update(Cookie, long) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Reduces the maxAge of a persistent cookie.
update(Cookie, long, long) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.Cookie
Reduces the maxAge of a persistent cookie.
update(Cookies, long) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.Cookies
Updates the cookies.
update(Cookies, long, long) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.Cookies
Updates the cookies.
update(Session, long) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.Session
Updates the persistent cookies in the session.
update(Session, long, long) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.Session
Updates the cookies in the session.
URLDeploymentDescriptorProvider - Class in com.kapowtech.robosuite.api.java.rql.engine.deploy
Returns a deployment descriptor that can be read from an URL.
URLDeploymentDescriptorProvider(URL) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.deploy.URLDeploymentDescriptorProvider
Creates a new DeploymentDescriptorProvider that reads an XML file placed at a URL.
URLFileBasedRobotLibrary - Class in com.kapowtech.robosuite.api.java.rql.construct
Sends a packed robot library as a URL reference.
URLFileBasedRobotLibrary(String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.URLFileBasedRobotLibrary
Creates a new URL reference to a packed robot library, that RoboServer should not cache.
URLFileBasedRobotLibrary(String, int) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.URLFileBasedRobotLibrary
Creates a new URL reference to a packed robot library, that RoboServer should keep a cached copy of.
URLFolderBasedRobotLibrary - Class in com.kapowtech.robosuite.api.java.rql.construct
An unpacked robot library placed in the local filesystem of the RoboServer.
URLFolderBasedRobotLibrary(String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.URLFolderBasedRobotLibrary
Creates a new URLFolderBasedRobotLibrary.

V

valueOfBase64(String) - Static method in class com.kapowtech.robosuite.api.java.rql.construct.Binary
Returns a new Binary object with a value represented by the specified Base64 encoded string.
verifyCOMMONS_SSL_FOUND() - Static method in class com.kapowtech.robosuite.api.java.rql.engine.remote.StartupCheck
 
verifyJVM_1_5_OR_HIGHER() - Static method in class com.kapowtech.robosuite.api.java.rql.engine.remote.StartupCheck
 
verifyRepositoryRequirements() - Static method in class com.kapowtech.robosuite.api.java.rql.engine.remote.StartupCheck
 

W

WAIT_FOR_EXECUTIONS_TO_COMPLETE - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ShutdownMethod
RoboServer must wait for all executions to finish before shutting down
WAIT_FOR_EXECUTIONS_TO_COMPLETE_THEN_RESTART - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.ShutdownMethod
RoboServer must wait for all executions to complete before restarting
waitForStatus(ExecutionStatus) - Method in class com.kapowtech.robosuite.api.java.rql.FutureRQLResult
Deprecated. Waits until the execution has reached a certain point, represented by the execution status.
waitUntilReady(long) - Method in class com.kapowtech.robosuite.api.java.rql.FutureRQLResult
Deprecated. Causes the current thread to wait until the result is ready, timing out after a set amoung of time.
waitUntilReady() - Method in class com.kapowtech.robosuite.api.java.rql.FutureRQLResult
Deprecated. Causes the current thread to wait until the result is ready.
writeTo(OutputStream) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Binary
Writes the contents of this object to a stream.

X

XML - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
The attribute type XML used in Design Studio types

A B C D E F G H I J K L M N O P R S T U V W X
RoboSuite Java API, v1.87

RoboSuite Java API, v1.87