@ProviderType public interface Replicator
Replicator
is the replication service.
It can be used to replicate content.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
REPLICATE_PRIVILEGE
Replication privilege
|
Modifier and Type | Method and Description |
---|---|
void |
checkPermission(Session session,
ReplicationActionType type,
java.lang.String path)
Checks if a user session has enough permissions for a provided replication type and path
|
java.util.List<ReplicationContentFilter> |
createContentFilterChain(ReplicationAction action)
Deprecated.
|
java.util.Iterator<java.lang.String> |
getActivatedPaths(Session session,
java.lang.String path)
Returns the paths of all nodes for the given subtree path which are
activated.
|
ReplicationStatus |
getReplicationStatus(Session session,
java.lang.String path)
Returns a replication status for the given path.
|
void |
replicate(Session session,
ReplicationActionType type,
java.lang.String path)
Triggers a new replication with supplied options.
|
void |
replicate(Session session,
ReplicationActionType type,
java.lang.String[] paths,
ReplicationOptions options)
Triggers a new replication with supplied options.
|
void |
replicate(Session session,
ReplicationActionType type,
java.lang.String path,
ReplicationOptions options)
Triggers a new replication with supplied options.
|
static final java.lang.String REPLICATE_PRIVILEGE
void replicate(Session session, ReplicationActionType type, java.lang.String path) throws ReplicationException
session
- user sessiontype
- The type of replicationpath
- The path specified the content to be replicatedReplicationException
- if an error occursvoid replicate(Session session, ReplicationActionType type, java.lang.String path, ReplicationOptions options) throws ReplicationException
session
- user sessiontype
- The type of replicationpath
- The path specified the content to be replicatedoptions
- Additional replication optionsReplicationException
- if an error occursvoid replicate(Session session, ReplicationActionType type, java.lang.String[] paths, ReplicationOptions options) throws ReplicationException
session
- user sessiontype
- The type of replicationpaths
- The paths specified the content to be replicatedoptions
- Additional replication optionsReplicationException
- if an error occursvoid checkPermission(Session session, ReplicationActionType type, java.lang.String path) throws ReplicationException
session
- user sessiontype
- The type of replicationpath
- The path specified the content to be replicatedReplicationException
- if an error occursReplicationStatus getReplicationStatus(Session session, java.lang.String path)
session
- sessionpath
- path to checknull
if not available.java.util.Iterator<java.lang.String> getActivatedPaths(Session session, java.lang.String path) throws ReplicationException
session
- User sessionpath
- Path to checkReplicationException
- If error occurs on retrieving node and its
descendants@Deprecated java.util.List<ReplicationContentFilter> createContentFilterChain(ReplicationAction action)
List
of ReplicationContentFilter
s to be used by ContentBuilder
s to filter
content for exclusion from the replication content being built. The filters in the list are not in a particular
order.action
- The ReplicationAction
to build the filters contained in the list for.List
of ReplicationContentFilter
s.Copyright © 2010 - 2020 Adobe. All Rights Reserved