org.qas.qtest.api.services.host

Interface HostService

All Superinterfaces:

QTestService

All Known Subinterfaces:

HostServiceAsync

All Known Implementing Classes:

HostServiceAsyncClient, HostServiceClient

public interface HostService
extends QTestService

HostService

Since:

1.0

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 listJobRequest) 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 interface org.qas.qtest.api.internal.QTestService

setEndpoint, shutdown

Method Detail

registerAutomationHost

AutomationHost registerAutomationHost(CreateAutomationHostRequest automationHostRequest)
                               throws AuthClientException

Register the automation host to qTest service.

Parameters:

automationHostRequest - the given register automation host request.

Returns:

the automation host information.

Throws:

AuthClientException - if an error occurs during registering automation host.

registerAutomationAgent

AutomationAgent registerAutomationAgent(CreateAutomationAgentRequest automationAgentRequest)
                                 throws AuthClientException

Register the automation agent to qTest service.

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.

updateAutomationHost

AutomationHost updateAutomationHost(UpdateAutomationHostRequest automationHostRequest)
                             throws AuthClientException

Throws:

AuthClientException

updateAutomationAgent

AutomationAgent updateAutomationAgent(UpdateAutomationAgentRequest automationAgentRequest)
                               throws AuthClientException

update the automation agent to qTest service.

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.

activateAutomationAgent

void activateAutomationAgent(ActivateAutomationAgentRequest activateAgentRequest)
                      throws AuthClientException

Active or inactive the automation agent to qTest service.

Parameters:

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

Throws:

AuthClientException - if an error occurs during activating automation agent.

listJobs

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

List all automation jobs from qTest server in a period

Parameters:

listJobRequest - the list jobs request.

Returns:

the list of job execution.

Throws:

AuthClientException - if an error occurs during listing jobs.

pingHost

PongMessage pingHost(PingAutomationHostRequest pingRequest)
              throws AuthClientException

Ping host.

Parameters:

pingRequest - the given ping request.

Returns:

the ping message.

Throws:

AuthClientException - if an error occurs during ping host.

updateJobStatus

void updateJobStatus(UpdateJobStatusRequest updateJobStatusRequest)
              throws AuthServiceException

Update job instance status

Parameters:

updateJobStatusRequest - the given job status to set.

Throws:

AuthServiceException - if an error occurs during updating job status.

deleteAutomationAgent

void deleteAutomationAgent(DeleteAutomationAgentRequest deleteAutomationAgentRequest)
                    throws AuthClientException

Delete automation agent

Parameters:

deleteAutomationAgentRequest - the given delete automation agent request.

Throws:

AuthClientException - if an error occurs during deleting automation agent.