org.qas.qtest.api.services.client

Class ClientServiceAsyncClient

java.lang.Object

org.qas.api.ApiWebServiceClient<T>

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

org.qas.qtest.api.services.client.ClientServiceClient

org.qas.qtest.api.services.client.ClientServiceAsyncClient

All Implemented Interfaces:

QTestService, ClientService, ClientServiceAsync

public class ClientServiceAsyncClient
extends ClientServiceClient
implements ClientServiceAsync

ClientServiceAsyncClient

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

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.Future<Client>	getClientAsync(GetClientRequest getClientRequest) Get client from the given client request instance.
java.util.concurrent.Future<Client>	getClientAsync(GetClientRequest getClientRequest, AsyncHandler<GetClientRequest,Client> asyncHandler) Get client from the given client request instance.
java.util.concurrent.Future<java.lang.Void>	setSessionUrlAsync(SetSessionUrlRequest setSessionUrlRequest) Sets the session URL from the given set session URL
java.util.concurrent.Future<java.lang.Void>	setSessionUrlAsync(SetSessionUrlRequest setSessionUrlRequest, AsyncHandler<SetSessionUrlRequest,java.lang.Void> asyncHandler) Sets the session URL from the given set session URL
void	shutdown() Shutdown this client object, release any resources that might be held open.

Methods inherited from class org.qas.qtest.api.services.client.ClientServiceClient

getClient, setSessionUrl

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.client.ClientService

getClient, setSessionUrl

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

setEndpoint

Constructor Detail

ClientServiceAsyncClient

public ClientServiceAsyncClient()

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

ClientServiceAsyncClient

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

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

Parameters:

executorService - the executor service for executing asynchronous request.

ClientServiceAsyncClient

public ClientServiceAsyncClient(ClientConfiguration clientConfiguration)

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

Parameters:

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

ClientServiceAsyncClient

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

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

Parameters:

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

executorService - the executor service for executing asynchronous request.

ClientServiceAsyncClient

public ClientServiceAsyncClient(QTestCredentials credentials)

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

Parameters:

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

ClientServiceAsyncClient

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

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

ClientServiceAsyncClient

public ClientServiceAsyncClient(QTestCredentials credentials,
                                ClientConfiguration clientConfiguration)

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

ClientServiceAsyncClient

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

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

executorService - the executor service for executing asynchronous request.

ClientServiceAsyncClient

public ClientServiceAsyncClient(QTestCredentialsProvider credentialsProvider,
                                ClientConfiguration clientConfiguration)

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

ClientServiceAsyncClient

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

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

executorService - the executor service for executing asynchronous request.

Method Detail

getClientAsync

public java.util.concurrent.Future<Client> getClientAsync(GetClientRequest getClientRequest)
                                                   throws AuthServiceException

Description copied from interface: ClientServiceAsync

Get client from the given client request instance.

Specified by:

getClientAsync in interface ClientServiceAsync

Parameters:

getClientRequest - the given client request instance.

Returns:

the Client instance.

Throws:

AuthServiceException - if an error occurs during getting client.

getClientAsync

public java.util.concurrent.Future<Client> getClientAsync(GetClientRequest getClientRequest,
                                                          AsyncHandler<GetClientRequest,Client> asyncHandler)
                                                   throws AuthServiceException

Description copied from interface: ClientServiceAsync

Get client from the given client request instance.

Specified by:

getClientAsync in interface ClientServiceAsync

Parameters:

getClientRequest - the given client 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 Client instance.

Throws:

AuthServiceException - if an error occurs during getting client.

setSessionUrlAsync

public java.util.concurrent.Future<java.lang.Void> setSessionUrlAsync(SetSessionUrlRequest setSessionUrlRequest)
                                                               throws AuthServiceException

Description copied from interface: ClientServiceAsync

Sets the session URL from the given set session URL

Specified by:

setSessionUrlAsync in interface ClientServiceAsync

Parameters:

setSessionUrlRequest - the given set session URL request instance.

Throws:

AuthServiceException - if an error occurs during set session URL.

setSessionUrlAsync

public java.util.concurrent.Future<java.lang.Void> setSessionUrlAsync(SetSessionUrlRequest setSessionUrlRequest,
                                                                      AsyncHandler<SetSessionUrlRequest,java.lang.Void> asyncHandler)
                                                               throws AuthServiceException

Description copied from interface: ClientServiceAsync

Sets the session URL from the given set session URL

Specified by:

setSessionUrlAsync in interface ClientServiceAsync

Parameters:

setSessionUrlRequest - the given set session URL 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.

Throws:

AuthServiceException - if an error occurs during set session URL.

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<ClientServiceClient>