Package org.alfresco.service.cmr.replication

Interface ReplicationDefinition

All Superinterfaces:
Action, CancellableAction, ParameterizedItem, SchedulableAction, Serializable
All Known Implementing Classes:
ReplicationDefinitionImpl
public interface ReplicationDefinition extends CancellableAction, SchedulableAction, Serializable
This class is used to fully specify an inter-repository replication. It specifies which node(s) should be transfered, which associated content should be sent with them, and which target they should be sent to.

Every ReplicationDefinition has a replicationName attribute which uniquely identifies it. It also has a single target.

Author:
Nick Burch

  • Method Details

    • getReplicationName

      String getReplicationName()
      Returns:
      the name which uniquely identifies this replication definition.

    • getReplicationQName

      QName getReplicationQName()
      Returns:
      the qualified name which uniquely identifies this replication definition.

    • getTargetName

      String getTargetName()
      Returns:
      the name of the target repository.

    • setTargetName

      void setTargetName(String targetName)
      Sets the name of the target repository.

    • isEnabled

      boolean isEnabled()
      Is this Replication Definition currently enabled (can be run), or disabled (can't be run)?
      Returns:
      Whether the definition is enabled or not

    • setEnabled

      void setEnabled(boolean enabled)
      Enable or Disable the Replication Definition.

    • getPayload

      List<NodeRef> getPayload()
      The list of Nodes to be transfered. This list can be edited as required.
      Returns:
      An editable list of the nodes to be transfered

    • getLocalTransferReport

      NodeRef getLocalTransferReport()
      Returns the local side of the report on the transfer. The transfer service generates two reports, one on the local repository, and one on the remote repository. This returns the local version of the report.
      Returns:
      The transfer report on the local repository

    • setLocalTransferReport

      void setLocalTransferReport(NodeRef report)
      Records the location on the local repository of the transfer service report on the replication.

    • getRemoteTransferReport

      NodeRef getRemoteTransferReport()
      Returns the remote side of the report on the transfer. The transfer service generates two reports, one on the local repository, and one on the remote repository. This returns the remote version of the report.
      Returns:
      The transfer report on the remote repository

    • setRemoteTransferReport

      void setRemoteTransferReport(NodeRef report)
      Records the location on the local repository of the transfer service report that was generated on the remote repository for the replication.

    • isSchedulingEnabled

      boolean isSchedulingEnabled()
      Is scheduling currently enabled? See ReplicationService.enableScheduling(ReplicationDefinition) and ReplicationService.disableScheduling(ReplicationDefinition)

    • isTargetExists

      boolean isTargetExists()
      Does the target exist?
      Returns:
      true it does