- 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.
- cancel() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest
-
Calls the associated QueuedRequestRunner to stop the execution
- 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
-
- CertificateValidityCheckingX509TrustManager - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
-
An X509TrustManager that wraps an existing X509TrustManager but adds a check towards validity of all certificates
in the chain.
- CertificateValidityCheckingX509TrustManager(X509TrustManager) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.CertificateValidityCheckingX509TrustManager
-
- ChangeEntry - Class in com.kapowtech.robosuite.api.java.repository.construct
-
It is the smallest data that is sent during MC-VCS synchronization.
- ChangeEntry() - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.ChangeEntry
-
- CHANGES - Static variable in class com.kapowtech.robosuite.api.java.rql.construct.AttributeType
-
- ChangeType - Enum in com.kapowtech.robosuite.api.java.repository.construct
-
During synchronization MC and VCS send each other differences (ChangeEntries) accumulated since previous
synchronization.
- 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.
- check(Document, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.messages.Response
-
- checkClientTrusted(X509Certificate[], String) - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.CertificateValidityCheckingX509TrustManager
-
- checkServerTrusted(X509Certificate[], String) - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.CertificateValidityCheckingX509TrustManager
-
- 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.
- clearBearerToken(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2CredentialsTokenClient
-
- clearBearerToken(String, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2RefreshTokenClient
-
- 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.
- CLIENT_CREDENTIALS - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2AuthenticationProvider
-
- CLIENT_ID - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2AuthenticationProvider
-
- ClientCertificate - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
-
A client certificate is used to authenticate the client with the server.
- 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, the given bytes must be
PKCS12 encoded
- 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
- CODE - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2AuthenticationProvider
-
- CODE_VERIFIER - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2AuthenticationProvider
-
- 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.repository.engine.messages - package com.kapowtech.robosuite.api.java.repository.engine.messages
-
- com.kapowtech.robosuite.api.java.repository.engine.oauth2 - package com.kapowtech.robosuite.api.java.repository.engine.oauth2
-
- com.kapowtech.robosuite.api.java.rest - package com.kapowtech.robosuite.api.java.rest
-
- 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
-
- 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.
- computeChecksum(byte[]) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
Compute checksum for given bytes.
- ConcurrentRobotExecutor - Class in com.kapowtech.robosuite.api.java.rql
-
- configureHttpClient(ProxyServerConfiguration) - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl
-
- 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
-
- Cookies - Class in com.kapowtech.robosuite.api.java.rql.construct
-
- Cookies(List<Cookie>) - 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
- create(GetRobotsByTag.Data) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag
-
- create(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetVcsFilesRequest
-
- create(McVcsConfiguration) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.McVcsConfigurationResponseMessage
-
- create(T) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.messages.Message
-
creates xml document of the required type stuffed with the specified data
- create(Collection<OAuthUserEntry>) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.OAuthUserEntryListResponse
-
- create(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.ResetVcsSyncRequest
-
- create(Collection<Robot>) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.RobotListResponse
-
- create(Void) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.UpdateSuccessful
-
- create(VcsChangeData) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.VcsChanges
-
- create(Void) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.VcsConfigurationRequest
-
- create(HttpContext) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2ServiceSchemeProvider
-
- create(HttpContext) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2UserSchemeProvider
-
- createContext() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2ServiceHttpClientProvider
-
- createContext() - Method in interface com.kapowtech.robosuite.api.java.rql.construct.RepositoryHttpClientProvider
-
Creates a new HttpClientContext instance.
HttpClientContext should not be reused and should be created new for each http request
as it is not safe to concurrently access same HttpClientContext from different requests
- createContext() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RepositoryRobotLibrary
-
Implementation notes: creates context with credentials if present
- createDocument(Message<T>, T) - Static method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
Compose xml document from the data using messages implementing the
Message interface
- 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.AbstractRequest
-
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.AbstractRequest
-
Creates a new Input Object with the specified name, from an RQLObject.
- createOAuthInputVariable(String, String, String) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest
-
Creates an input variable for an OAUTH input type, that will look up the OAuth details in Management Console
based on the given user name and application name.
- 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
- CredentialsAuthenticationProvider - Class in com.kapowtech.robosuite.api.java.repository.engine
-
Used to authenticate to the repository using username and password.
- CredentialsAuthenticationProvider(String, String, String, ProxyServerConfiguration) - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.CredentialsAuthenticationProvider
-
- 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.
- 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.
- EMPTY - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.VcsFields
-
- 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<Environment>) - 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.ChangeEntry
-
- 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.repository.construct.VcsChangeData
-
- equals(Object) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFields
-
- equals(Object) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsProjectConfiguration
-
- equals(Object) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsSync
-
- 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.Database
-
- equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.DatabaseEnvironment
-
- 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.Resource
-
- equals(Object) - Method in class com.kapowtech.robosuite.api.java.rql.construct.ResourceEnvironment
-
- 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.ScheduleRequest
-
- 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.ServerCertificates
-
- 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.
- EXCEPTION_MESSAGE - Static variable in exception com.kapowtech.robosuite.api.java.rql.engine.NoClusterFoundException
-
- execute() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest
-
Although this call is blocking, it will react to being interrupted.
- execute(RobotResponseHandler) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest
-
- execute() - Method in class com.kapowtech.robosuite.api.java.rql.AbstractRequest
-
Executes this request and blocks until the robot has completed or an error occurs.
- execute(RobotResponseHandler) - Method in class com.kapowtech.robosuite.api.java.rql.AbstractRequest
-
Executes this request asynchronously and uses the handler to call back with results
and status updates.
- 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() - Method in class com.kapowtech.robosuite.api.java.rql.Request
-
- execute(RobotResponseHandler) - Method in class com.kapowtech.robosuite.api.java.rql.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
-
- execute(String, RQLObject) - Method in class com.kapowtech.robosuite.api.java.rql.RobotExecutor
-
- 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
-
- ExecuteRequest(String, RQLObjects) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
- ExecuteRequest(String, RQLObjects, RobotLibrary) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
- ExecuteRequest(String, RQLObjects, RobotLibrary, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
- ExecuteRequest(String, RQLObjects, RobotLibrary, MessageEnvironment, CommonRobotEnvironment) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
- ExecuteRequest(String, RQLObjects, RobotLibrary, MessageEnvironment, CommonRobotEnvironment, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
- ExecuteRequest(String, RQLObjects, RobotLibrary, MessageEnvironment, CommonRobotEnvironment, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
- ExecuteRequest(String, RQLObjects, RobotLibrary, MessageEnvironment, CommonRobotEnvironment, String, String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
- ExecuteRequest(String, RobotLibrary, Environments) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
- ExecuteRequest(String, String, String, RobotLibrary, Environments) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
- ExecuteRequest(String, String, String, RobotLibrary, Environments, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
- ExecuteRequest(String, String, String, RobotLibrary, Environments, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
- ExecuteRequestBuilder - Class in com.kapowtech.robosuite.api.java.rql
-
- 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
-
- ExtractedObject(String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ExtractedObject
-
Deprecated.
Creates a new ExtractedObject with no attributes.
- ExtractedObject(String, List<Attribute>) - 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<String>, List<Object>) - 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.
- extractToken(String) - Static method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2AbstractProtocolClient
-
- 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.
- getAcceptedIssuers() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.CertificateValidityCheckingX509TrustManager
-
- getAccessToken() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuthTokenData
-
- getAppKey() - Method in class com.kapowtech.robosuite.api.java.rql.construct.AppKeyCustomEnvironment
-
Returns the application key.
- getApplicationName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.OAuthUserEntry
-
gets the name of the application the OAuth User Entry belongs to
- 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.
- getAuthenticationProvider() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
- getAuthenticationProvider() - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl
-
- getAuthentications() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Session
-
Returns an opaque value representing the current authentications held by the robot.
- getAuthenticationToken() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Resource
-
- getAuthor() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFields
-
- getAuthor() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- getAuthorEmail() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFields
-
- getAuthorizationGrantAccessToken(String, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.UserOAuth2AuthenticationProvider
-
Exchanges Authorization Code Grant flow code and PCKE code verifier for access and refresh tokens.
Is a helper method for a Authorization Code Grant OAuth flow.
- getAuthSchemes() - Method in class com.kapowtech.robosuite.api.java.repository.engine.AuthenticationProvider
-
- getAuthSchemes() - Method in class com.kapowtech.robosuite.api.java.repository.engine.CredentialsAuthenticationProvider
-
- getAuthSchemes() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.ServiceOAuth2AuthenticationProvider
-
returns a list of NamedAuthSchemeProvider
The returned AuthSchemeProvider implementation is not thread safe
and this method should be separately invoked for each Http request.
- getAuthSchemes() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.UserOAuth2AuthenticationProvider
-
Creates a Registry of a single OAuth2 Authorization Code Grant AuthSchemeProvider.
Should be used if you intend to use your own
HttpClient
instead of a
RepositoryClientImpl.
The returned
AuthSchemeProvider implementation is not thread safe
and this method should be separately invoked for each Http request.
- getAuthSchemes() - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl
-
- getAuthScope() - Method in class com.kapowtech.robosuite.api.java.repository.engine.AuthenticationProvider
-
- getBearerToken(String, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2AuthorizationTokenClient
-
- getBearerToken() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2CredentialsTokenClient
-
- getBearerToken(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2RefreshTokenClient
-
- getBooleanValue(String) - Method in class com.kapowtech.robosuite.api.java.rql.construct.CustomEnvironment
-
Returns the boolean value of the property with the specified name.
- getBranch() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsProjectConfiguration
-
- 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(RepositoryFile) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
Get bytes for a given RepositoryFile.
- getBytes() - Method in exception com.kapowtech.robosuite.api.java.repository.engine.FileMismatchWarningException
-
- getBytes(RepositoryFile) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
Get bytes for a given RepositoryFile.
- getBytes() - Method in class com.kapowtech.robosuite.api.java.rql.construct.EmbeddedFileBasedRobotLibrary
-
- getByType(String) - Static method in enum com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile.Type
-
- 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.
- getCertificates() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerCertificates
-
- getChangeEntries() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsChangeData
-
- getChangeType() - Method in class com.kapowtech.robosuite.api.java.repository.construct.ChangeEntry
-
- getChecksum() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile
-
- getChecksum() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot
-
Gets the checksum of the body of the robot.
- getChecksum() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- getClient() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2AbstractProtocolClient
-
- getClientCertificate() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
-
Get the configured ClientCertificate
- getClientId() - Method in enum com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2Client
-
- 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.repository.construct.AdditionalInfo
-
- getComment() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFields
-
- getComment() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- 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.
- getCommitId() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsChangeData
-
- getCommitId() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsSync
-
- 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
- getContent() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- 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
- getCurrentDate() - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
Gets the current date of Management Console with format: yyyy-MM-dd HH:mm:ss.SSS
Example: 2014-10-09 12:33:14.608
- getCurrentDate() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
Gets the current date of Management Console with format: yyyy-MM-dd HH:mm:ss.SSS
Example: 2014-10-09 12:33:14.608
- getCurrentToken(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2RefreshTokenClient
-
- getData() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Session
-
Returns an opaque value containing the current document of the session.
- getDatabase(String) - Method in class com.kapowtech.robosuite.api.java.rql.construct.DatabaseEnvironment
-
- getDatabaseEnvironment() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
Returns the database environment, or null if none.
- getDatabases() - Method in class com.kapowtech.robosuite.api.java.rql.construct.DatabaseEnvironment
-
- getDatabases() - Method in class com.kapowtech.robosuite.api.java.rql.Request
-
Get the database configurations.
- 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.
- getDependencies() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile
-
- 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.
- getErrorCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.RobotErrorResponse
-
Returns special code to separate robot errors
- 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.
- getExecuteRequests() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ScheduleRequest
-
- 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
-
- getExecutionStatus() - Method in class com.kapowtech.robosuite.api.java.rql.FutureRQLResult
-
Deprecated.
Returns the current execution status of a robot.
- getExpiresIn() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuthTokenData
-
- getExtension() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile
-
- getExtension() - Method in enum com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile.Type
-
- getFileBytes() - Method in class com.kapowtech.robosuite.api.java.repository.construct.ChangeEntry
-
- getFileInventory(String, String, String, RepositoryFile.Type) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
Gets the file and the referenced files from the management console.
- getFileInventory(String, String, String, RepositoryFile.Type) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
Gets the file and the referenced files from the management console.
- getFiles() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder
-
- getFileType() - Method in class com.kapowtech.robosuite.api.java.repository.construct.ChangeEntry
-
- getFileType(String) - Static method in enum com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile.Type
-
- getFileType() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsSync
-
- getFolder() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile
-
- getFolderInventory(String, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
Retrieves the folders and files of the sub folder in the specified project from the repository.
- getFolderInventory(String, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
Retrieves the folders and files of the sub folder in the specified project from the repository.
- getHeader(HttpMessage, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl
-
- 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.
- getId() - Method in class com.kapowtech.robosuite.api.java.repository.construct.OAuthUserEntry
-
get the id of the OAuth User Entry
- getIdentifier() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Resource
-
- getInfo() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
Get information about the Management Console and the Repository API.
- getInfo() - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl
-
- 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.AbstractRequest
-
Returns the currently configured input objects, as a list of RQLObjects.
- 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.
- getKcuPoints() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
-
- 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
-
- getKeystore() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ClientCertificate
-
- getLastModified() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile
-
- 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
- getLastModifiedBy() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile
-
- 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.
- getLicenseLimit() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
-
- 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.
- getModifiedBy() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot
-
Gets the ID of the user who modified the robot most recently.
- 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.OAuthUserEntry
-
Gets the name of the OAuth User Entry
- 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.RepositoryFile
-
- getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder
-
Get the repository folder name.
- getName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.Robot
-
Gets the name of the robot
- getName() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.oauth2.NamedAuthSchemeProvider
-
- getName() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2ServiceSchemeProvider
-
- getName() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2UserSchemeProvider
-
- 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.Resource
-
- 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.
- getOAuth2CredentialsTokenClient() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.ServiceOAuth2AuthenticationProvider
-
- getOAuthJSON() - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
-
Get the oauth information as JSON.
- getOAuthUserEntriesInProject(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
Retrieves the OAuth User Entries in a given project.
- getOAuthUserEntriesInProject(String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
Retrieves all the OAuth User Entries for the given project id.
- 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
-
- getObjectsByName(String) - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
-
- getObjectsBySignature(List) - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
-
- 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.
- getParameter(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.AbstractBearerAuthScheme
-
- getParent() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder
-
- getPassword() - Method in class com.kapowtech.robosuite.api.java.repository.engine.CredentialsAuthenticationProvider
-
- 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.engine.remote.multiplexing.ClientCertificate
-
- 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.repository.construct.ChangeEntry
-
- getPath() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder
-
- getPath() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- 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.
- getPollingIntervalMillis() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest
-
The current set polling interval.
- 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.
- getPortId() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
-
- getPriority() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest
-
The current set priority.
- getProject() - Method in class com.kapowtech.robosuite.api.java.rql.AbstractRequest
-
Get the project for this request
- getProject() - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
-
Deprecated.
Get the project for this request
- getProjectInventory(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
Retrieves the folders and files of the entire project from the repository.
- getProjectInventory(String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
Retrieves the folders and files of the entire project from the repository.
- getProjectName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile
-
- getProjectName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder
-
- getProjectName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsChangeData
-
- getProjectName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- getProjectName() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsProjectConfiguration
-
- getProjectName() - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag.Data
-
- 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
-
Retrieves the projects available in the repository.
- getProjects() - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
Retrieves the projects available in the repository.
- getProjectsByUser(String, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
Retrieves the projects available for the current user in the repository.
- getProjectsByUser(String, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
Retrieves the projects available for the current user 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
- getProxyServerConfiguration() - Method in class com.kapowtech.robosuite.api.java.repository.engine.AuthenticationProvider
-
- 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.
- getReadOnly() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsProjectConfiguration
-
- getRealm() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.AbstractBearerAuthScheme
-
- getRedirectUrl() - Method in enum com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2Client
-
- getReferences() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder
-
- getReferrerURL() - Method in class com.kapowtech.robosuite.api.java.rql.construct.Session
-
Returns the current referrer URL.
- getRefreshToken() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuthTokenData
-
- getRepositoryHttpClientProvider() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.ServiceOAuth2AuthenticationProvider
-
- getRepositoryURL() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2ServiceHttpClientProvider
-
- getRepositoryURL() - Method in interface com.kapowtech.robosuite.api.java.rql.construct.RepositoryHttpClientProvider
-
- 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.
- getResourceEnvironment() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ExecuteRequest
-
Returns the reservable resource environment, or null if none.
- getResources() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ResourceEnvironment
-
- getResources() - Method in class com.kapowtech.robosuite.api.java.rql.Request
-
Get the reservable resource configurations.
- 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.
- getRevision() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFields
-
- getRevision() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- getRoboServerClusters() - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
Get a list of the clusters and online RoboServers that are registered with the Management
Console running the repository
- getRoboServerClusters(boolean) - 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 online RoboServers that are registered with the Management
Console running the repository
- getRoboServerClusters(boolean) - 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
-
- 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.
- getRobotsByTag(String, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
- GetRobotsByTag - Class in com.kapowtech.robosuite.api.java.repository.engine.messages
-
< get-robots-by-tag > request
- GetRobotsByTag() - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag
-
- getRobotsByTag(String, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
A request for robots with a specified tag.
- GetRobotsByTag.Data - Class in com.kapowtech.robosuite.api.java.repository.engine.messages
-
- 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.AbstractRequest
-
Returns the currently configured robotURL property.
- 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.
- 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
- getScheduleId() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ScheduleRequest
-
- getSchemeName() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.AbstractBearerAuthScheme
-
- 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
- getServerTime() - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.McVcsConfiguration
-
- getServerTrustMaterial() - Method in class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
-
Get the configured ServerCertificates
- getServletContext() - Method in class com.kapowtech.robosuite.api.java.rql.engine.deploy.ServletDeploymentDescriptorProvider
-
Returns the servlet context object used to access the resource.
- getSettingsId() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
-
- getSettingsSerializationVersion() - Method in class com.kapowtech.robosuite.api.java.rql.construct.PingResponse
-
Must match the version in RoboServerSettings::getSerializationVersion
This method was initially introduced to solve problem of older versions of
RoboServer not understanding new field added to later versions of RoboServerSettings class
RoboServer notifies in its PingResponse what version number it expects and
it is responsibility to MC to drop fields added after notified version.
- 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.
- getSlimProjectInventory(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
Retrieves the folders and files of the entire project from the repository, but does not
resolve dependencies between objects.
- 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.
- getState() - Method in class com.kapowtech.robosuite.api.java.rql.RQLResult
-
Returns a string representation of the status of the execution.
- 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.
- getSubFolders() - Method in class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder
-
- getSyncs() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsProjectConfiguration
-
- getSyncTime() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsChangeData
-
- getTag() - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag.Data
-
- getThreadDump() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ThreadDumpResponse
-
- getTimeout() - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest
-
Gets the current timeout.
- 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.
- getTimoutPropertyOrDefault() - Static method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl
-
- getTokenType() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuthTokenData
-
- 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.repository.construct.RepositoryFile
-
- getType() - Method in enum com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile.Type
-
- getType() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- 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.
- getType() - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
-
The type of RQL object (currently BASIC or OAUTH)
- 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
- getUrl() - Method in class com.kapowtech.robosuite.api.java.repository.engine.AuthenticationProvider
-
- getUsername() - Method in class com.kapowtech.robosuite.api.java.repository.engine.CredentialsAuthenticationProvider
-
- 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
- getUserToken() - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.UserOAuth2AuthenticationProvider
-
Returns currently used OAuth token for Authorization Credentials Grant flow.
Access or even refresh token may be expired as they are refreshed on demand during requests
to Management Console with
RepositoryClientImpl.
If access token is not present or known to be expired will try to update it and if fails
empty access token is returned.
- 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.
- getVcsFields() - Method in class com.kapowtech.robosuite.api.java.repository.construct.ChangeEntry
-
- GetVcsFilesRequest - Class in com.kapowtech.robosuite.api.java.repository.engine.messages
-
<get-vcs-files> request.
- GetVcsFilesRequest() - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.messages.GetVcsFilesRequest
-
- getVcsProjectConfigurations() - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.McVcsConfiguration
-
- getVcsUrl() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsProjectConfiguration
-
- 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.
- GRANT_TYPE - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2AuthenticationProvider
-
- 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.ChangeEntry
-
- 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.repository.construct.VcsChangeData
-
- hashCode() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFields
-
- hashCode() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsProjectConfiguration
-
- hashCode() - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsSync
-
- 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.Database
-
- hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.DatabaseEnvironment
-
- 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.Resource
-
- hashCode() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ResourceEnvironment
-
- 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.ScheduleRequest
-
- 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.ServerCertificates
-
- 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.
- host - Variable in class com.kapowtech.robosuite.api.java.rql.construct.Database
-
- 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
-
- 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<RQLEngine>) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.dist.RandomDistributionPolicy
-
Constructor.
- read(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag
-
- read(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetVcsFilesRequest
-
- read(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.McVcsConfigurationResponseMessage
-
- read(Document) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.messages.Message
-
reads xml document and returns java object with its data
- read(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.OAuthUserEntryListResponse
-
- read(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.ResetVcsSyncRequest
-
- read(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.RobotListResponse
-
- read(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.UpdateSuccessful
-
- read(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.VcsChanges
-
- read(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.VcsConfigurationRequest
-
- 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.
- REDIRECT_URL - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2AuthenticationProvider
-
- REFIND_KEY - Static variable in class com.kapowtech.robosuite.api.java.repository.construct.AttributeType
-
The attribute type Refind Key
used in Design Studio types
- REFRESH_TOKEN - Static variable in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2AuthenticationProvider
-
- 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.
- registerClusterNoBlock(RepositoryClient, String, ExecutorLogger) - Static method in class com.kapowtech.robosuite.api.java.rql.Request
-
Register a cluster defined in the Management Console repository.
- registerUserToken(String, OAuthTokenData) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2RefreshTokenClient
-
- registerUserToken(OAuthTokenData) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.UserOAuth2AuthenticationProvider
-
When access token expires or is invalidated it is automatically refreshed during requests to Management Console
with
RepositoryClientImpl.
- 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.
- remove(int) - Method in class com.kapowtech.robosuite.api.java.rql.construct.Environments
-
- removeRoboServer(RoboServer) - Method in class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
-
Removes a RoboServer from the RequestExecutor.
- renameRobot(RepositoryFile, String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
Rename a robot file.
- renameRobot(RepositoryFile, String, AdditionalInfo) - Method in class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient
-
- renameRobot(RepositoryFile, String) - Method in interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient
-
Rename a robot file.
- 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,
- RepositoryClientImpl - Class in com.kapowtech.robosuite.api.java.repository.engine
-
The actual client implementation.
- RepositoryClientImpl(String, String, String, ProxyServerConfiguration) - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl
-
- RepositoryClientImpl(AuthenticationProvider) - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl
-
- RepositoryConnectionException - Exception in com.kapowtech.robosuite.api.java.repository.engine
-
- RepositoryConnectionException(String) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.RepositoryConnectionException
-
- RepositoryConnectionException(Exception) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.RepositoryConnectionException
-
- RepositoryConnectionException(String, Throwable) - Constructor for exception com.kapowtech.robosuite.api.java.repository.engine.RepositoryConnectionException
-
- RepositoryFile - Class in com.kapowtech.robosuite.api.java.repository.construct
-
A repository file object, contains information about the folder items received from the repository.
- RepositoryFile(String, RepositoryFolder, String, RepositoryFile.Type, Date, String, String, Collection<RepositoryFile>) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFile
-
- RepositoryFile.Type - Enum in com.kapowtech.robosuite.api.java.repository.construct
-
- RepositoryFolder - Class in com.kapowtech.robosuite.api.java.repository.construct
-
A repository folder object, contains information about the folders from the repository
- RepositoryFolder(String, RepositoryFolder, String) - Constructor for class com.kapowtech.robosuite.api.java.repository.construct.RepositoryFolder
-
- RepositoryHttpClientProvider - Interface in com.kapowtech.robosuite.api.java.rql.construct
-
Provides functionality to supply custom HttpClient creation logic
- 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<T> - Interface in com.kapowtech.robosuite.api.java.repository.engine.messages
-
Request message.
- request() - Static method in class com.kapowtech.robosuite.api.java.repository.engine.messages.VcsChanges
-
- request(Consumer<HttpPost>) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2AbstractProtocolClient
-
- 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 or management consoles 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 RequestExecutor from a static Cluster (you may add/remove servers programmatically later).
- RequestExecutor(Cluster, ExecutorLogger) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
-
Create a RequestExecutor from a static Cluster (you may add/remove servers programmatically later).
- RequestExecutor(Cluster, ExecutorLogger, RQLEngineFactory) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
-
Create a RequestExecutor from a static Cluster (you may add/remove servers programmatically later).
- RequestExecutor(RepositoryClient, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
-
Create a RequestExecutor 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 RequestExecutor 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 RequestExecutor 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 RequestExecutor from a cluster loaded through the repository API.
- RequestExecutor(RepositoryClient, String, long, RQLEngineFactory, ExecutorLogger, boolean) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.hotstandby.RequestExecutor
-
Create a RequestExecutor 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
- ResetVcsSyncRequest - Class in com.kapowtech.robosuite.api.java.repository.engine.messages
-
<reset-vcs-sync> message
- ResetVcsSyncRequest() - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.messages.ResetVcsSyncRequest
-
- Resource - Class in com.kapowtech.robosuite.api.java.rql.construct
-
Information for the direct acquisition of the reservable resource
- Resource(String, String, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Resource
-
- 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.
- ResourceEnvironment - Class in com.kapowtech.robosuite.api.java.rql.construct
-
A reservable resource environment provides information needed to directly acquire resources
- ResourceEnvironment() - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ResourceEnvironment
-
- ResourceEnvironment(List<Resource>) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ResourceEnvironment
-
- ResourceProvider - Interface in com.kapowtech.robosuite.api.java.rql.engine.deploy
-
Provides access to named resources in a given context.
- Response<T> - Interface in com.kapowtech.robosuite.api.java.repository.engine.messages
-
Response message
- response() - Static method in class com.kapowtech.robosuite.api.java.repository.engine.messages.VcsChanges
-
- 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
-
- Robot - Class in com.kapowtech.robosuite.api.java.repository.construct
-
A robot object, describes a robot in the Robot repository.
- Robot(String, String, Date, String, String) - 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, 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<RQLResponse>) - 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
-
- 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<RQLResponse>) - 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.
- RobotListResponse - Class in com.kapowtech.robosuite.api.java.repository.engine.messages
-
- RobotListResponse() - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.messages.RobotListResponse
-
- 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
-
- 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 a 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<RQLResponse>) - 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<RQLEngine>) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.dist.RoundRobinDistributionPolicy
-
Constructor.
- RoundRobinDistributionPolicy(List<RQLEngine>, 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<RQLResponse>) - 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<RQLResponse>) - 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<Attribute>) - 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<String>, List<Object>) - 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<RQLObject>) - 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<RQLResponse>) - 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<RQLResponse>) - 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<RQLResponse>) - 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<RQLResponse>) - Constructor for class com.kapowtech.robosuite.api.java.rql.RQLResult
-
Creates a new RQLResult object based on the result of processing an
RQLRequest.
- RQLResult(RQLRequest, List<RQLResponse>, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.RQLResult
-
Creates a new RQLResult object based on the result of processing an
RQLRequest, includes the resulting state.
- 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.
- ScheduleRequest - Class in com.kapowtech.robosuite.api.java.rql.construct
-
- ScheduleRequest(List<ExecuteRequest>, String) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.ScheduleRequest
-
- schema - Variable in class com.kapowtech.robosuite.api.java.rql.construct.Database
-
- 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.
- sendXML(Document) - Method in class com.kapowtech.robosuite.api.java.repository.engine.RepositoryClientImpl
-
Sends the XML document to the repository.
- ServerCertificates - Class in com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing
-
This class allows you to conveniently load the trusted certificate(s) for the servers you want to connect to.
- ServerCertificates(byte[]) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerCertificates
-
Creates ServerTrustMaterial based on certificate bytes and the password of the certificate
- ServerCertificates(File) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.ServerCertificates
-
Creates ServerTrustMaterial based on a server certificate file and the password of the certificate
- 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<RQLResponse>) - 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<RQLResponse>) - 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.
- ServiceBearerAuthScheme - Class in com.kapowtech.robosuite.api.java.repository.engine.oauth2
-
AuthScheme implementation for client credentials grant
- ServiceBearerAuthScheme(OAuth2CredentialsTokenClient) - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.oauth2.ServiceBearerAuthScheme
-
- ServiceOAuth2AuthenticationProvider - Class in com.kapowtech.robosuite.api.java.repository.engine.oauth2
-
Provider used when OAuth2 Client Credentials Grant should be used as authentication method.
- ServiceOAuth2AuthenticationProvider(String, OAuth2Client, Supplier<String>, ProxyServerConfiguration, Duration, Duration) - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.oauth2.ServiceOAuth2AuthenticationProvider
-
- ServiceOAuth2AuthenticationProvider(String, OAuth2Client, Supplier<String>, ProxyServerConfiguration) - Constructor for class com.kapowtech.robosuite.api.java.repository.engine.oauth2.ServiceOAuth2AuthenticationProvider
-
- 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<Cookie>, Binary, Date) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Session
-
Creates a new robot session.
- Session(String, String, List<Cookie>, Binary, Date) - Constructor for class com.kapowtech.robosuite.api.java.rql.construct.Session
-
Creates a new robot session.
- Session(List<Cookie>) - 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.
- setAccessToken(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuthTokenData
-
- 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<String, Attribute>) - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
-
Sets several attributes, initialized from the names and
values of a java.util.Map.
- setAuthor(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFields
-
- setAuthor(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- setAuthorEmail(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFields
-
- setChangeEntries(List<ChangeEntry>) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsChangeData
-
- setChangeType(ChangeType) - Method in class com.kapowtech.robosuite.api.java.repository.construct.ChangeEntry
-
- setChecksum(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- setComment(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.AdditionalInfo
-
- setComment(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFields
-
- setComment(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- setCommitId(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsChangeData
-
- setContent(byte[]) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- 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.construct.ExecuteRequest
-
- 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.
- setExpiresIn(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuthTokenData
-
- setFileBytes(byte[]) - Method in class com.kapowtech.robosuite.api.java.repository.construct.ChangeEntry
-
- setFileType(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.ChangeEntry
-
- 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
- setPath(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.ChangeEntry
-
- setPath(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- setPollingIntervalMillis(int) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest
-
Updates to the robot execution status as well as obtaining return values and API exception errors are updated by
polling.
- setPriority(QueuedRequest.Priority) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest
-
Sets the priority of the queued task as long as it is in the Management Console queue.
- setProject(String) - Method in class com.kapowtech.robosuite.api.java.rql.AbstractRequest
-
Set the project name that this request.
- setProject(String) - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
-
Deprecated.
Set the project name that this request.
- setProjectName(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsChangeData
-
- setProjectName(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- setProjectName(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag.Data
-
- setReadOnly(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsProjectConfiguration
-
- setRefreshToken(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuthTokenData
-
- setRevision(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFields
-
- setRevision(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- 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.AbstractRequest
-
Returns the currently configured robotURL property.
- setRobotURL(String) - Method in class com.kapowtech.robosuite.api.java.rql.ExecuteRequestBuilder
-
Deprecated.
Returns the currently configured robotURL
property.
- setServerTime(long) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.McVcsConfiguration
-
- 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.rest.QueuedRequest
-
- setStopRobotOnApiException(boolean) - Method in class com.kapowtech.robosuite.api.java.rql.AbstractRequest
-
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.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
- setSyncTime(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsChangeData
-
- setTag(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.GetRobotsByTag.Data
-
- setTimeout(long) - Method in class com.kapowtech.robosuite.api.java.rest.QueuedRequest
-
Sets the timeout for how long the robot will stay in the queue before it gets allotted a RoboServer to run on.
- 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.
- setTokenType(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuthTokenData
-
- setType(String) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- setType(RepositoryFile.Type) - Method in class com.kapowtech.robosuite.api.java.repository.construct.VcsFile
-
- 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.
- setVcsFields(VcsFields) - Method in class com.kapowtech.robosuite.api.java.repository.construct.ChangeEntry
-
- setVcsProjectConfigurations(List<VcsProjectConfiguration>) - Method in class com.kapowtech.robosuite.api.java.repository.engine.messages.McVcsConfiguration
-
- 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 RequestExecutor.
- 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
-
- 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
-
- 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
-
Configuration of SSL connection to the RoboServer(s).
- SSLConfiguration(boolean) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
-
Constructs an SSL configuration with no client certificate what will either trust all servers or
verify the servers certificate (using root CA certificates provided with the JVM).
- SSLConfiguration(ClientCertificate, boolean) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
-
Constructs an SSL configuration where the given client certificate is used for authentication, and the servers
certificate is either trusted or verified (using root CA certificates provided with the JVM).
- SSLConfiguration(ClientCertificate, ServerCertificates) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
-
Constructs an SSL configuration where the given client certificate is used for authentication of the client, and
the given server certificates is used to validate the server.
- SSLConfiguration(ServerCertificates) - Constructor for class com.kapowtech.robosuite.api.java.rql.engine.remote.multiplexing.SSLConfiguration
-
Constructs an SSL configuration where the given server certificates are used to validate the server.
- 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.
- testClientSecret(String) - Method in class com.kapowtech.robosuite.api.java.repository.engine.oauth2.OAuth2AuthenticationProvider
-
Tests if provided client secret is correct
- 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.
- toJSON() - Method in class com.kapowtech.robosuite.api.java.rql.RQLObjectBuilder
-
Translates this RQL object builder into JSON that can be used for calls to the tasks API on the Management Console
- 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.OAuthUserEntry
-
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.DatabaseEnvironment
-
- 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.Resource
-
- toString() - Method in class com.kapowtech.robosuite.api.java.rql.construct.ResourceEnvironment
-
- 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
-
- 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 to authenticate.
- 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.
- type - Variable in class com.kapowtech.robosuite.api.java.rql.construct.Database
-