org.qas.qtest.api.internal

Class QTestApiWebServiceClient<T extends QTestApiWebServiceClient<T>>

java.lang.Object

org.qas.api.ApiWebServiceClient<T>

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

Direct Known Subclasses:

ArtifactLinkServiceClient, AttachmentServiceClient, AuthenticateServiceClient, ClientServiceClient, DefectServiceClient, HostServiceClient, ProjectServiceClient, RequirementServiceClient, SearchServiceClient, TestDesignServiceClient, TestExecutionServiceClient, TestPlanServiceClient, UserProfileServiceClient, UserServiceClient

public abstract class QTestApiWebServiceClient<T extends QTestApiWebServiceClient<T>>
extends ApiWebServiceClient<T>

QTestApiWebServiceClient

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected QTestCredentialsProvider	credentialsProvider
protected java.util.List<Unmarshaller<AuthServiceException,JsonObject>>	exceptionUnmarshallers
protected java.util.concurrent.ExecutorService	executorService
protected Signer	signer

Fields inherited from class org.qas.api.ApiWebServiceClient

client, configuration, endpoint, requestHandlers, timeOffset

Constructor Summary

Constructors

Constructor and Description
QTestApiWebServiceClient() Constructs a new client to invoke service method on DefectService using the default qTest credentials provider and default client configuration options.
QTestApiWebServiceClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on DefectService using the default qTest credentials provider and client configuration options.
QTestApiWebServiceClient(QTestCredentials credentials) Constructs a new client to invoke service method on DefectService using the specified qTest credentials.
QTestApiWebServiceClient(QTestCredentials credentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on DefectService using the specified qTest credentials and client configuration options.
QTestApiWebServiceClient(QTestCredentialsProvider credentialsProvider) Constructs a new client to invoke service method on DefectService using the specified qTest credentials provider and client configuration options.
QTestApiWebServiceClient(QTestCredentialsProvider credentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service method on DefectService using the specified qTest credentials provider and client configuration options.

Method Summary

Modifier and Type	Method and Description
protected void	init()
protected <X> X	invoke(Request request, Unmarshaller<X,JsonUnmarshallerContext> unmarshaller)
void	shutdown() Shutdown this client object, release any resources that might be held open.
QTestApiWebServiceClient<T>	withEndpoint(java.lang.String endpoint) Sets the service endpoint.

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

Field Detail

credentialsProvider

protected QTestCredentialsProvider credentialsProvider

signer

protected Signer signer

exceptionUnmarshallers

protected final java.util.List<Unmarshaller<AuthServiceException,JsonObject>> exceptionUnmarshallers

executorService

protected java.util.concurrent.ExecutorService executorService

Constructor Detail

QTestApiWebServiceClient

public QTestApiWebServiceClient()

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

QTestApiWebServiceClient

public QTestApiWebServiceClient(ClientConfiguration clientConfiguration)

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

Parameters:

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

QTestApiWebServiceClient

public QTestApiWebServiceClient(QTestCredentials credentials)

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

Parameters:

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

QTestApiWebServiceClient

public QTestApiWebServiceClient(QTestCredentials credentials,
                                ClientConfiguration clientConfiguration)

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

QTestApiWebServiceClient

public QTestApiWebServiceClient(QTestCredentialsProvider credentialsProvider)

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

QTestApiWebServiceClient

public QTestApiWebServiceClient(QTestCredentialsProvider credentialsProvider,
                                ClientConfiguration clientConfiguration)

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

Method Detail

init

protected void init()

invoke

protected <X> X invoke(Request request,
                       Unmarshaller<X,JsonUnmarshallerContext> unmarshaller)

withEndpoint

public QTestApiWebServiceClient<T> withEndpoint(java.lang.String endpoint)
                                         throws java.lang.IllegalArgumentException

Sets the service endpoint.

Parameters:

endpoint - the given service endpoint URL.

Returns:

the current web service client.

Throws:

java.lang.IllegalArgumentException - if an error occurs during setting the endpoint.

shutdown

public void shutdown()

Description copied from class: ApiWebServiceClient

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

Overrides:

shutdown in class ApiWebServiceClient<T extends QTestApiWebServiceClient<T>>