Index (etf-client 1.7.6 API)

A B C D E F G H I L M N O P R S T U V W
All Classes All Packages

A

AdHocTestObject - Interface in de.interactive_instruments.etf.client: A temporary Test Object that is used in one Test Run.
AdHocTestObjectFactory - Interface in de.interactive_instruments.etf.client: Factory for creating AdHoc Test Objects
authenticator(Authenticator) - Method in interface de.interactive_instruments.etf.client.EtfValidatorClient: Set the authenticator for the ETF validator
available() - Method in interface de.interactive_instruments.etf.client.EtfEndpoint: Returns true if the endpoint is reachable.

B

baseType() - Method in interface de.interactive_instruments.etf.client.TestObject

C

cancel() - Method in interface de.interactive_instruments.etf.client.TestRun: Cancels the Test Run on the remote instance Please note: if the Test Run has already finished, this will delete the Test Report from the remote instance.
close() - Method in interface de.interactive_instruments.etf.client.EtfEndpoint: Explicitly releases internal resources.
close() - Method in interface de.interactive_instruments.etf.client.TestRunCloseable: Cancels the Test Run on the remote instance Please note: if the Test Run has already finished, this will delete the Test Report from the remote instance! Using it in a try-with-resources statement only makes sense if the test results are retrieved and processed within the statement.
cpuLoad() - Method in interface de.interactive_instruments.etf.client.EtfStatus: Get cpu load as a double in the [0.0,1.0] interval.
create() - Static method in interface de.interactive_instruments.etf.client.EtfValidatorClient: Create a new builder object for the Endpoint configuration
create(String, String) - Static method in interface de.interactive_instruments.etf.client.HttpBasicAuthentication: Create a new HTTP Basic Authenticator

D

DATA_SET - de.interactive_instruments.etf.client.TestObjectBaseType: One or multiple files containing spatial data
de.interactive_instruments.etf.client - package de.interactive_instruments.etf.client: ETF Client API to start and control tests and retrieve results.
delete() - Method in interface de.interactive_instruments.etf.client.TestRunResult: Delete the report from the remote ETF instance.
description() - Method in interface de.interactive_instruments.etf.client.ItemMetadata: Description of an item
description() - Method in interface de.interactive_instruments.etf.client.TestResult: Description of the associated Test in the ETS
diskUsage() - Method in interface de.interactive_instruments.etf.client.EtfStatus: Get disk usage as a double in the [0.0,1.0] interval.
duration() - Method in interface de.interactive_instruments.etf.client.TestResult: The duration of this test in milliseconds
duration() - Method in interface de.interactive_instruments.etf.client.TestRunResult: The duration of this test in milliseconds

E

