com.adobe.cq.testing.junit.rules

Class DefaultReplicationAgents

java.lang.Object

com.adobe.cq.testing.junit.rules.DefaultReplicationAgents

All Implemented Interfaces:

org.junit.rules.TestRule

public class DefaultReplicationAgents
extends Object
implements org.junit.rules.TestRule

Adapts the default replication agents on the author to target the provided publish.

WARNING: make sure the input Instance rules (authorRule and publishRule) are applied before this one, otherwise it will fail to retrieve the urls of the two instances. The easiest way is to use a RuleChain, where this rule is the last one

Usually this is applied at class level to avoid stressing the target instance for each test

Constructor Summary

Constructors

Constructor and Description
DefaultReplicationAgents(org.apache.sling.testing.junit.rules.instance.Instance authorRule, org.apache.sling.testing.junit.rules.instance.Instance publishRule)

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
protected void	cleanup() Performs the cleanup after evaluating the statement.
protected boolean	configure() Whether to configure the agents or not.
protected void	configureReplicationAgents() Configure the replication agents to getReplicationAgent() and getReverseReplicationAgent()
protected String	getReplicationAgent() Returns the path to the replication agent on the publishRule instance.
protected String	getReverseReplicationAgent() Returns the path to the reverse replication agent on the publishRule instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultReplicationAgents

public DefaultReplicationAgents(org.apache.sling.testing.junit.rules.instance.Instance authorRule,
                                org.apache.sling.testing.junit.rules.instance.Instance publishRule)

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule

configure

protected boolean configure()

Whether to configure the agents or not.

Used to ensure that the agents are configured only if a certain condition is met. This default implementation always returns true, but subclasses can override it.

Returns:

true

configureReplicationAgents

protected void configureReplicationAgents()
                                   throws org.apache.sling.testing.clients.ClientException,
                                          InterruptedException

Configure the replication agents to getReplicationAgent() and getReverseReplicationAgent()

Throws:

org.apache.sling.testing.clients.ClientException - if an error happened during configuration

InterruptedException - to mark this operation as waiting; the exception should be thrown up the stack

cleanup

protected void cleanup()

Performs the cleanup after evaluating the statement. This default implementation doesn't do anything.

getReplicationAgent

protected String getReplicationAgent()

Returns the path to the replication agent on the publishRule instance. This default implementation returns the value of ReplicationClient.PUBLISH_REPLICATION_DEFAULT_AGENT

Returns:

the path to the replication agent

getReverseReplicationAgent

protected String getReverseReplicationAgent()

Returns the path to the reverse replication agent on the publishRule instance. This default implementation returns the value of ReplicationClient.PUBLISH_REVERSE_REPLICATION_DEFAULT_AGENT

Returns:

the path to the reverse replication agent