Package com.day.cq.replication

Interface ReplicationQueue

public interface ReplicationQueue
ReplicationQueue...

  • Method Details

    • getName

      String getName()
      Returns the name of this queue
      Returns:
      the name of this queue

    • entries

      List<ReplicationQueue.Entry> entries()
      Returns an unmodifiable list of all entries in this queue.
      Returns:
      list of entries

    • entries

      List<ReplicationQueue.Entry> entries(String path)
      Returns an unmodifiable list of entries for the given path.
      Parameters:
      path - replication path
      Returns:
      list of entries

    • getEntry

      ReplicationQueue.Entry getEntry(String path, Calendar after)
      Returns the entry that matches the given path and was scheduled after the given time.
      Parameters:
      path - the path
      after - the schedule time or null
      Returns:
      the entry or null

    • clear

      void clear()
      Clears this queue

    • clear

      void clear(Set<String> ids)
      Clears the entries with the id's specified in the set. Note: this operation might change the sequence of replication events. especially then they depend on each other, eg: delete/create can result in unexpected behaviours.
      Parameters:
      ids - the ids of the entries to remove

    • isBlocked

      boolean isBlocked()
      Deprecated.
      since 5.4. use getStatus() instead
      Returns true if this queue is blocked by an undeliverable entry.
      Returns:
      true if blocked.

    • isPaused

      boolean isPaused()
      Returns true if this queue is paused.
      Returns:
      true if paused.
      Since:
      5.4

    • setPaused

      void setPaused(boolean paused)
      Controls if this queue should be paused. Please note that the "paused" state is not persisted (yet), i.e. will be in running state after a restart.
      Parameters:
      paused - true to pause
      Since:
      5.4

    • lastProcessTime

      long lastProcessTime()
      Deprecated.
      since 5.4. use getStatus() instead
      Returns the time when the last entry was processed.
      Returns:
      the last process time (in ms).

    • nextRetryPeriod

      long nextRetryPeriod()
      Deprecated.
      since 5.4. use getStatus() instead
      Returns the time period (in milliseconds) when the next retry is performed. this only returns a valid time if the queue is blocked.
      Returns:
      the time for next retry

    • getStatus

      ReplicationQueue.Status getStatus()
      Returns the queue status
      Returns:
      the queue status
      Since:
      5.4

    • forceRetry

      void forceRetry()
      Forces a retry attempt on a blocked entry. this has only an effect, if the queue is blocked.