eid() - Method in interface de.interactive_instruments.etf.client.ItemMetadata: EID of an item
eid() - Method in interface de.interactive_instruments.etf.client.TestObject: EID of an item
EtfClientException - Interface in de.interactive_instruments.etf.client: Marker interface for Exceptions from the ETF Client
EtfCollection<V> - Interface in de.interactive_instruments.etf.client: Represents an ETF response with a collection of items.
EtfEndpoint - Interface in de.interactive_instruments.etf.client: An interface to communicate with a remote ETF instance.
EtfIllegalArgumentException - Exception in de.interactive_instruments.etf.client
EtfIllegalArgumentException(String) - Constructor for exception de.interactive_instruments.etf.client.EtfIllegalArgumentException
EtfIllegalArgumentException(String, Throwable) - Constructor for exception de.interactive_instruments.etf.client.EtfIllegalArgumentException
EtfIllegalStateException - Exception in de.interactive_instruments.etf.client
EtfIllegalStateException(String) - Constructor for exception de.interactive_instruments.etf.client.EtfIllegalStateException
EtfIllegalStateException(String, Throwable) - Constructor for exception de.interactive_instruments.etf.client.EtfIllegalStateException
EtfStatus - Interface in de.interactive_instruments.etf.client: Interface for accessing the service status of the connected instance.
EtfValidatorClient - Interface in de.interactive_instruments.etf.client: EtfValidatorClient is used to initialize a connection to an ETF instance and to create EtfEndpoint objects.
EtfValidatorClientWithExecutorService - Interface in de.interactive_instruments.etf.client
EtsCollection - Interface in de.interactive_instruments.etf.client: Represents an ETF response with a collection of Executable Test Suites.
exceptionOccurred(Exception) - Method in interface de.interactive_instruments.etf.client.TestRunObserver
ExecutableTestSuite - Interface in de.interactive_instruments.etf.client: Executable Test Suite objects are used to start a new test run with a specific test object.
executableTestSuiteEid() - Method in interface de.interactive_instruments.etf.client.TestTaskResult: The ID of the Executable Test Suite that generated this result.
executableTestSuiteEids() - Method in interface de.interactive_instruments.etf.client.TestRunTemplate: The Ids of the Executable TestSuites that are used by this Test Run Template
executableTestSuites() - Method in interface de.interactive_instruments.etf.client.EtfEndpoint: Get a collection of Executable Test Suites that are installed on the remote instance.
execute(TestObject) - Method in interface de.interactive_instruments.etf.client.TestRunExecutable: Deprecated.
execute(TestObject, RunParameters) - Method in interface de.interactive_instruments.etf.client.TestRunExecutable: Start a new Test Run.
execute(TestObject, TestRunObserver) - Method in interface de.interactive_instruments.etf.client.TestRunExecutable: Deprecated.
execute(TestObject, TestRunObserver, RunParameters) - Method in interface de.interactive_instruments.etf.client.TestRunExecutable: Start a new Test Run.
executorService(ExecutorService) - Method in interface de.interactive_instruments.etf.client.EtfValidatorClientWithExecutorService

F

FAILED - de.interactive_instruments.etf.client.ResultStatus: FAILED, if at least one status value is FAILED ordinal: 1
FeatureNotSupportedException - Exception in de.interactive_instruments.etf.client: Thrown if the feature is not supported by the remote instance.
FeatureNotSupportedException(String, String) - Constructor for exception de.interactive_instruments.etf.client.FeatureNotSupportedException
finished() - Method in interface de.interactive_instruments.etf.client.TestRun: Returns true if the Test Run has finished.
floatFormat(DecimalFormat) - Method in interface de.interactive_instruments.etf.client.EtfValidatorClient: Set the formatting of floating point numbers that occur in messages.
fromDataSet(URL) - Method in interface de.interactive_instruments.etf.client.AdHocTestObjectFactory: Create a temporary Test Object for a Data Set that is represented by a remote URL.
fromDataSet(URL, Authenticator) - Method in interface de.interactive_instruments.etf.client.AdHocTestObjectFactory: Create a temporary Test Object for a Data Set that is represented by a remote URL.
fromDataSet(Path) - Method in interface de.interactive_instruments.etf.client.AdHocTestObjectFactory: Create a temporary Test Object for a Data Set that is represented by a (local) path.
fromService(URL) - Method in interface de.interactive_instruments.etf.client.AdHocTestObjectFactory: Create a temporary Test Object for a Service
fromService(URL, Authenticator) - Method in interface de.interactive_instruments.etf.client.AdHocTestObjectFactory: Create a temporary Test Object for a Service
fromString(String) - Static method in enum de.interactive_instruments.etf.client.ResultStatus

G

getAttachment() - Method in interface de.interactive_instruments.etf.client.TestStepResult: Additional information that are attached to this result.

H

HttpBasicAuthentication - Interface in de.interactive_instruments.etf.client: Simple Http Basic Authentication

I

