Package org.apache.sling.distribution

Class SimpleDistributionRequest

java.lang.Object

org.apache.sling.distribution.SimpleDistributionRequest

All Implemented Interfaces:

DistributionRequest

public final class SimpleDistributionRequest
extends Object
implements DistributionRequest

A SimpleDistributionRequest is a DistributionRequest where all paths are either "deep" or "shallow".

Constructor Summary

Constructors

Constructor	Description
SimpleDistributionRequest(@NotNull DistributionRequestType requestType, boolean isDeep, @NotNull String... paths)	Creates distribution request with "deep" or "shallow" paths.
SimpleDistributionRequest(@NotNull DistributionRequestType requestType, @NotNull String... paths)	Creates a distribution request with "shallow" paths.
SimpleDistributionRequest(@NotNull DistributionRequestType requestType, @NotNull String[] paths, @NotNull Set<String> deepPaths)	Creates a distribution request with additional "deep" paths.
SimpleDistributionRequest(@NotNull DistributionRequestType requestType, @NotNull String[] paths, @NotNull Set<String> deepPaths, @NotNull Map<String,String[]> pathFilters)	Creates a distribution request with "deep" paths and filters.

Method Summary

Modifier and Type	Method	Description
@NotNull String[]	getFilters(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
String[]	getPaths()	get the paths for this distribution request
@NotNull DistributionRequestType	getRequestType()	get the DistributionRequestType associated with this request
boolean	isDeep(@NotNull String path)	Returns whether the a path is covering the entire subtree (deep) or just the specified nodes (shallow)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleDistributionRequest

public SimpleDistributionRequest(@NotNull
                                 @NotNull DistributionRequestType requestType,
                                 boolean isDeep,
                                 @NotNull
                                 @NotNull String... paths)

Creates distribution request with "deep" or "shallow" paths.

Parameters:

requestType - the request type

isDeep - is true if all paths are "deep" and is false if all paths are "shallow"

paths - the array of paths to be distributed

SimpleDistributionRequest

public SimpleDistributionRequest(@NotNull
                                 @NotNull DistributionRequestType requestType,
                                 @NotNull
                                 @NotNull String... paths)

Creates a distribution request with "shallow" paths.

Parameters:

requestType - the request type

paths - the array of paths to be distributed

SimpleDistributionRequest

public SimpleDistributionRequest(@NotNull
                                 @NotNull DistributionRequestType requestType,
                                 @NotNull
                                 @NotNull String[] paths,
                                 @NotNull
                                 @NotNull Set<String> deepPaths)

Creates a distribution request with additional "deep" paths.

Parameters:

requestType - the request type

paths - the array of paths to be distributed

deepPaths - the set of paths that are to be distributed in depth (with all their children)

SimpleDistributionRequest

public SimpleDistributionRequest(@NotNull
                                 @NotNull DistributionRequestType requestType,
                                 @NotNull
                                 @NotNull String[] paths,
                                 @NotNull
                                 @NotNull Set<String> deepPaths,
                                 @NotNull
                                 @NotNull Map<String,String[]> pathFilters)

Creates a distribution request with "deep" paths and filters.

Parameters:

requestType - the request type

paths - the array of paths to be distributed

deepPaths - the set of paths that are to be distributed in depth (with all their children)

pathFilters - the filters applicable for each path

Method Detail

getRequestType

@NotNull
public @NotNull DistributionRequestType getRequestType()

get the DistributionRequestType associated with this request

Specified by:

getRequestType in interface DistributionRequest

Returns:

the type of the request as a DistributionRequestType

getPaths

public String[] getPaths()

get the paths for this distribution request

Specified by:

getPaths in interface DistributionRequest

Returns:

an array of paths

isDeep

public boolean isDeep(@NotNull
                      @NotNull String path)

Returns whether the a path is covering the entire subtree (deep) or just the specified nodes (shallow)

Specified by:

isDeep in interface DistributionRequest

Parameters:

path - the path to be checked

Returns:

true if the path is deep

getFilters

@NotNull
public @NotNull String[] getFilters(String path)

Description copied from interface: DistributionRequest

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

Specified by:

getFilters in interface DistributionRequest

Parameters:

path - the path to get applicable filters for

Returns:

an array of filters

toString

public String toString()

Overrides:

toString in class Object