Package com.adobe.acs.commons.replication.dispatcher

Interface DispatcherFlusher

@ConsumerType public interface DispatcherFlusher
Service used to issue Dispatcher Flush requests.

Consumers may override the ACS AEM Commons implementation (which is at service.ranking=-10000).

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<com.day.cq.replication.Agent,com.day.cq.replication.ReplicationResult>
    flush(org.apache.sling.api.resource.ResourceResolver resourceResolver, com.day.cq.replication.ReplicationActionType actionType, boolean synchronous, com.day.cq.replication.AgentFilter agentFilter, String... paths)
    Issue flush replication request.
    Map<com.day.cq.replication.Agent,com.day.cq.replication.ReplicationResult>
    flush(org.apache.sling.api.resource.ResourceResolver resourceResolver, com.day.cq.replication.ReplicationActionType actionType, boolean synchronous, String... paths)
    Issue flush replication request.
    Map<com.day.cq.replication.Agent,com.day.cq.replication.ReplicationResult>
    flush(org.apache.sling.api.resource.ResourceResolver resourceResolver, String... paths)
    Issue flush replication request.
    com.day.cq.replication.Agent[]
    getAgents(com.day.cq.replication.AgentFilter agentFilter)
    Get Replication Agents targeted by the provided AgentFilter.
    com.day.cq.replication.Agent[]
    getFlushAgents()
    Get Replication Agents targeted by this service.

  • Method Details

    • flush

      Map<com.day.cq.replication.Agent,com.day.cq.replication.ReplicationResult> flush(org.apache.sling.api.resource.ResourceResolver resourceResolver, String... paths) throws com.day.cq.replication.ReplicationException
      Issue flush replication request.
      Parameters:
      resourceResolver - access into repository; Must have access to the resources to flush
      paths - list of resources to flush
      Returns:
      a map of the targeted flush agents and the result of the replication request
      Throws:
      com.day.cq.replication.ReplicationException

    • flush

      Map<com.day.cq.replication.Agent,com.day.cq.replication.ReplicationResult> flush(org.apache.sling.api.resource.ResourceResolver resourceResolver, com.day.cq.replication.ReplicationActionType actionType, boolean synchronous, String... paths) throws com.day.cq.replication.ReplicationException
      Issue flush replication request.
      Parameters:
      resourceResolver - access into repository; Must have access to the resources to flush
      actionType - specifies the Replication Type that will be associated with the flush requests (ex. Activate, Deactivate, Delete)
      synchronous - specifies if the Replication Request should be synchronous or asynchronous
      paths - list of resources to flush
      Returns:
      a map of the targeted flush agents and the result of the replication request
      Throws:
      com.day.cq.replication.ReplicationException

    • flush

      Map<com.day.cq.replication.Agent,com.day.cq.replication.ReplicationResult> flush(org.apache.sling.api.resource.ResourceResolver resourceResolver, com.day.cq.replication.ReplicationActionType actionType, boolean synchronous, com.day.cq.replication.AgentFilter agentFilter, String... paths) throws com.day.cq.replication.ReplicationException
      Issue flush replication request.
      Parameters:
      resourceResolver - access into repository; Must have access to the resources to flush
      actionType - specifies the Replication Type that will be associated with the flush requests (ex. Activate, Deactivate, Delete)
      synchronous - specifies if the Replication Request should be synchronous or asynchronous
      agentFilter - filter used to specify agents to flush
      paths - list of resources to flush
      Returns:
      a map of the targeted flush agents and the result of the replication request
      Throws:
      com.day.cq.replication.ReplicationException

    • getFlushAgents

      com.day.cq.replication.Agent[] getFlushAgents()
      Get Replication Agents targeted by this service.
      Returns:
      a list of Replication Agents that will be targeted by this service

    • getAgents

      com.day.cq.replication.Agent[] getAgents(com.day.cq.replication.AgentFilter agentFilter)
      Get Replication Agents targeted by the provided AgentFilter.
      Parameters:
      agentFilter - filter used to specify agents to flush
      Returns:
      a list of Replication Agents that will be targeted provided AgentFilter