Package com.day.cq.replication

Interface ReplicationStatusProvider

@ProviderType public interface ReplicationStatusProvider
A provider for ReplicationStatus

  • Method Details

    • getBatchReplicationStatus

      @Nonnull Map<String,ReplicationStatus> getBatchReplicationStatus(@Nonnull Resource... resources)
      Returns a batch replication status for a number of resources, in the form of a map whose keys are paths and values are related replication statuses. This method is expected to be used with a bunch of resources, when needing retrieval of replication status for a single resource please use #getReplicationStatus(Resource).
      Parameters:
      resources - the resource to obtain the statuses for
      Returns:
      the batch replication status as a map of path to status

    • getReplicationStatus

      @CheckForNull ReplicationStatus getReplicationStatus(@Nonnull Resource resource)
      Returns a replication status for the given resource
      Parameters:
      resource - the resource to obtain the status for
      Returns:
      the replication status or null if not available.

    • getReplicationStatus

      @CheckForNull ReplicationStatus getReplicationStatus(@Nonnull Session session, @Nonnull String path) throws RepositoryException
      Returns a replication status for the node at a given path
      Parameters:
      session - the session used to access the node at the given path
      path - path to check
      Returns:
      the replication status or null if not available.
      Throws:
      RepositoryException - if retrieval of the related node fails