IncompatibleTestObjectTypesException - Exception in de.interactive_instruments.etf.client: Thrown when the type of the Test Object and the supported Type of the Executable Test Suite are not compatible.
IncompatibleTestObjectTypesException() - Constructor for exception de.interactive_instruments.etf.client.IncompatibleTestObjectTypesException
INFO - de.interactive_instruments.etf.client.ResultStatus: INFO, if at least one status value is INFO ordinal: 4
init() - Method in interface de.interactive_instruments.etf.client.EtfValidatorClient: Finalize the Configuration and return an Endpoint object
INTERNAL_ERROR - de.interactive_instruments.etf.client.ResultStatus: INTERNAL_ERROR, if at least one status value is INTERNAL_ERROR in the case the test engine throws an unexpected error that forces the test run to stop ordinal: 8
internalErrors() - Method in interface de.interactive_instruments.etf.client.TestTaskResult: If internal errors occurred, a container is returned with the error messages, otherwise the container is empty.
itemById(String) - Method in interface de.interactive_instruments.etf.client.EtfCollection: Get an item by its eid
itemByLabel(String) - Method in interface de.interactive_instruments.etf.client.EtfCollection: Get an item by its label
ItemMetadata - Interface in de.interactive_instruments.etf.client: Basic Metadata of an item
itemsById(String...) - Method in interface de.interactive_instruments.etf.client.EtsCollection: Filter multiple Executable Test Suites by their ID
itemsById(Collection<String>) - Method in interface de.interactive_instruments.etf.client.EtsCollection: Filter multiple Executable Test Suites by their ID
itemsByTag(Tag) - Method in interface de.interactive_instruments.etf.client.EtsCollection: Filter by a specific Tag
iterator() - Method in interface de.interactive_instruments.etf.client.TestAssertionResult: Returns an iterator that has no elements.

L

label() - Method in interface de.interactive_instruments.etf.client.ItemMetadata: Label of an item
label() - Method in interface de.interactive_instruments.etf.client.TestResult: Label of the associated Test in the ETS
labelSuffix(String) - Method in interface de.interactive_instruments.etf.client.RunParameters: The client creates its own label for the test run, which is composed of the prefix etf-client, a session ID and a counter for the test runs.
locale(Locale) - Method in interface de.interactive_instruments.etf.client.EtfValidatorClient: Set the locale so that the messages from the tests are translated into the desired language.
logEntries() - Method in interface de.interactive_instruments.etf.client.TestRun: The non-blocking call returns the current entries of the log file
logEntries() - Method in interface de.interactive_instruments.etf.client.TestRunResult: Get the log entries that were logged during the Test Run

M

map() - Method in interface de.interactive_instruments.etf.client.RunParameters: Return the parameters as Map
memoryUsage() - Method in interface de.interactive_instruments.etf.client.EtfStatus: Get memory usage as a double in the [0.0,1.0] interval.
messages() - Method in interface de.interactive_instruments.etf.client.TestResultMessageHolder: Return the messages that occurred during the execution of this item.
metadata() - Method in interface de.interactive_instruments.etf.client.EtfCollection: Returns the metadata of the items in the collection

N

name() - Method in interface de.interactive_instruments.etf.client.EtfStatus: The name of the used instance
newAdHocTestObject() - Method in interface de.interactive_instruments.etf.client.EtfEndpoint: Return a factory for creating AdHoc Test Objects
NOT_APPLICABLE - de.interactive_instruments.etf.client.ResultStatus: NOT_APPLICABLE if at least one status value is NOT_APPLICABLE, in the case the test object does not provide the capabilities for executing the test ordinal: 3

O

OTHER - de.interactive_instruments.etf.client.ResultStatus: Check if the ETF version is newer than the version supported by this library.

P

parameters() - Method in interface de.interactive_instruments.etf.client.TestRunExecutable: Get applicable Run Parameters
PASSED - de.interactive_instruments.etf.client.ResultStatus: PASSED, if all status values are PASSED ordinal: 0
PASSED_MANUAL - de.interactive_instruments.etf.client.ResultStatus: PASSED_MANUAL, if at least one status value is PASSED_MANUAL (if the test is not automated and the user has to validate results manually based on instructions in the report) and all others are values are PASSED ordinal: 7
priority() - Method in interface de.interactive_instruments.etf.client.Tag: Non negative integer
progress() - Method in interface de.interactive_instruments.etf.client.TestRun: Returns the progress as double in the in the [0.0,1.0] interval.

R

