com.day.cq.replication

Interface ReplicationContentFilter

public interface ReplicationContentFilter

Implementations of ReplicationContentFilter indicate to ContentBuilders whether a given child Node of a node being activated (e.g. a page or asset) shall be included in the replication content or not. Implementations must be instantiated by their respective ReplicationContentFilterFactory, the factory registering itself as an OSGi service. For convenience a ReplicationContentFilterChain is provided to content builders via the parameter ContentBuilder.PARAMETER_CONTENT_FILER_CHAIN.

Method Summary

Modifier and Type	Method and Description
boolean	accepts(Node node) Indicates whether the given Node is to be included in the content of the replication built by ContentBuilders.
boolean	accepts(Property property) Indicates whether the given Property is to be included in the content of the replication built by ContentBuilders.
boolean	allowsDescent(Node node) Indicates whether the ContentBuilders may descend / traverse the children of the given node for inclusion in the replication content.
java.util.List<java.lang.String>	getFilteredPaths() Get the List of paths that have been filtered by this filter.

Method Detail

accepts

boolean accepts(Node node)

Indicates whether the given Node is to be included in the content of the replication built by ContentBuilders.

Parameters:

node - The Node to check.

Returns:

true if this node may be included in the replication content.

accepts

boolean accepts(Property property)

Indicates whether the given Property is to be included in the content of the replication built by ContentBuilders.

Parameters:

property - The Property to check.

Returns:

true if this property may be included in the replication content.

allowsDescent

boolean allowsDescent(Node node)

Indicates whether the ContentBuilders may descend / traverse the children of the given node for inclusion in the replication content. If this returns false, the given node itself and its properties are still included in the replication content (if returns true and properties are accepted via {@link #accepts(javax.jcr.Property)}.

Parameters:

node - The Node to check.

Returns:

true if the content builder may traverse the children of the given node, false otherwise.

getFilteredPaths

java.util.List<java.lang.String> getFilteredPaths()

Get the List of paths that have been filtered by this filter.

Returns:

a List of Strings representing the filtered paths or null if this is not supported.