org.qas.qtest.api.services.host

Class HostServiceClient

java.lang.Object

org.qas.api.ApiWebServiceClient<T>

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

org.qas.qtest.api.services.host.HostServiceClient

All Implemented Interfaces:

QTestService, HostService

Direct Known Subclasses:

HostServiceAsyncClient

public class HostServiceClient
extends QTestApiWebServiceClient<HostServiceClient>
implements HostService

HostServiceClient

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

Method Summary

Modifier and Type	Method and Description
void	activateAutomationAgent(ActivateAutomationAgentRequest activateAgentRequest) Active or inactive the automation agent to qTest service.
void	deleteAutomationAgent(DeleteAutomationAgentRequest deleteAutomationAgentRequest) Delete automation agent
java.util.List<Job>	listJobs(ListJobRequest jobRequest) List all automation jobs from qTest server in a period
PongMessage	pingHost(PingAutomationHostRequest pingRequest) Ping host.
AutomationAgent	registerAutomationAgent(CreateAutomationAgentRequest automationAgentRequest) Register the automation agent to qTest service.
AutomationHost	registerAutomationHost(CreateAutomationHostRequest automationHostRequest) Register the automation host to qTest service.
AutomationAgent	updateAutomationAgent(UpdateAutomationAgentRequest automationAgentRequest) update the automation agent to qTest service.
AutomationHost	updateAutomationHost(UpdateAutomationHostRequest automationHostRequest)
void	updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest) Update job instance status

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.internal.QTestService

setEndpoint, shutdown

Constructor Detail

HostServiceClient

public HostServiceClient()

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

HostServiceClient

public HostServiceClient(ClientConfiguration clientConfiguration)

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

Parameters:

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

HostServiceClient

public HostServiceClient(QTestCredentials credentials)

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

Parameters:

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

HostServiceClient

public HostServiceClient(QTestCredentials credentials,
                         ClientConfiguration clientConfiguration)

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

HostServiceClient

public HostServiceClient(QTestCredentialsProvider credentialsProvider)

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

HostServiceClient

public HostServiceClient(QTestCredentialsProvider credentialsProvider,
                         ClientConfiguration clientConfiguration)

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

Method Detail

registerAutomationHost

public AutomationHost registerAutomationHost(CreateAutomationHostRequest automationHostRequest)
                                      throws AuthServiceException

Description copied from interface: HostService

Register the automation host to qTest service.

Specified by:

registerAutomationHost in interface HostService

Parameters:

automationHostRequest - the given register automation host request.

Returns:

the automation host information.

Throws:

AuthServiceException

updateAutomationHost

public AutomationHost updateAutomationHost(UpdateAutomationHostRequest automationHostRequest)
                                    throws AuthServiceException

Specified by:

updateAutomationHost in interface HostService

Throws:

AuthServiceException

registerAutomationAgent

public AutomationAgent registerAutomationAgent(CreateAutomationAgentRequest automationAgentRequest)
                                        throws AuthClientException

Description copied from interface: HostService

Register the automation agent to qTest service.

Specified by:

registerAutomationAgent in interface HostService

Parameters:

automationAgentRequest - the given register agent request to send to qTest.

Returns:

the automation agent instance.

Throws:

AuthClientException - if an error occurs during registering automation agent.

updateAutomationAgent

public AutomationAgent updateAutomationAgent(UpdateAutomationAgentRequest automationAgentRequest)
                                      throws AuthClientException

Description copied from interface: HostService

update the automation agent to qTest service.

Specified by:

updateAutomationAgent in interface HostService

Parameters:

automationAgentRequest - the given update agent request to send to qTest.

Returns:

the automation agent instance.

Throws:

AuthClientException - if an error occurs during update automation agent.

deleteAutomationAgent

public void deleteAutomationAgent(DeleteAutomationAgentRequest deleteAutomationAgentRequest)
                           throws AuthClientException

Description copied from interface: HostService

Delete automation agent

Specified by:

deleteAutomationAgent in interface HostService

Parameters:

deleteAutomationAgentRequest - the given delete automation agent request.

Throws:

AuthClientException - if an error occurs during deleting automation agent.

activateAutomationAgent

public void activateAutomationAgent(ActivateAutomationAgentRequest activateAgentRequest)
                             throws AuthClientException

Description copied from interface: HostService

Active or inactive the automation agent to qTest service.

Specified by:

activateAutomationAgent in interface HostService

Parameters:

activateAgentRequest - the given activate agent request to send to qTest.

Throws:

AuthClientException - if an error occurs during activating automation agent.

listJobs

public java.util.List<Job> listJobs(ListJobRequest jobRequest)
                             throws AuthClientException

Description copied from interface: HostService

List all automation jobs from qTest server in a period

Specified by:

listJobs in interface HostService

Parameters:

jobRequest - the list jobs request.

Returns:

the list of job execution.

Throws:

AuthClientException - if an error occurs during listing jobs.

pingHost

public PongMessage pingHost(PingAutomationHostRequest pingRequest)
                     throws AuthClientException

Description copied from interface: HostService

Ping host.

Specified by:

pingHost in interface HostService

Parameters:

pingRequest - the given ping request.

Returns:

the ping message.

Throws:

AuthClientException - if an error occurs during ping host.

updateJobStatus

public void updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest)
                     throws AuthServiceException

Description copied from interface: HostService

Update job instance status

Specified by:

updateJobStatus in interface HostService

Parameters:

updateJobStatusRequest - the given job status to set.

Throws:

AuthServiceException - if an error occurs during updating job status.