Package de.interactive_instruments.etf.client

Interface EtfEndpoint

All Superinterfaces:

java.lang.AutoCloseable

public interface EtfEndpoint
extends java.lang.AutoCloseable

An interface to communicate with a remote ETF instance. There is no permanent connection to the instance, retrieved information are cached. With each operation on the API it is checked whether information is outdated and if necessary automatically renewed.

Method Summary

Modifier and Type	Method	Description
boolean	available()	Returns true if the endpoint is reachable.
void	close()	Explicitly releases internal resources.
EtsCollection	executableTestSuites()	Get a collection of Executable Test Suites that are installed on the remote instance.
AdHocTestObjectFactory	newAdHocTestObject()	Return a factory for creating AdHoc Test Objects
java.lang.String	sessionId()	Get the currently used session ID.
EtfStatus	status()	Get information about workload and health information.
EtfCollection<Tag>	tags()	Get a collection of Tags that are assigned to the Executable Test Suites
EtfCollection<TestRunTemplate>	testRunTemplates()	Get a collection of Test Run Templates that are installed on the remote instance.

Method Detail

available

boolean available()

Returns true if the endpoint is reachable.

Returns:

true if endpoint reachable, false otherwise

executableTestSuites

EtsCollection executableTestSuites()
                            throws RemoteInvocationException

Get a collection of Executable Test Suites that are installed on the remote instance.

Returns:

collection of Executable Test Suites

Throws:

RemoteInvocationException - if the ETF instance returned an error

tags

EtfCollection<Tag> tags()
                 throws RemoteInvocationException

Get a collection of Tags that are assigned to the Executable Test Suites

Returns:

collection of Tags

Throws:

RemoteInvocationException - if the ETF instance returned an error

testRunTemplates

EtfCollection<TestRunTemplate> testRunTemplates()
                                         throws RemoteInvocationException

Get a collection of Test Run Templates that are installed on the remote instance.

Returns:

collection of Test Run Templates

Throws:

RemoteInvocationException - if the ETF instance returned an error

Since:

1.1

newAdHocTestObject

AdHocTestObjectFactory newAdHocTestObject()

Return a factory for creating AdHoc Test Objects

Returns:

AdHocTestObjectFactory for creating temporary Test Objects

status

EtfStatus status()
          throws RemoteInvocationException

Get information about workload and health information.

Returns:

status object

Throws:

RemoteInvocationException - if the ETF instance returned an error

sessionId

java.lang.String sessionId()

Get the currently used session ID.

Returns:

session UUID as string

close

void close()

Explicitly releases internal resources. Running Tests will be canceled.

Specified by:

close in interface java.lang.AutoCloseable