org.apache.sling.distribution

Interface DistributionRequest

All Known Implementing Classes:

SimpleDistributionRequest

@ProviderType
public interface DistributionRequest

A DistributionRequest represents the need from the caller to have some content being distributed from a source instance to a target instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getFilters(java.lang.String path) Get the filters applicable for a specific path +/foo/.* - include all content under /foo -/foo - exclude /foo node filters are checked in order and the last matched filter determines inclusion/exclusion
java.lang.String[]	getPaths() Get the root paths for this distribution request
DistributionRequestType	getRequestType() Get the DistributionRequestType associated with this request
boolean	isDeep(java.lang.String path) Returns whether the paths are covering the entire subtree (deep) or just the specified nodes (shallow)

Method Detail

getRequestType

@Nonnull
DistributionRequestType getRequestType()

Get the DistributionRequestType associated with this request

Returns:

the type of the request as a DistributionRequestType

getPaths

@Nonnull
java.lang.String[] getPaths()

Get the root paths for this distribution request

Returns:

an array of paths

isDeep

boolean isDeep(@Nonnull
               java.lang.String path)

Returns whether the paths are covering the entire subtree (deep) or just the specified nodes (shallow)

Parameters:

path - the path to be checked

Returns:

true if the paths are deep

getFilters

@Nonnull
java.lang.String[] getFilters(java.lang.String path)

Get the filters applicable for a specific path +/foo/.* - include all content under /foo -/foo - exclude /foo node filters are checked in order and the last matched filter determines inclusion/exclusion

Returns:

an array of filters