org.alfresco.service.cmr.replication

Interface ReplicationService

All Superinterfaces:

ReplicationDefinitionPersister

All Known Implementing Classes:

ReplicationServiceImpl

public interface ReplicationService
extends ReplicationDefinitionPersister

The Replication service.

Author:

Nick Burch

Method Summary

Methods

Modifier and Type	Method and Description
ReplicationDefinition	createReplicationDefinition(String replicationName, String description) Creates a new ReplicationDefinition and sets the replication name and description to the specified values.
void	disableScheduling(ReplicationDefinition replicationDefinition) Turns off scheduling for the specified replication
void	enableScheduling(ReplicationDefinition replicationDefinition) Turns on scheduling for the specified replication.
boolean	isEnabled() Is the replication service enabled?
void	replicate(ReplicationDefinition replicationDefinition) Runs the specified replication.

Methods inherited from interface org.alfresco.repo.replication.ReplicationDefinitionPersister

deleteReplicationDefinition, loadReplicationDefinition, loadReplicationDefinitions, loadReplicationDefinitions, renameReplicationDefinition, saveReplicationDefinition

Method Detail

createReplicationDefinition

@NotAuditable
ReplicationDefinition createReplicationDefinition(String replicationName,
                                                             String description)

Creates a new ReplicationDefinition and sets the replication name and description to the specified values.

Parameters:

replicationName - A unique identifier used to specify the created ReplicationDefinition

description - A description of the replication

Returns:

the created ReplicationDefinition

replicate

@NotAuditable
void replicate(ReplicationDefinition replicationDefinition)

Runs the specified replication.

Parameters:

replicationDefinition - The replication to run

enableScheduling

@NotAuditable
void enableScheduling(ReplicationDefinition replicationDefinition)

Turns on scheduling for the specified replication. You can then set the scheduling details on the definition.

disableScheduling

@NotAuditable
void disableScheduling(ReplicationDefinition replicationDefinition)

Turns off scheduling for the specified replication

isEnabled

boolean isEnabled()

Is the replication service enabled?