com.adobe.cq.testing.client

Class ReplicationClient

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

All Implemented Interfaces:

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

public class ReplicationClient
extends CQClient

Client for all replication related actions: activate, deactivate, agents management.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReplicationClient.EmptyReplicationQueuePoller

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 and Description
static String	AUTHOR_GROUP_PATH
static String	PUBLISH_REPLICATION_DEFAULT_AGENT
static String	PUBLISH_REVERSE_REPLICATION_DEFAULT_AGENT

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
ReplicationClient(org.apache.http.impl.client.CloseableHttpClient http, org.apache.sling.testing.clients.SlingClientConfig config)
ReplicationClient(URI serverUrl, String user, String password)

Method Summary

Modifier and Type	Method and Description
org.apache.sling.testing.clients.SlingHttpResponse	activate(String nodePath, int... expectedStatus) Activates (publish) a node.
org.apache.sling.testing.clients.SlingHttpResponse	activateLater(String nodePath, long timeMilliseconds, int... expectedStatus) Activates a page after a period of time.
org.codehaus.jackson.JsonNode	adaptReplicationAgent(String agentPath, org.apache.http.message.BasicNameValuePair... properties) Adapts an existing agent's properties
org.codehaus.jackson.JsonNode	createReplicationAgent(String name, String title, String parentPath, String template, org.apache.http.message.BasicNameValuePair... properties) Creates a replication agent, if not already present
org.apache.sling.testing.clients.SlingHttpResponse	deactivate(String pagePath, int... expectedStatus) Deactivates (un-publish) a node.
org.apache.sling.testing.clients.SlingHttpResponse	deactivateLater(String nodePath, long timeMilliseconds, int... expectedStatus) Deactivates a page after a period of time.
boolean	findInLog(String agentLocation, String[] patterns, Date startTime) Returns true if the specific at least one pattern was found in the log or false otherwise.
org.codehaus.jackson.JsonNode	getAgentReplicationQueue(String agentPath) Returns the agent replication queue.
org.codehaus.jackson.JsonNode	getPublishReplicationQueue() Returns the default replication agent queue.
org.codehaus.jackson.JsonNode	getReverseReplicationQueue() Returns the reverse replication agent queue.
boolean	isConnectionSuccessful(String agentLocation)
void	waitAgentReplicationQueueIsEmpty(String agentPath) Waits until the queue of the requested agent is empty
void	waitPublishReplicationQueueIsEmpty()
void	waitReversePublishReplicationQueueIsEmpty()

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, 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

Field Detail

AUTHOR_GROUP_PATH

public static final String AUTHOR_GROUP_PATH

See Also:

Constant Field Values

PUBLISH_REPLICATION_DEFAULT_AGENT

public static final String PUBLISH_REPLICATION_DEFAULT_AGENT

See Also:

Constant Field Values

PUBLISH_REVERSE_REPLICATION_DEFAULT_AGENT

public static final String PUBLISH_REVERSE_REPLICATION_DEFAULT_AGENT

See Also:

Constant Field Values

Constructor Detail

ReplicationClient

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

ReplicationClient

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

Throws:

org.apache.sling.testing.clients.ClientException

Method Detail

activate

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

Activates (publish) a node.

Parameters:

nodePath - path of the node to activate

expectedStatus - list of expected HTTP status to be returned, if not set, 200 is assumed.

Returns:

the response

Throws:

org.apache.sling.testing.clients.ClientException - if something fails during the request/response cycle

deactivate

public org.apache.sling.testing.clients.SlingHttpResponse deactivate(String pagePath,
                                                                     int... expectedStatus)
                                                              throws org.apache.sling.testing.clients.ClientException

Deactivates (un-publish) a node.

Parameters:

pagePath - path of the node to deactivate

expectedStatus - list of expected HTTP status to be returned, if not set, 200 is assumed.

Returns:

the response

Throws:

org.apache.sling.testing.clients.ClientException - if something fails during the request/response cycle

activateLater

public org.apache.sling.testing.clients.SlingHttpResponse activateLater(String nodePath,
                                                                        long timeMilliseconds,
                                                                        int... expectedStatus)
                                                                 throws org.apache.sling.testing.clients.ClientException

Activates a page after a period of time.

Parameters:

nodePath - The path to the node which is activated

timeMilliseconds - The time interval, in milliseconds, from current timestamp, after which the node will be activated

expectedStatus - list of expected statuses

Returns:

the http response

Throws:

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

