Package com.adobe.cq.testing.client

Class CQConfigManagerClient

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

All Implemented Interfaces:

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

public final class CQConfigManagerClient
extends CQClient

Client to create configs under the /conf structure. Basic Conf Structure will look similar to this:

 /conf
 ----/confName
          jcr:title
     ----/settings
         ----/configCapability1
         ----/configCapability2
 

A config can be created using create(String title, CQConfigCapability...).
To manipulate existing config use CQConfigManagerClient.CQConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CQConfigManagerClient.CQConfig	Helper class to update or delete an existing config.
static enum	CQConfigManagerClient.CQConfigCapability	List of available Config Capabilities in AEM

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

CLIENT_CONNECTION_TIMEOUT_PROP, DEFAULT_NODE_TYPE, SUDO_COOKIE_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CQConfigManagerClient.CQConfig	create(String configTitle, CQConfigManagerClient.CQConfigCapability... capabilities)	Creates a config on default config path /conf
CQConfigManagerClient.CQConfig	create(String parentPath, String configTitle, CQConfigManagerClient.CQConfigCapability... capabilities)	Creates a CQConfig on the given path
CQConfigManagerClient.CQConfig	create(String parentPath, String configTitle, String configName, CQConfigManagerClient.CQConfigCapability... capabilities)	Created a Config on the given path and with given name

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

Constructor Details

CQConfigManagerClient

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

CQConfigManagerClient

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

Throws:

org.apache.sling.testing.clients.ClientException

Method Details

create

public CQConfigManagerClient.CQConfig create(String configTitle,
 CQConfigManagerClient.CQConfigCapability... capabilities)
                                      throws org.apache.sling.testing.clients.ClientException

Creates a config on default config path /conf

Parameters:

configTitle - title of the config to be created

capabilities - capabilities of the configs eg Editable Templates

Returns:

created config

Throws:

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

create

public CQConfigManagerClient.CQConfig create(String parentPath,
 String configTitle,
 CQConfigManagerClient.CQConfigCapability... capabilities)
                                      throws org.apache.sling.testing.clients.ClientException

Creates a CQConfig on the given path

Parameters:

parentPath - path below which config should be created

configTitle - title of the config to be created

capabilities - capabilities of the configs eg Editable Templates

Returns:

created config

Throws:

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

create

public CQConfigManagerClient.CQConfig create(String parentPath,
 String configTitle,
 String configName,
 CQConfigManagerClient.CQConfigCapability... capabilities)
                                      throws org.apache.sling.testing.clients.ClientException

Created a Config on the given path and with given name

Parameters:

parentPath - path below which config should be created

configTitle - title of the config to be created

configName - node name for the config

capabilities - capabilities of the configs eg Editable Templates

Returns:

created config

Throws:

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