Package com.day.cq.replication

Class ReplicationOptions

  • public class ReplicationOptions
extends java.lang.Object
    The ReplicationOptions encapsulate optional configuration parameters for a replication.

    • 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

        @Deprecated
public void setDesiredAgentIDs​(java.lang.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 java.lang.String getRevision()
        Returns the revision to replicate
        Returns:
        the revision

      • setRevision

        public void setRevision​(java.lang.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.

      • isSuppressStatusUpdate

        public boolean isSuppressStatusUpdate()
        If true, the replication will not update the replication status properties after a replication.
        Returns:
        true if status updates should be suppressed.
        Since:
        5.4

      • setSuppressStatusUpdate

        public void setSuppressStatusUpdate​(boolean suppressStatusUpdate)
        If set to true the replication will not update the replication status properties after a replication.
        Parameters:
        suppressStatusUpdate - true if status updates should be suppressed
        Since:
        5.4

      • isSuppressVersions

        public boolean isSuppressVersions()
        If true the replication will not trigger implicit versioning.
        Returns:
        true if implicit versioning should be suppressed
        Since:
        5.4

      • setSuppressVersions

        public void setSuppressVersions​(boolean suppressVersions)
        If set to true the replication will not trigger implicit versioning.
        Parameters:
        suppressVersions - set to true if implicit versioning should be suppressed
        Since:
        5.4

      • getAggregateHandler

        public AggregateHandler getAggregateHandler()
        Returns the defined aggregate handler or null
        Returns:
        the aggregate handler.
        Since:
        5.5

      • setAggregateHandler

        public void setAggregateHandler​(AggregateHandler aggregateHandler)
        Sets the aggregate handler.
        Parameters:
        aggregateHandler - the aggregate handler
        Since:
        5.5

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • setUpdateAlias

        public void setUpdateAlias​(boolean updateAlias)
        Parameters:
        updateAlias - the boolean value to set the updateAlias to
        Since:
        5.9

      • isUpdateAlias

        public boolean isUpdateAlias()
        Returns:
        the boolean value for the updateAlias
        Since:
        5.9

      • setUseAtomicCalls

        public void setUseAtomicCalls​(boolean useAtomicCalls)
        Deprecated.
        no longer required
        Allows the system to split the provided paths into multiple independent batches, thus not replicating all provided paths in an atomic fashion. By default atomic calls are configured.
        Parameters:
        useAtomicCalls - false if a large batch of paths should be replicated, but atomicity is not required.

      • isUseAtomicCalls

        public boolean isUseAtomicCalls()
        Deprecated.
        no longer required
        Allows the system to split the provided paths into multiple independent batches, thus not replicating all provided paths in an atomic fashion
        Returns:
        false if a large batch of paths should be replicated, but atomicity is not required.

      • addToAliasReplicated

        public void addToAliasReplicated​(java.lang.String path)
        Add path to already replicated alias set.
        Parameters:
        path - the path

      • isAliasReplicated

        public boolean isAliasReplicated​(java.lang.String path)
        Returns true if path is already replicated else false.
        Parameters:
        path - the path
        Returns:
        true if path is already replicated, else false

      • isDisablePreProcessors

        public boolean isDisablePreProcessors()
        If pre processors disabled or enabled
        Returns:
        the boolean value for disablePreProcessors

      • setDisablePreProcessors

        public void setDisablePreProcessors​(boolean disablePreProcessors)
        Parameters:
        disablePreProcessors - boolean value for disabling pre-processors