ReferenceError - Exception in de.interactive_instruments.etf.client: Thrown if an item could not be resolved.
ReferenceError(String) - Constructor for exception de.interactive_instruments.etf.client.ReferenceError
RemoteInvocationException - Exception in de.interactive_instruments.etf.client: An error returned by the ETF instance
RemoteInvocationException(IOException) - Constructor for exception de.interactive_instruments.etf.client.RemoteInvocationException
RemoteInvocationException(InterruptedException) - Constructor for exception de.interactive_instruments.etf.client.RemoteInvocationException
RemoteInvocationException(HttpResponse) - Constructor for exception de.interactive_instruments.etf.client.RemoteInvocationException
RemoteInvocationException(JSONException, HttpResponse) - Constructor for exception de.interactive_instruments.etf.client.RemoteInvocationException
remoteRef() - Method in interface de.interactive_instruments.etf.client.TestRun: A reference to the test run on the remote ETF instance.
required() - Method in interface de.interactive_instruments.etf.client.RunParameters: The names of the parameters that the client must set
responseBody() - Method in exception de.interactive_instruments.etf.client.RemoteInvocationException
result() - Method in interface de.interactive_instruments.etf.client.TestRun: The blocking call waits until the Test Run has finished and finally returns a Test Run Result.
resultStatus() - Method in interface de.interactive_instruments.etf.client.TestResult: The status that has been aggregated from the child tests items
ResultStatus - Enum in de.interactive_instruments.etf.client: Status of ETF items that represent test results.
RunParameters - Interface in de.interactive_instruments.etf.client: Parameters for a Test Run

S

SERVICE - de.interactive_instruments.etf.client.TestObjectBaseType: A service with a web interface
sessionId() - Method in interface de.interactive_instruments.etf.client.EtfEndpoint: Get the currently used session ID.
setFrom(String...) - Method in interface de.interactive_instruments.etf.client.RunParameters: Set the actual Parameters from a String array.
setFrom(Collection<String>) - Method in interface de.interactive_instruments.etf.client.RunParameters: Set the actual Parameters from a String collection.
setFrom(Map<String, String>) - Method in interface de.interactive_instruments.etf.client.RunParameters: Set the actual Parameters from a String Map.
size() - Method in interface de.interactive_instruments.etf.client.EtfCollection: Returns the size of this collection
SKIPPED - de.interactive_instruments.etf.client.ResultStatus: SKIPPED, if at least one status value is SKIPPED because a test case depends on another test case which has the status FAILED or SKIPPED ordinal: 2
startDate() - Method in interface de.interactive_instruments.etf.client.TestResult: The start data
startDate() - Method in interface de.interactive_instruments.etf.client.TestRunResult: The start data
status() - Method in interface de.interactive_instruments.etf.client.EtfEndpoint: Get information about workload and health information.
status() - Method in interface de.interactive_instruments.etf.client.EtfStatus: Status of the instance.
statusCode() - Method in exception de.interactive_instruments.etf.client.RemoteInvocationException
supportedBaseType() - Method in interface de.interactive_instruments.etf.client.ExecutableTestSuite: The base Test Object Type supported by this ETS
supportedBaseType() - Method in interface de.interactive_instruments.etf.client.TestRunTemplate: The base Test Object Type supported by this Test Run Template

T

