com.day.cq.replication
Class ReplicationOptions

java.lang.Object
  com.day.cq.replication.ReplicationOptions

public class ReplicationOptions
extends Object

The ReplicationOptions encapsulate optional configuration parameters for a replication.

Constructor Summary

ReplicationOptions()
Create a new options object with default values

Method Summary

AgentFilter	getFilter() Returns the filter for selecting the agents.
ReplicationListener	getListener() Returns the replication listener.
String	getRevision() Returns the revision to replicate
boolean	isSynchronous() Should the replication be done synchronous or asynchronous? The default is asynchronously.
void	setDesiredAgentIDs(String... desiredAgentId) Deprecated. use setFilter(AgentFilter) instead.
void	setFilter(AgentFilter filter) Sets the filter for selecting the agents for the replication.
void	setListener(ReplicationListener listener) Sets the replication listener.
void	setRevision(String revision) Sets the revision to replicate.
void	setSynchronous(boolean synchronous) Set the synchronous flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplicationOptions

public ReplicationOptions()

Create a new options object with default values

Method Detail

isSynchronous

public boolean isSynchronous()

Should the replication be done synchronous or asynchronous? The default is asynchronously.

Returns:

true for synchronous replication

setSynchronous

public void setSynchronous(boolean synchronous)

Set the synchronous flag.

Parameters:

synchronous - true for synchronous replication

setDesiredAgentIDs

public void setDesiredAgentIDs(String... desiredAgentId)

Deprecated. use setFilter(AgentFilter) instead.

Set the desired agent ids. Please note, that this method internally sets a new AgentIdFilter.

Parameters:

desiredAgentId - agent ids

setFilter

public void setFilter(AgentFilter filter)

Sets the filter for selecting the agents for the replication.

Parameters:

filter - agent filter

getFilter

public AgentFilter getFilter()

Returns the filter for selecting the agents.

Returns:

the filter

getRevision

public String getRevision()

Returns the revision to replicate

Returns:

the revision

setRevision

public void setRevision(String revision)

Sets the revision to replicate.

Parameters:

revision - the revision name.

getListener

public ReplicationListener getListener()

Returns the replication listener.

Returns:

the listener or null

setListener

public void setListener(ReplicationListener listener)

Sets the replication listener. Please note that a listener is currently only called for synchronous replication.

Parameters:

listener - the replication listener.