org.qas.qtest.api.services.design

Class TestDesignServiceAsyncClient

java.lang.Object

org.qas.api.ApiWebServiceClient<T>

org.qas.qtest.api.internal.QTestApiWebServiceClient<TestDesignServiceClient>

org.qas.qtest.api.services.design.TestDesignServiceClient

org.qas.qtest.api.services.design.TestDesignServiceAsyncClient

All Implemented Interfaces:

QTestService, TestDesignService, TestDesignServiceAsync

public class TestDesignServiceAsyncClient
extends TestDesignServiceClient
implements TestDesignServiceAsync

TestDesignServiceAsyncClient

Since:

1.0

Field Summary

Fields inherited from class org.qas.qtest.api.internal.QTestApiWebServiceClient

credentialsProvider, exceptionUnmarshallers, executorService, signer

Fields inherited from class org.qas.api.ApiWebServiceClient

client, configuration, endpoint, requestHandlers, timeOffset

Constructor Summary

Constructors

Constructor and Description
TestDesignServiceAsyncClient() Constructs a new client to invoke service method on TestDesignService using the default qTest credentials provider and default client configuration options.
TestDesignServiceAsyncClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on TestDesignService using the default qTest credentials provider and client configuration options.
TestDesignServiceAsyncClient(ClientConfiguration clientConfiguration, java.util.concurrent.ExecutorService executorService) Constructs a new client to invoke service method on TestDesignService using the default qTest credentials provider and client configuration options.
TestDesignServiceAsyncClient(java.util.concurrent.ExecutorService executorService) Constructs a new client to invoke service method on TestDesignService using the default qTest credentials provider and default client configuration options.
TestDesignServiceAsyncClient(QTestCredentials credentials) Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials.
TestDesignServiceAsyncClient(QTestCredentials credentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials and client configuration options.
TestDesignServiceAsyncClient(QTestCredentials credentials, ClientConfiguration clientConfiguration, java.util.concurrent.ExecutorService executorService) Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials and client configuration options.
TestDesignServiceAsyncClient(QTestCredentials credentials, java.util.concurrent.ExecutorService executorService) Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials.
TestDesignServiceAsyncClient(QTestCredentialsProvider credentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials provider and client configuration options.
TestDesignServiceAsyncClient(QTestCredentialsProvider credentialsProvider, ClientConfiguration clientConfiguration, java.util.concurrent.ExecutorService executorService) Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials provider and client configuration options.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.Future<TestCase>	addCommentAsync(CreateObjectCommentRequest createObjectCommentRequest) Creates testcase comment from the given request.
java.util.concurrent.Future<TestCase>	addCommentAsync(CreateObjectCommentRequest createObjectCommentRequest, AsyncHandler<CreateObjectCommentRequest,TestCase> asyncHandler) Creates testcase comment from the given request.
java.util.concurrent.Future<AutomationTestCase>	createAutomationTestCaseAsync(CreateAutomationTestCaseRequest automationTestCaseRequest) Creates the automation test case from the given create automation test case request
java.util.concurrent.Future<AutomationTestCase>	createAutomationTestCaseAsync(CreateAutomationTestCaseRequest automationTestCaseRequest, AsyncHandler<CreateAutomationTestCaseRequest,AutomationTestCase> asyncHandler) Creates the automation test case from the given create automation test case request
java.util.concurrent.Future<TestCase>	createTestCaseAsync(CreateTestCaseRequest testCaseRequest) Creates the test case from the given create test case request
java.util.concurrent.Future<TestCase>	createTestCaseAsync(CreateTestCaseRequest testCaseRequest, AsyncHandler<CreateTestCaseRequest,TestCase> asyncHandler) Creates the test case from the given create test case request
java.util.concurrent.Future<TestStep>	createTestStepAsync(CreateTestStepRequest testStepRequest) Creates the test step from the given create test step request
java.util.concurrent.Future<TestStep>	createTestStepAsync(CreateTestStepRequest testStepRequest, AsyncHandler<CreateTestStepRequest,TestStep> asyncHandler) Creates the test step from the given create test step request
java.util.concurrent.Future<TestCase>	getTestCaseAsync(GetTestCaseRequest testCaseRequest) Gets TestCase from the given test case request
java.util.concurrent.Future<TestCase>	getTestCaseAsync(GetTestCaseRequest testCaseRequest, AsyncHandler<GetTestCaseRequest,TestCase> asyncHandler) Gets TestCase from the given test case request
java.util.concurrent.Future<java.util.List<Field>>	getTestCaseFieldsAsync(GetTestCaseFieldsRequest getTestCaseFieldsRequest) Gets the test-case custom fields.
java.util.concurrent.Future<java.util.List<Field>>	getTestCaseFieldsAsync(GetTestCaseFieldsRequest getTestCaseFieldsRequest, AsyncHandler<GetTestCaseFieldsRequest,java.util.List<Field>> asyncHandler) Gets the test-case custom fields.
java.util.concurrent.Future<TestStep>	getTestStepAsync(GetTestStepRequest testStepRequest) Gets TestStep from the given test step request
java.util.concurrent.Future<TestStep>	getTestStepAsync(GetTestStepRequest testStepRequest, AsyncHandler<GetTestStepRequest,TestStep> asyncHandler) Gets TestStep from the given test step request
java.util.concurrent.Future<java.util.List<TestCase>>	listTestCaseAsync(ListTestCaseRequest listTestCaseRequest) Lists all test case in the current project.
java.util.concurrent.Future<java.util.List<TestCase>>	listTestCaseAsync(ListTestCaseRequest listTestCaseRequest, AsyncHandler<ListTestCaseRequest,java.util.List<TestCase>> asyncHandler) Lists all test case in the current project.
java.util.concurrent.Future<java.util.List<TestStep>>	listTestStepAsync(ListTestStepRequest testStepRequest) Gets list of TestStep from the given test step request
java.util.concurrent.Future<java.util.List<TestStep>>	listTestStepAsync(ListTestStepRequest testStepRequest, AsyncHandler<ListTestStepRequest,java.util.List<TestStep>> asyncHandler) Gets list of TestStep from the given test step request
void	shutdown() Shutdown this client object, release any resources that might be held open.

Methods inherited from class org.qas.qtest.api.services.design.TestDesignServiceClient

addComment, approveTestCase, createAutomationTestCase, createTestCase, createTestStep, deleteTestCase, getTestCase, getTestCaseFields, getTestStep, listTestCase, listTestStep, moveTestCase, updateTestCase

Methods inherited from class org.qas.qtest.api.internal.QTestApiWebServiceClient

init, invoke, withEndpoint

Methods inherited from class org.qas.api.ApiWebServiceClient

addRequestHandler, createExecutionContext, createHttpAuthClient, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setTimeOffset, withConfiguration, withRequestHandler, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.qas.qtest.api.services.design.TestDesignService

addComment, approveTestCase, createAutomationTestCase, createTestCase, createTestStep, deleteTestCase, getTestCase, getTestCaseFields, getTestStep, listTestCase, listTestStep, moveTestCase, updateTestCase

Methods inherited from interface org.qas.qtest.api.internal.QTestService

setEndpoint

Constructor Detail

TestDesignServiceAsyncClient

public TestDesignServiceAsyncClient()

Constructs a new client to invoke service method on TestDesignService using the default qTest credentials provider and default client configuration options.

TestDesignServiceAsyncClient

public TestDesignServiceAsyncClient(java.util.concurrent.ExecutorService executorService)

Constructs a new client to invoke service method on TestDesignService using the default qTest credentials provider and default client configuration options.

Parameters:

executorService - the executor service for executing asynchronous request.

TestDesignServiceAsyncClient

public TestDesignServiceAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on TestDesignService using the default qTest credentials provider and client configuration options.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to TestDesignService

TestDesignServiceAsyncClient

public TestDesignServiceAsyncClient(ClientConfiguration clientConfiguration,
                                    java.util.concurrent.ExecutorService executorService)

Constructs a new client to invoke service method on TestDesignService using the default qTest credentials provider and client configuration options.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to TestDesignService.

executorService - the executor service for executing asynchronous request.

TestDesignServiceAsyncClient

public TestDesignServiceAsyncClient(QTestCredentials credentials)

Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials.

Parameters:

credentials - The qTest credentials which will provide credentials to authenticate request with qTest services.

TestDesignServiceAsyncClient

public TestDesignServiceAsyncClient(QTestCredentials credentials,
                                    java.util.concurrent.ExecutorService executorService)

Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials.

Parameters:

credentials - The qTest credentials which will provide credentials to authenticate request with qTest services.

executorService - the executor service for executing asynchronous request.

TestDesignServiceAsyncClient

public TestDesignServiceAsyncClient(QTestCredentials credentials,
                                    ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials and client configuration options.

Parameters:

credentials - The qTest credentials which will provide credentials to authenticate request with qTest services.

clientConfiguration - The client configuration options controlling how this client connects to TestDesignService

TestDesignServiceAsyncClient

public TestDesignServiceAsyncClient(QTestCredentials credentials,
                                    ClientConfiguration clientConfiguration,
                                    java.util.concurrent.ExecutorService executorService)

Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials and client configuration options.

Parameters:

credentials - The qTest credentials which will provide credentials to authenticate request with qTest services.

clientConfiguration - The client configuration options controlling how this client connects to TestDesignService

executorService - the executor service for executing asynchronous request.

TestDesignServiceAsyncClient

public TestDesignServiceAsyncClient(QTestCredentialsProvider credentialsProvider,
                                    ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials provider and client configuration options.

Parameters:

credentialsProvider - The qTest credentials provider which will provide credentials to authenticate request with qTest services.

clientConfiguration - The client configuration options controlling how this client connects to TestDesignService

TestDesignServiceAsyncClient

public TestDesignServiceAsyncClient(QTestCredentialsProvider credentialsProvider,
                                    ClientConfiguration clientConfiguration,
                                    java.util.concurrent.ExecutorService executorService)

Constructs a new client to invoke service method on TestDesignService using the specified qTest credentials provider and client configuration options.

Parameters:

credentialsProvider - The qTest credentials provider which will provide credentials to authenticate request with qTest services.

clientConfiguration - The client configuration options controlling how this client connects to TestDesignService

executorService - the executor service for executing asynchronous request.

Method Detail

listTestCaseAsync

public java.util.concurrent.Future<java.util.List<TestCase>> listTestCaseAsync(ListTestCaseRequest listTestCaseRequest)
                                                                        throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Lists all test case in the current project.

Specified by:

listTestCaseAsync in interface TestDesignServiceAsync

Parameters:

listTestCaseRequest - the given list test case request object.

Returns:

the list of test case object.

Throws:

AuthServiceException - if an error occurs during listing all test case objects.

listTestCaseAsync

public java.util.concurrent.Future<java.util.List<TestCase>> listTestCaseAsync(ListTestCaseRequest listTestCaseRequest,
                                                                               AsyncHandler<ListTestCaseRequest,java.util.List<TestCase>> asyncHandler)
                                                                        throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Lists all test case in the current project.

Specified by:

listTestCaseAsync in interface TestDesignServiceAsync

Parameters:

listTestCaseRequest - the given list test case request object.

asyncHandler - callback handler for events in the life-cycle of the request. Users could provide the implementation of the for callback methods in this interface to process the operation result or handle the exception.

Returns:

the list of test case object.

Throws:

AuthServiceException - if an error occurs during listing all test case objects.

getTestCaseAsync

public java.util.concurrent.Future<TestCase> getTestCaseAsync(GetTestCaseRequest testCaseRequest)
                                                       throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Gets TestCase from the given test case request

Specified by:

getTestCaseAsync in interface TestDesignServiceAsync

Parameters:

testCaseRequest - the given test case request

Returns:

the TestCase instance.

Throws:

AuthServiceException - if an error occurs during getting the test case.

getTestCaseAsync

public java.util.concurrent.Future<TestCase> getTestCaseAsync(GetTestCaseRequest testCaseRequest,
                                                              AsyncHandler<GetTestCaseRequest,TestCase> asyncHandler)
                                                       throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Gets TestCase from the given test case request

Specified by:

getTestCaseAsync in interface TestDesignServiceAsync

Parameters:

testCaseRequest - the given test case request

asyncHandler - callback handler for events in the life-cycle of the request. Users could provide the implementation of the for callback methods in this interface to process the operation result or handle the exception.

Returns:

the TestCase instance.

Throws:

AuthServiceException - if an error occurs during getting the test case.

getTestStepAsync

public java.util.concurrent.Future<TestStep> getTestStepAsync(GetTestStepRequest testStepRequest)
                                                       throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Gets TestStep from the given test step request

Specified by:

getTestStepAsync in interface TestDesignServiceAsync

Parameters:

testStepRequest - the given test step request

Returns:

the TestStep instance.

Throws:

AuthServiceException - if an error occurs during getting the test case.

getTestStepAsync

public java.util.concurrent.Future<TestStep> getTestStepAsync(GetTestStepRequest testStepRequest,
                                                              AsyncHandler<GetTestStepRequest,TestStep> asyncHandler)
                                                       throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Gets TestStep from the given test step request

Specified by:

getTestStepAsync in interface TestDesignServiceAsync

Parameters:

testStepRequest - the given test step request

asyncHandler - callback handler for events in the life-cycle of the request. Users could provide the implementation of the for callback methods in this interface to process the operation result or handle the exception.

Returns:

the TestStep instance.

Throws:

AuthServiceException - if an error occurs during getting the test case.

listTestStepAsync

public java.util.concurrent.Future<java.util.List<TestStep>> listTestStepAsync(ListTestStepRequest testStepRequest)
                                                                        throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Gets list of TestStep from the given test step request

Specified by:

listTestStepAsync in interface TestDesignServiceAsync

Parameters:

testStepRequest - the given test step request

Returns:

the list of TestStep instance.

Throws:

AuthServiceException - if an error occurs during getting the test step.

listTestStepAsync

public java.util.concurrent.Future<java.util.List<TestStep>> listTestStepAsync(ListTestStepRequest testStepRequest,
                                                                               AsyncHandler<ListTestStepRequest,java.util.List<TestStep>> asyncHandler)
                                                                        throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Gets list of TestStep from the given test step request

Specified by:

listTestStepAsync in interface TestDesignServiceAsync

Parameters:

testStepRequest - the given test step request

asyncHandler - callback handler for events in the life-cycle of the request. Users could provide the implementation of the for callback methods in this interface to process the operation result or handle the exception.

Returns:

the list of TestStep instance.

Throws:

AuthServiceException - if an error occurs during getting the test step.

createTestCaseAsync

public java.util.concurrent.Future<TestCase> createTestCaseAsync(CreateTestCaseRequest testCaseRequest)
                                                          throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Creates the test case from the given create test case request

Specified by:

createTestCaseAsync in interface TestDesignServiceAsync

Parameters:

testCaseRequest - the given create test case request instance.

Returns:

the test case instance.

Throws:

AuthServiceException - if an error occurs during creating test case instance.

createTestCaseAsync

public java.util.concurrent.Future<TestCase> createTestCaseAsync(CreateTestCaseRequest testCaseRequest,
                                                                 AsyncHandler<CreateTestCaseRequest,TestCase> asyncHandler)
                                                          throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Creates the test case from the given create test case request

Specified by:

createTestCaseAsync in interface TestDesignServiceAsync

Parameters:

testCaseRequest - the given create test case request instance.

asyncHandler - callback handler for events in the life-cycle of the request. Users could provide the implementation of the for callback methods in this interface to process the operation result or handle the exception.

Returns:

the test case instance.

Throws:

AuthServiceException - if an error occurs during creating test case instance.

createTestStepAsync

public java.util.concurrent.Future<TestStep> createTestStepAsync(CreateTestStepRequest testStepRequest)
                                                          throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Creates the test step from the given create test step request

Specified by:

createTestStepAsync in interface TestDesignServiceAsync

Parameters:

testStepRequest - the given create test step request instance.

Returns:

the test step instance.

Throws:

AuthServiceException - if an error occurs during creating test step instance.

createTestStepAsync

public java.util.concurrent.Future<TestStep> createTestStepAsync(CreateTestStepRequest testStepRequest,
                                                                 AsyncHandler<CreateTestStepRequest,TestStep> asyncHandler)
                                                          throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Creates the test step from the given create test step request

Specified by:

createTestStepAsync in interface TestDesignServiceAsync

Parameters:

testStepRequest - the given create test step request instance.

asyncHandler - callback handler for events in the life-cycle of the request. Users could provide the implementation of the for callback methods in this interface to process the operation result or handle the exception.

Returns:

the test step instance.

Throws:

AuthServiceException - if an error occurs during creating test step instance.

getTestCaseFieldsAsync

public java.util.concurrent.Future<java.util.List<Field>> getTestCaseFieldsAsync(GetTestCaseFieldsRequest getTestCaseFieldsRequest)
                                                                          throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Gets the test-case custom fields.

Specified by:

getTestCaseFieldsAsync in interface TestDesignServiceAsync

Parameters:

getTestCaseFieldsRequest - the given get testcase field request information

Returns:

the list of test-case custom fields.

Throws:

AuthServiceException - if an error occurs during getting test-case custom fields.

getTestCaseFieldsAsync

public java.util.concurrent.Future<java.util.List<Field>> getTestCaseFieldsAsync(GetTestCaseFieldsRequest getTestCaseFieldsRequest,
                                                                                 AsyncHandler<GetTestCaseFieldsRequest,java.util.List<Field>> asyncHandler)
                                                                          throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Gets the test-case custom fields.

Specified by:

getTestCaseFieldsAsync in interface TestDesignServiceAsync

Parameters:

getTestCaseFieldsRequest - the given get testcase field request information.

asyncHandler - callback handler for events in the life-cycle of the request. Users could provide the implementation of the for callback methods in this interface to process the operation result or handle the exception.

Returns:

the list of test-case custom fields.

Throws:

AuthServiceException - if an error occurs during getting test-case custom fields.

addCommentAsync

public java.util.concurrent.Future<TestCase> addCommentAsync(CreateObjectCommentRequest createObjectCommentRequest)
                                                      throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Creates testcase comment from the given request.

Specified by:

addCommentAsync in interface TestDesignServiceAsync

Parameters:

createObjectCommentRequest - the given create testcase comment request instance.

Returns:

the given TestCase instance.

Throws:

AuthServiceException - if an error occurs during adding comment.

addCommentAsync

public java.util.concurrent.Future<TestCase> addCommentAsync(CreateObjectCommentRequest createObjectCommentRequest,
                                                             AsyncHandler<CreateObjectCommentRequest,TestCase> asyncHandler)
                                                      throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Creates testcase comment from the given request.

Specified by:

addCommentAsync in interface TestDesignServiceAsync

Parameters:

createObjectCommentRequest - the given create testcase comment request instance.

asyncHandler - callback handler for events in the life-cycle of the request. Users could provide the implementation of the for callback methods in this interface to process the operation result or handle the exception.

Returns:

the given TestCase instance.

Throws:

AuthServiceException - if an error occurs during adding comment.

createAutomationTestCaseAsync

public java.util.concurrent.Future<AutomationTestCase> createAutomationTestCaseAsync(CreateAutomationTestCaseRequest automationTestCaseRequest)
                                                                              throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Creates the automation test case from the given create automation test case request

Specified by:

createAutomationTestCaseAsync in interface TestDesignServiceAsync

Parameters:

automationTestCaseRequest - the given create automation test case request instance.

Returns:

the automation test case instance.

Throws:

AuthServiceException - if an error occurs during creating test case instance.

createAutomationTestCaseAsync

public java.util.concurrent.Future<AutomationTestCase> createAutomationTestCaseAsync(CreateAutomationTestCaseRequest automationTestCaseRequest,
                                                                                     AsyncHandler<CreateAutomationTestCaseRequest,AutomationTestCase> asyncHandler)
                                                                              throws AuthServiceException

Description copied from interface: TestDesignServiceAsync

Creates the automation test case from the given create automation test case request

Specified by:

createAutomationTestCaseAsync in interface TestDesignServiceAsync

Parameters:

automationTestCaseRequest - the given create automation test case request instance.

asyncHandler - callback handler for events in the life-cycle of the request. Users could provide the implementation of the for callback methods in this interface to process the operation result or handle the exception.

Returns:

the automation test case instance.

Throws:

AuthServiceException - if an error occurs during creating test case instance.

shutdown

public void shutdown()

Description copied from class: ApiWebServiceClient

Shutdown this client object, release any resources that might be held open.

Specified by:

shutdown in interface QTestService

Overrides:

shutdown in class QTestApiWebServiceClient<TestDesignServiceClient>