org.qas.qtest.api.services.project

Class ProjectServiceAsyncClient

java.lang.Object

org.qas.api.ApiWebServiceClient<T>

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

org.qas.qtest.api.services.project.ProjectServiceClient

org.qas.qtest.api.services.project.ProjectServiceAsyncClient

All Implemented Interfaces:

QTestService, ProjectService, ProjectServiceAsync

public class ProjectServiceAsyncClient
extends ProjectServiceClient
implements ProjectServiceAsync

ProjectServiceAsyncClient

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
ProjectServiceAsyncClient() Constructs a new client to invoke service method on ProjectService using the default qTest credentials provider and default client configuration options.
ProjectServiceAsyncClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on ProjectService using the default qTest credentials provider and client configuration options.
ProjectServiceAsyncClient(ClientConfiguration clientConfiguration, java.util.concurrent.ExecutorService executorService) Constructs a new client to invoke service method on ProjectService using the default qTest credentials provider and client configuration options.
ProjectServiceAsyncClient(java.util.concurrent.ExecutorService executorService) Constructs a new client to invoke service method on ProjectService using the default qTest credentials provider and default client configuration options.
ProjectServiceAsyncClient(QTestCredentials credentials) Constructs a new client to invoke service method on ProjectService using the specified qTest credentials.
ProjectServiceAsyncClient(QTestCredentials credentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on ProjectService using the specified qTest credentials and client configuration options.
ProjectServiceAsyncClient(QTestCredentials credentials, ClientConfiguration clientConfiguration, java.util.concurrent.ExecutorService executorService) Constructs a new client to invoke service method on ProjectService using the specified qTest credentials and client configuration options.
ProjectServiceAsyncClient(QTestCredentials credentials, java.util.concurrent.ExecutorService executorService) Constructs a new client to invoke service method on ProjectService using the specified qTest credentials.
ProjectServiceAsyncClient(QTestCredentialsProvider credentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on ProjectServiceAsync using the specified qTest credentials provider and client configuration options.
ProjectServiceAsyncClient(QTestCredentialsProvider credentialsProvider, ClientConfiguration clientConfiguration, java.util.concurrent.ExecutorService executorService) Constructs a new client to invoke service method on ProjectServiceAsync using the specified qTest credentials provider and client configuration options.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.Future<Field>	createCustomFieldAsync(CreateCustomFieldRequest createCustomFieldRequest) Creates custom field from the given CreateCustomFieldRequest instance.
java.util.concurrent.Future<Field>	createCustomFieldAsync(CreateCustomFieldRequest createCustomFieldRequest, AsyncHandler<CreateCustomFieldRequest,Field> asyncHandler) Creates custom field from the given CreateCustomFieldRequest instance.
java.util.concurrent.Future<Module>	createModuleAsync(CreateModuleRequest createModuleRequest) Creates module from the given create module request object instance.
java.util.concurrent.Future<Module>	createModuleAsync(CreateModuleRequest createModuleRequest, AsyncHandler<CreateModuleRequest,Module> asyncHandler) Creates module from the given create module request object instance.
java.util.concurrent.Future<Project>	createProjectAsync(CreateProjectRequest createProjectRequest) Creates project in user space.
java.util.concurrent.Future<Project>	createProjectAsync(CreateProjectRequest createProjectRequest, AsyncHandler<CreateProjectRequest,Project> asyncHandler) Creates project in user space.
java.util.concurrent.Future<java.util.List<Field>>	getFieldsAsync(GetFieldsRequest getFieldsRequest) Gets all fields from the given field request.
java.util.concurrent.Future<java.util.List<Field>>	getFieldsAsync(GetFieldsRequest getFieldsRequest, AsyncHandler<GetFieldsRequest,java.util.List<Field>> asyncHandler) Gets all fields from the given field request.
java.util.concurrent.Future<Module>	getModuleAsync(GetModuleRequest getModuleRequest) Gets module from the given get module request object instance.
java.util.concurrent.Future<Module>	getModuleAsync(GetModuleRequest getModuleRequest, AsyncHandler<GetModuleRequest,Module> asyncHandler) Gets module from the given get module request object instance.
java.util.concurrent.Future<UserPermissions>	getUserPermissionsAsync(GetUserPermissionsRequest getUserPermissionsRequest) Gets user permission.
java.util.concurrent.Future<UserPermissions>	getUserPermissionsAsync(GetUserPermissionsRequest getUserPermissionsRequest, AsyncHandler<GetUserPermissionsRequest,UserPermissions> asyncHandler) Gets user permission.
java.util.concurrent.Future<java.util.List<Module>>	listModuleAsync(ListModuleRequest listModuleRequest) Lists modules from the given get module request object instance.
java.util.concurrent.Future<java.util.List<Module>>	listModuleAsync(ListModuleRequest listModuleRequest, AsyncHandler<ListModuleRequest,java.util.List<Module>> asyncHandler) Lists modules from the given get module request object instance.
java.util.concurrent.Future<java.util.List<Project>>	listProjectAsync(ListProjectRequest listProjectRequest) Lists all projects in user space.
java.util.concurrent.Future<java.util.List<Project>>	listProjectAsync(ListProjectRequest listProjectRequest, AsyncHandler<ListProjectRequest,java.util.List<Project>> asyncHandler) Lists all projects in user space.
java.util.concurrent.Future<java.util.List<UserPermissions>>	listUserPermissionsAsync(ListUserPermissionsRequest listUserPermissionsRequest) List user permissions.
java.util.concurrent.Future<java.util.List<UserPermissions>>	listUserPermissionsAsync(ListUserPermissionsRequest listUserPermissionsRequest, AsyncHandler<ListUserPermissionsRequest,java.util.List<UserPermissions>> asyncHandler) Lists user permissions.
java.util.concurrent.Future<Field>	updateSystemFieldAsync(UpdateSystemFieldRequest updateSystemFieldRequest) Updates system field from the given UpdateSystemFieldRequest instance.
java.util.concurrent.Future<Field>	updateSystemFieldAsync(UpdateSystemFieldRequest updateSystemFieldRequest, AsyncHandler<UpdateSystemFieldRequest,Field> asyncHandler) Updates system field from the given UpdateSystemFieldRequest instance.

Methods inherited from class org.qas.qtest.api.services.project.ProjectServiceClient

createCustomField, createModule, createProject, deleteModule, getFields, getModule, getProject, getUserPermissions, listModule, listProject, listRelease, listUserPermissions, moveModule, searchModule, updateCustomField, updateModule, updateSystemField

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

init, invoke, shutdown, 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.project.ProjectService

createCustomField, createModule, createProject, deleteModule, getFields, getModule, getProject, getUserPermissions, listModule, listProject, listRelease, listUserPermissions, moveModule, searchModule, updateCustomField, updateModule, updateSystemField

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

setEndpoint, shutdown

Constructor Detail

ProjectServiceAsyncClient

public ProjectServiceAsyncClient()

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

ProjectServiceAsyncClient

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

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

Parameters:

executorService - the executor service for executing asynchronous request.

ProjectServiceAsyncClient

public ProjectServiceAsyncClient(ClientConfiguration clientConfiguration)

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

Parameters:

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

ProjectServiceAsyncClient

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

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

Parameters:

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

executorService - the executor service for executing asynchronous request.

ProjectServiceAsyncClient

public ProjectServiceAsyncClient(QTestCredentials credentials)

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

Parameters:

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

ProjectServiceAsyncClient

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

Constructs a new client to invoke service method on ProjectService 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.

ProjectServiceAsyncClient

public ProjectServiceAsyncClient(QTestCredentials credentials,
                                 ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on ProjectService 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 ProjectService

ProjectServiceAsyncClient

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

Constructs a new client to invoke service method on ProjectService 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 ProjectService

executorService - the executor service for executing asynchronous request.

ProjectServiceAsyncClient

public ProjectServiceAsyncClient(QTestCredentialsProvider credentialsProvider,
                                 ClientConfiguration clientConfiguration)

Constructs a new client to invoke service method on ProjectServiceAsync 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 ProjectService

ProjectServiceAsyncClient

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

Constructs a new client to invoke service method on ProjectServiceAsync 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 ProjectService

executorService - the executor service for executing asynchronous request.

Method Detail

listProjectAsync

public java.util.concurrent.Future<java.util.List<Project>> listProjectAsync(ListProjectRequest listProjectRequest)
                                                                      throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Lists all projects in user space.

Specified by:

listProjectAsync in interface ProjectServiceAsync

Parameters:

listProjectRequest - the given request to get projects.

Returns:

the list of Project information.

Throws:

AuthServiceException - if an error occurs during getting project.

listProjectAsync

public java.util.concurrent.Future<java.util.List<Project>> listProjectAsync(ListProjectRequest listProjectRequest,
                                                                             AsyncHandler<ListProjectRequest,java.util.List<Project>> asyncHandler)
                                                                      throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Lists all projects in user space.

Specified by:

listProjectAsync in interface ProjectServiceAsync

Parameters:

listProjectRequest - the given request to get projects.

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 Project information.

Throws:

AuthServiceException - if an error occurs during getting project.

createProjectAsync

public java.util.concurrent.Future<Project> createProjectAsync(CreateProjectRequest createProjectRequest)
                                                        throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Creates project in user space.

Specified by:

createProjectAsync in interface ProjectServiceAsync

Parameters:

createProjectRequest - the given create project request.

Returns:

the created project instance.

Throws:

AuthServiceException - if an error occurs during creating project.

createProjectAsync

public java.util.concurrent.Future<Project> createProjectAsync(CreateProjectRequest createProjectRequest,
                                                               AsyncHandler<CreateProjectRequest,Project> asyncHandler)
                                                        throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Creates project in user space.

Specified by:

createProjectAsync in interface ProjectServiceAsync

Parameters:

createProjectRequest - the given create project 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 created project instance.

Throws:

AuthServiceException - if an error occurs during creating project.

createModuleAsync

public java.util.concurrent.Future<Module> createModuleAsync(CreateModuleRequest createModuleRequest)
                                                      throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Creates module from the given create module request object instance.

Specified by:

createModuleAsync in interface ProjectServiceAsync

Parameters:

createModuleRequest - the given create module request to set.

Returns:

the create module instance.

Throws:

AuthServiceException - if an error occurs during creating module.

createModuleAsync

public java.util.concurrent.Future<Module> createModuleAsync(CreateModuleRequest createModuleRequest,
                                                             AsyncHandler<CreateModuleRequest,Module> asyncHandler)
                                                      throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Creates module from the given create module request object instance.

Specified by:

createModuleAsync in interface ProjectServiceAsync

Parameters:

createModuleRequest - the given create module request to set.

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 create module instance.

Throws:

AuthServiceException - if an error occurs during creating module.

getModuleAsync

public java.util.concurrent.Future<Module> getModuleAsync(GetModuleRequest getModuleRequest)
                                                   throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Gets module from the given get module request object instance.

Specified by:

getModuleAsync in interface ProjectServiceAsync

Parameters:

getModuleRequest - the given get module request

Returns:

the module instance.

Throws:

AuthServiceException - if an error occurs during getting module.

getModuleAsync

public java.util.concurrent.Future<Module> getModuleAsync(GetModuleRequest getModuleRequest,
                                                          AsyncHandler<GetModuleRequest,Module> asyncHandler)
                                                   throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Gets module from the given get module request object instance.

Specified by:

getModuleAsync in interface ProjectServiceAsync

Parameters:

getModuleRequest - the given get module 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 module instance.

Throws:

AuthServiceException - if an error occurs during getting module.

listModuleAsync

public java.util.concurrent.Future<java.util.List<Module>> listModuleAsync(ListModuleRequest listModuleRequest)
                                                                    throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Lists modules from the given get module request object instance.

Specified by:

listModuleAsync in interface ProjectServiceAsync

Parameters:

listModuleRequest - the given list module request

Returns:

the list of modules.

Throws:

AuthServiceException - if an error occurs during listing modules.

listModuleAsync

public java.util.concurrent.Future<java.util.List<Module>> listModuleAsync(ListModuleRequest listModuleRequest,
                                                                           AsyncHandler<ListModuleRequest,java.util.List<Module>> asyncHandler)
                                                                    throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Lists modules from the given get module request object instance.

Specified by:

listModuleAsync in interface ProjectServiceAsync

Parameters:

listModuleRequest - the given list module 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 modules.

Throws:

AuthServiceException - if an error occurs during listing modules.

createCustomFieldAsync

public java.util.concurrent.Future<Field> createCustomFieldAsync(CreateCustomFieldRequest createCustomFieldRequest)
                                                          throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Creates custom field from the given CreateCustomFieldRequest instance.

Specified by:

createCustomFieldAsync in interface ProjectServiceAsync

Parameters:

createCustomFieldRequest - the given CreateCustomFieldRequest instance to set.

Returns:

the Field instance.

Throws:

AuthServiceException - if an error occurs during creating custom field to project.

createCustomFieldAsync

public java.util.concurrent.Future<Field> createCustomFieldAsync(CreateCustomFieldRequest createCustomFieldRequest,
                                                                 AsyncHandler<CreateCustomFieldRequest,Field> asyncHandler)
                                                          throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Creates custom field from the given CreateCustomFieldRequest instance.

Specified by:

createCustomFieldAsync in interface ProjectServiceAsync

Parameters:

createCustomFieldRequest - the given CreateCustomFieldRequest instance to set.

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 Field instance.

Throws:

AuthServiceException - if an error occurs during creating custom field to project.

updateSystemFieldAsync

public java.util.concurrent.Future<Field> updateSystemFieldAsync(UpdateSystemFieldRequest updateSystemFieldRequest)
                                                          throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Updates system field from the given UpdateSystemFieldRequest instance.

Specified by:

updateSystemFieldAsync in interface ProjectServiceAsync

Parameters:

updateSystemFieldRequest - the given UpdateSystemFieldRequest instance to set.

Throws:

AuthServiceException - if an error occurs during

updateSystemFieldAsync

public java.util.concurrent.Future<Field> updateSystemFieldAsync(UpdateSystemFieldRequest updateSystemFieldRequest,
                                                                 AsyncHandler<UpdateSystemFieldRequest,Field> asyncHandler)
                                                          throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Updates system field from the given UpdateSystemFieldRequest instance.

Specified by:

updateSystemFieldAsync in interface ProjectServiceAsync

Parameters:

updateSystemFieldRequest - the given UpdateSystemFieldRequest instance to set.

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.

Throws:

AuthServiceException - if an error occurs during

getFieldsAsync

public java.util.concurrent.Future<java.util.List<Field>> getFieldsAsync(GetFieldsRequest getFieldsRequest)
                                                                  throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Gets all fields from the given field request.

Specified by:

getFieldsAsync in interface ProjectServiceAsync

Parameters:

getFieldsRequest - the given GET fields request to get all fields.

Returns:

the list of fields.

Throws:

AuthServiceException - if an error occurs during getting fields.

getFieldsAsync

public java.util.concurrent.Future<java.util.List<Field>> getFieldsAsync(GetFieldsRequest getFieldsRequest,
                                                                         AsyncHandler<GetFieldsRequest,java.util.List<Field>> asyncHandler)
                                                                  throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Gets all fields from the given field request.

Specified by:

getFieldsAsync in interface ProjectServiceAsync

Parameters:

getFieldsRequest - the given GET fields request to get all fields.

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 fields.

Throws:

AuthServiceException - if an error occurs during getting fields.

getUserPermissionsAsync

public java.util.concurrent.Future<UserPermissions> getUserPermissionsAsync(GetUserPermissionsRequest getUserPermissionsRequest)
                                                                     throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Gets user permission.

Specified by:

getUserPermissionsAsync in interface ProjectServiceAsync

Parameters:

getUserPermissionsRequest - the given GetUserPermissionsRequest instance.

Returns:

the UserPermissions object.

Throws:

AuthServiceException - if an error occurs during getting user permissions.

getUserPermissionsAsync

public java.util.concurrent.Future<UserPermissions> getUserPermissionsAsync(GetUserPermissionsRequest getUserPermissionsRequest,
                                                                            AsyncHandler<GetUserPermissionsRequest,UserPermissions> asyncHandler)
                                                                     throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Gets user permission.

Specified by:

getUserPermissionsAsync in interface ProjectServiceAsync

Parameters:

getUserPermissionsRequest - the given GetUserPermissionsRequest 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 UserPermissions object.

Throws:

AuthServiceException - if an error occurs during getting user permissions.

listUserPermissionsAsync

public java.util.concurrent.Future<java.util.List<UserPermissions>> listUserPermissionsAsync(ListUserPermissionsRequest listUserPermissionsRequest)
                                                                                      throws AuthServiceException

Description copied from interface: ProjectServiceAsync

List user permissions.

Specified by:

listUserPermissionsAsync in interface ProjectServiceAsync

Parameters:

listUserPermissionsRequest - the given ListUserPermissionsRequest instance.

Returns:

the list of UserPermissions objects.

Throws:

AuthServiceException - if an error occurs during getting user permissions.

listUserPermissionsAsync

public java.util.concurrent.Future<java.util.List<UserPermissions>> listUserPermissionsAsync(ListUserPermissionsRequest listUserPermissionsRequest,
                                                                                             AsyncHandler<ListUserPermissionsRequest,java.util.List<UserPermissions>> asyncHandler)
                                                                                      throws AuthServiceException

Description copied from interface: ProjectServiceAsync

Lists user permissions.

Specified by:

listUserPermissionsAsync in interface ProjectServiceAsync

Parameters:

listUserPermissionsRequest - the given ListUserPermissionsRequest 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 list of UserPermissions objects.

Throws:

AuthServiceException - if an error occurs during getting user permissions.