Package com.adobe.cq.testing.client

Class JobsClient

java.lang.Object

org.apache.sling.testing.clients.AbstractSlingClient

org.apache.sling.testing.clients.SlingClient

com.adobe.cq.testing.client.CQClient

com.adobe.cq.testing.client.JobsClient

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.http.client.HttpClient

public class JobsClient
extends CQClient

Nested Class Summary

Nested classes/interfaces inherited from class com.adobe.cq.testing.client.CQClient

CQClient.Builder, CQClient.InternalBuilder<T extends CQClient>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	QE_JOBS_ALL_PATH
static final String	QE_JOBS_ALL_SELECTOR
static final String	QE_JOBS_JSON_EXTENSION
static final String	QE_JOBS_SERVLET_PATH
static final String	QE_QUEUES_ALL_PATH
static final String	QE_QUEUES_SERVLET_PATH

Fields inherited from class com.adobe.cq.testing.client.CQClient

LOG, STATISTICS_ROOT, wcmCommands

Fields inherited from class org.apache.sling.testing.clients.SlingClient

CLIENT_CONNECTION_TIMEOUT_PROP, DEFAULT_NODE_TYPE, SUDO_COOKIE_NAME

Constructor Summary

Constructors

Constructor	Description
JobsClient(URI serverUrl, String user, String password)
JobsClient(org.apache.http.impl.client.CloseableHttpClient http, org.apache.sling.testing.clients.SlingClientConfig config)

Method Summary

Modifier and Type	Method	Description
JobsList	getJobs(String topic)	Get a list of active and queued jobs for a specific topic
JobsStatistics	getJobsStatistics()	Provides a JobsStatistics object to describe all the current jobs statistics

Methods inherited from class com.adobe.cq.testing.client.CQClient

copyLanguages, copyPage, createPage, createPageWithRetry, createVersion, deletePage, deletePageWithRetry, getAuthorSitesPage, lockPage, movePage, movePage, pageExists, pageExistsWithRetry, pageExistsWithRetry, resetPageStatistics, restoreTree, restoreVersion, rolloutPage, searchAndReplaceInPages, searchInPages, setPageProperties, setPageProperty, setPagePropertyImage, unlockPage, uploadFileCQStyle

Methods inherited from class org.apache.sling.testing.clients.SlingClient

createFolder, createNode, createNodeRecursive, deletePath, doGetJson, endImpersonation, exists, getJsonNode, getJsonNode, getNodeNameFromPath, getParentPath, getUser, getUUId, getUUID, impersonate, importContent, importContent, importJson, move, setPropertiesString, setPropertyString, setPropertyStringArray, upload, waitExists, waitUntilExists

Methods inherited from class org.apache.sling.testing.clients.AbstractSlingClient

adaptTo, addValue, close, doDelete, doGet, doGet, doGet, doHead, doPatch, doPost, doPost, doPut, doRawRequest, doRequest, doStreamGet, doStreamPost, doStreamRequest, execute, execute, execute, execute, execute, execute, execute, execute, getClientId, getConnectionManager, getCookieStore, getCredentialsProvider, getParams, getPassword, getPath, getPath, getUrl, getUrl, getUrl, getValue, getValues, hasValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

QE_QUEUES_SERVLET_PATH

public static final String QE_QUEUES_SERVLET_PATH

See Also:

• Constant Field Values

QE_JOBS_SERVLET_PATH

public static final String QE_JOBS_SERVLET_PATH

See Also:

• Constant Field Values

QE_JOBS_ALL_SELECTOR

public static final String QE_JOBS_ALL_SELECTOR

See Also:

• Constant Field Values

QE_JOBS_JSON_EXTENSION

public static final String QE_JOBS_JSON_EXTENSION

See Also:

• Constant Field Values

QE_QUEUES_ALL_PATH

public static final String QE_QUEUES_ALL_PATH

See Also:

• Constant Field Values

QE_JOBS_ALL_PATH

public static final String QE_JOBS_ALL_PATH

See Also:

• Constant Field Values

Constructor Details

JobsClient

public JobsClient(org.apache.http.impl.client.CloseableHttpClient http,
 org.apache.sling.testing.clients.SlingClientConfig config)
           throws org.apache.sling.testing.clients.ClientException

Throws:

org.apache.sling.testing.clients.ClientException

JobsClient

public JobsClient(URI serverUrl,
 String user,
 String password)
           throws org.apache.sling.testing.clients.ClientException

Throws:

org.apache.sling.testing.clients.ClientException

Method Details

getJobsStatistics

public JobsStatistics getJobsStatistics()
                                 throws org.apache.sling.testing.clients.ClientException

Provides a JobsStatistics object to describe all the current jobs statistics

Returns:

a jobs statistics descriptor

Throws:

org.apache.sling.testing.clients.ClientException - if the HTTP call fails

getJobs

public JobsList getJobs(String topic)
                 throws org.apache.sling.testing.clients.ClientException

Get a list of active and queued jobs for a specific topic

Parameters:

topic - the topic to filter jobs

Returns:

a list of jobs

Throws:

org.apache.sling.testing.clients.ClientException - if the call to the quickstart fails