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

Class DispatcherFlushFilter

java.lang.Object

com.adobe.acs.commons.replication.dispatcher.DispatcherFlushFilter

All Implemented Interfaces:

com.day.cq.replication.AgentFilter

@ProviderType
public class DispatcherFlushFilter
extends Object
implements com.day.cq.replication.AgentFilter

Replication Agent Filter used to identify Flush agents.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DispatcherFlushFilter.FlushType	All: All Enablied Dispatcher Flush Agents.

Field Summary

Fields

Modifier and Type	Field	Description
static final DispatcherFlushFilter	ALL
static final DispatcherFlushFilter	HIERARCHICAL
static final DispatcherFlushFilter	RESOURCE_ONLY

Fields inherited from interface com.day.cq.replication.AgentFilter

DEFAULT, OUTBOX_AGENT_FILTER

Constructor Summary

Constructors

Constructor	Description
DispatcherFlushFilter()	Default constructor; Same as: new DispatcherFlushFilter(FlushType.All);.
DispatcherFlushFilter(DispatcherFlushFilter.FlushType flushType)	Targets a set of Dispatcher Flush agents based on the parameter flushType.

Method Summary

Modifier and Type	Method	Description
final DispatcherFlushFilter.FlushType	getFlushType()	Returns the Dispatcher FlushType this filter was created with.
final boolean	isIncluded(com.day.cq.replication.Agent agent)	Checks if the @agent is considered an active Flush agent (Serialization Type ~> Flush and is enabled).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ALL

public static final DispatcherFlushFilter ALL

HIERARCHICAL

public static final DispatcherFlushFilter HIERARCHICAL

RESOURCE_ONLY

public static final DispatcherFlushFilter RESOURCE_ONLY

Constructor Details

DispatcherFlushFilter

public DispatcherFlushFilter()

Default constructor; Same as: new DispatcherFlushFilter(FlushType.All);.

DispatcherFlushFilter

public DispatcherFlushFilter(DispatcherFlushFilter.FlushType flushType)

Targets a set of Dispatcher Flush agents based on the parameter flushType.

Parameters:

flushType - The type of Flush agents this Agent should target

Method Details

isIncluded

public final boolean isIncluded(com.day.cq.replication.Agent agent)

Checks if the @agent is considered an active Flush agent (Serialization Type ~> Flush and is enabled).

Specified by:

isIncluded in interface com.day.cq.replication.AgentFilter

Parameters:

agent - the agent to test test

Returns:

true is is considered an enabled Flush agent

getFlushType

public final DispatcherFlushFilter.FlushType getFlushType()

Returns the Dispatcher FlushType this filter was created with.

Returns:

this filter's dispatcher flushType