Tag - Interface in de.interactive_instruments.etf.client: A Tag can be assigned to an Executable Test Suite and used to filter specific ETS in an ETS collection.
tagEids() - Method in interface de.interactive_instruments.etf.client.ExecutableTestSuite: The Ids of the Tags
tags() - Method in interface de.interactive_instruments.etf.client.EtfEndpoint: Get a collection of Tags that are assigned to the Executable Test Suites
TestAssertionResult - Interface in de.interactive_instruments.etf.client: A Test Assertion Result does not possess any child result elements.
testAssertionResults() - Method in interface de.interactive_instruments.etf.client.TestStepResult: Return assertion results
TestCaseResult - Interface in de.interactive_instruments.etf.client: A Test Case Result is the parent result element of zero or multiple TestStepResults and the child of exactly one TestModuleResult.
testCaseResults() - Method in interface de.interactive_instruments.etf.client.TestModuleResult: Return the Test Case Results
TestModuleResult - Interface in de.interactive_instruments.etf.client: A Test Module Result is the parent result element of zero or multiple TestCaseResults and the child of exactly one TestTaskResult.
testModuleResults() - Method in interface de.interactive_instruments.etf.client.TestTaskResult: Return the Test Module Results
TestObject - Interface in de.interactive_instruments.etf.client: Until now ETF v2.0.x supports only AdHoc Test Objects.
TestObjectBaseType - Enum in de.interactive_instruments.etf.client: Represents the simplified base types of a Test Object
TestResult - Interface in de.interactive_instruments.etf.client: The Test Result of an test item If a Test Result item is used for iteration, the iterator will also traverse the sub results.
TestResultMessageHolder - Interface in de.interactive_instruments.etf.client: An interface for results that posses messages.
TestRun - Interface in de.interactive_instruments.etf.client: The information about a started test run is updated at regular intervals and the state can be queried using the methods of this interface.
TestRunCloseable - Interface in de.interactive_instruments.etf.client: The information about a started test run is updated at regular intervals and the state can be queried using the methods of this interface.
TestRunExecutable - Interface in de.interactive_instruments.etf.client: Represents objects that can execute Test Runs
testRunFinished(TestRunResult) - Method in interface de.interactive_instruments.etf.client.TestRunObserver: Will be called when the test run has been completed
TestRunObserver - Interface in de.interactive_instruments.etf.client: An interface for an Observer who is called when a Test Run is completed.
TestRunParameterException - Exception in de.interactive_instruments.etf.client: Thrown if a parameter-related error has occurred.
TestRunParameterException(String) - Constructor for exception de.interactive_instruments.etf.client.TestRunParameterException
TestRunResult - Interface in de.interactive_instruments.etf.client: A Test Run Result represents the execution of one or multiple ETS against one Test Object.
TestRunTemplate - Interface in de.interactive_instruments.etf.client: Test Run Template bundle multiple Executable Test Suites and are used to start a new test run with a specific test object.
testRunTemplates() - Method in interface de.interactive_instruments.etf.client.EtfEndpoint: Get a collection of Test Run Templates that are installed on the remote instance.
TestStepResult - Interface in de.interactive_instruments.etf.client: A Test Step is the parent result element of zero or multiple TestAssertionResults and the child of exactly one TestCaseResult.
testStepResults() - Method in interface de.interactive_instruments.etf.client.TestCaseResult: Return the Test Case Results
TestTaskResult - Interface in de.interactive_instruments.etf.client: A Test Task Result represents the result of executing exactly one ETS against one Test Object.
testTaskResults() - Method in interface de.interactive_instruments.etf.client.TestRunResult
timeout(Duration) - Method in interface de.interactive_instruments.etf.client.EtfValidatorClient: Overrides the default timeout for requests, which is 3 minutes.
toString() - Method in exception de.interactive_instruments.etf.client.RemoteInvocationException
toString() - Method in enum de.interactive_instruments.etf.client.ResultStatus
type() - Method in interface de.interactive_instruments.etf.client.TestResult: Returns the string representation of this type

U

UNDEFINED - de.interactive_instruments.etf.client.ResultStatus: UNDEFINED, in all other cases ordinal: 6
uptime() - Method in interface de.interactive_instruments.etf.client.EtfStatus: Uptime of the instance in seconds
url(URL) - Method in interface de.interactive_instruments.etf.client.EtfValidatorClient: Set the URL to the validator

V

valueOf(String) - Static method in enum de.interactive_instruments.etf.client.ResultStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.interactive_instruments.etf.client.TestObjectBaseType: Returns the enum constant of this type with the specified name.
values() - Static method in enum de.interactive_instruments.etf.client.ResultStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.interactive_instruments.etf.client.TestObjectBaseType: Returns an array containing the constants of this enum type, in the order they are declared.
version() - Method in interface de.interactive_instruments.etf.client.EtfStatus: Version of the instance
version() - Method in interface de.interactive_instruments.etf.client.ItemMetadata: Version of an item

W

WARNING - de.interactive_instruments.etf.client.ResultStatus: WARNING, if at least one status value is WARNING ordinal: 5

A B C D E F G H I L M N O P R S T U V W
All Classes All Packages