com.adobe.cq.testing.client

Class BulkEditorClient

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.BulkEditorClient

All Implemented Interfaces:

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

public class BulkEditorClient
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 inherited from class com.adobe.cq.testing.client.CQClient

LOG, STATISTICS_ROOT, wcmCommands

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

DEFAULT_NODE_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
org.apache.sling.testing.clients.SlingHttpResponse	changePropertyValue(String nodePath, String newValue, int... expectedStatus) Update property value.
String	exportContent(String rootPath, String queryParams, String[] cols) Export content to TSV file.
org.apache.sling.testing.clients.SlingHttpResponse	importContent(String rootPath, String fileName, InputStream inputStream, int... expectedStatus) Import content from a TSV file.
org.apache.sling.testing.clients.SlingHttpResponse	importContent(String rootPath, String fileName, String resourceFile, int... expectedStatus) Import content from a TSV file.
org.codehaus.jackson.JsonNode	search(String rootPath, String queryParams, String[] cols) Search with bulk editor.

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

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

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

createFolder, createNode, createNodeRecursive, deletePath, doGetJson, exists, getJsonNode, getJsonNode, getNodeNameFromPath, getParentPath, getUUId, getUUID, 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, getUser, getValue, getValues, hasValue

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkEditorClient

public BulkEditorClient(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

BulkEditorClient

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

Throws:

org.apache.sling.testing.clients.ClientException

Method Detail

search

public org.codehaus.jackson.JsonNode search(String rootPath,
                                            String queryParams,
                                            String[] cols)
                                     throws org.apache.sling.testing.clients.ClientException

Search with bulk editor.

Parameters:

rootPath - The search root path.

queryParams - GQL query parameters.

cols - List of columns to be displayed.

Returns:

Search results.

Throws:

org.apache.sling.testing.clients.ClientException - if the request fails

importContent

public org.apache.sling.testing.clients.SlingHttpResponse importContent(String rootPath,
                                                                        String fileName,
                                                                        String resourceFile,
                                                                        int... expectedStatus)
                                                                 throws org.apache.sling.testing.clients.ClientException

Import content from a TSV file.

Overrides:

importContent in class org.apache.sling.testing.clients.SlingClient

Parameters:

rootPath - where to import

fileName - the file to import

resourceFile - resource file

expectedStatus - list of expected http status codes

Returns:

the http response

Throws:

org.apache.sling.testing.clients.ClientException - if the request fails

importContent

public org.apache.sling.testing.clients.SlingHttpResponse importContent(String rootPath,
                                                                        String fileName,
                                                                        InputStream inputStream,
                                                                        int... expectedStatus)
                                                                 throws org.apache.sling.testing.clients.ClientException

Import content from a TSV file.

Parameters:

rootPath - where to import

fileName - the file name

inputStream - the document input stream

expectedStatus - list of expected http status codes

Returns:

the http response

Throws:

org.apache.sling.testing.clients.ClientException - if the request fails

exportContent

public String exportContent(String rootPath,
                            String queryParams,
                            String[] cols)
                     throws org.apache.sling.testing.clients.ClientException

Export content to TSV file.

Parameters:

rootPath - Content root path.

queryParams - GQL query parameters.

cols - List of columns to be exported.

Returns:

File content.

Throws:

org.apache.sling.testing.clients.ClientException - if the request fails

changePropertyValue

public org.apache.sling.testing.clients.SlingHttpResponse changePropertyValue(String nodePath,
                                                                              String newValue,
                                                                              int... expectedStatus)
                                                                       throws org.apache.sling.testing.clients.ClientException

Update property value.

Parameters:

nodePath - The path to the property.

newValue - The value for the property.

expectedStatus - list of expected http status codes

Returns:

the response

Throws:

org.apache.sling.testing.clients.ClientException - if the request fails