deactivateLater

public org.apache.sling.testing.clients.SlingHttpResponse deactivateLater(String nodePath,
                                                                          long timeMilliseconds,
                                                                          int... expectedStatus)
                                                                   throws org.apache.sling.testing.clients.ClientException

Deactivates a page after a period of time.

Parameters:

nodePath - The path to the node which is deactivated

timeMilliseconds - The time interval, in milliseconds, from current timestamp, after which the node will be deactivated

expectedStatus - list of expected statuses

Returns:

the http response

Throws:

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

createReplicationAgent

public org.codehaus.jackson.JsonNode createReplicationAgent(String name,
                                                            String title,
                                                            String parentPath,
                                                            String template,
                                                            org.apache.http.message.BasicNameValuePair... properties)
                                                     throws org.apache.sling.testing.clients.ClientException,
                                                            InterruptedException

Creates a replication agent, if not already present

Parameters:

name - name of the agent

title - title of the agent (page)

parentPath - where to create the agent. Typical paths for CQ are /etc/replication/agents.author/ and /etc/replication/agents.publish/

template - template of the agent. Typical value is /libs/cq/replication/templates/agent

properties - list of properties to be set on the agent

Returns:

the json representation of agent's (jcr:content) node

Throws:

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

InterruptedException - to mark this method as waiting

adaptReplicationAgent

public org.codehaus.jackson.JsonNode adaptReplicationAgent(String agentPath,
                                                           org.apache.http.message.BasicNameValuePair... properties)
                                                    throws org.apache.sling.testing.clients.ClientException,
                                                           InterruptedException

Adapts an existing agent's properties

Parameters:

agentPath - the path of the agent

properties - list of properties to be set on the agent

Returns:

the json representation of the agent's (jcr:content) node

Throws:

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

InterruptedException - to mark this method as waiting

getAgentReplicationQueue

public org.codehaus.jackson.JsonNode getAgentReplicationQueue(String agentPath)
                                                       throws org.apache.sling.testing.clients.ClientException,
                                                              InterruptedException

Returns the agent replication queue.

Parameters:

agentPath - The location in jcr where the agent is stored.

Returns:

the queue as json node

Throws:

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

InterruptedException - to mark this method as waiting

getPublishReplicationQueue

public org.codehaus.jackson.JsonNode getPublishReplicationQueue()
                                                         throws org.apache.sling.testing.clients.ClientException,
                                                                InterruptedException

Returns the default replication agent queue.

Returns:

the queue as json node

Throws:

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

InterruptedException - to mark this method as waiting

getReverseReplicationQueue

public org.codehaus.jackson.JsonNode getReverseReplicationQueue()
                                                         throws org.apache.sling.testing.clients.ClientException,
                                                                InterruptedException

Returns the reverse replication agent queue.

Returns:

the queue as json node

Throws:

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

InterruptedException - to mark this method as waiting

waitAgentReplicationQueueIsEmpty

public void waitAgentReplicationQueueIsEmpty(String agentPath)
                                      throws InterruptedException,
                                             org.apache.sling.testing.clients.ClientException

Waits until the queue of the requested agent is empty

Parameters:

agentPath - path to the agent

Throws:

org.apache.sling.testing.clients.ClientException - if the queue is not empty after the default timeout (2 min) expires

InterruptedException - to mark this method as waiting

waitPublishReplicationQueueIsEmpty

public void waitPublishReplicationQueueIsEmpty()
                                        throws InterruptedException,
                                               org.apache.sling.testing.clients.ClientException

Throws:

InterruptedException

org.apache.sling.testing.clients.ClientException

waitReversePublishReplicationQueueIsEmpty

public void waitReversePublishReplicationQueueIsEmpty()
                                               throws InterruptedException,
                                                      org.apache.sling.testing.clients.ClientException

Throws:

InterruptedException

org.apache.sling.testing.clients.ClientException

isConnectionSuccessful

public boolean isConnectionSuccessful(String agentLocation)
                               throws org.apache.sling.testing.clients.ClientException

Throws:

org.apache.sling.testing.clients.ClientException

findInLog

public boolean findInLog(String agentLocation,
                         String[] patterns,
                         Date startTime)
                  throws org.apache.sling.testing.clients.ClientException

Returns true if the specific at least one pattern was found in the log or false otherwise.

Parameters:

agentLocation - agent path

patterns - list of patterns

startTime - start time

Returns:

true if the pattern was found

Throws:

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