org.apache.sling.distribution

Class SimpleDistributionRequest

java.lang.Object

org.apache.sling.distribution.SimpleDistributionRequest

All Implemented Interfaces:

DistributionRequest

@ProviderType
public final class SimpleDistributionRequest
extends java.lang.Object
implements DistributionRequest

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

Constructor Summary

Constructors

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

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 paths for this distribution request
DistributionRequestType	getRequestType() get the DistributionRequestType associated with this request
boolean	isDeep(java.lang.String path) Returns whether the a path is covering the entire subtree (deep) or just the specified nodes (shallow)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleDistributionRequest

public SimpleDistributionRequest(@Nonnull
                                 DistributionRequestType requestType,
                                 boolean isDeep,
                                 @Nonnull
                                 java.lang.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(@Nonnull
                                 DistributionRequestType requestType,
                                 @Nonnull
                                 java.lang.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(@Nonnull
                                 DistributionRequestType requestType,
                                 @Nonnull
                                 java.lang.String[] paths,
                                 @Nonnull
                                 java.util.Set<java.lang.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(@Nonnull
                                 DistributionRequestType requestType,
                                 @Nonnull
                                 java.lang.String[] paths,
                                 @Nonnull
                                 java.util.Set<java.lang.String> deepPaths,
                                 @Nonnull
                                 java.util.Map<java.lang.String,java.lang.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

@Nonnull
public 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 java.lang.String[] getPaths()

get the paths for this distribution request

Specified by:

getPaths in interface DistributionRequest

Returns:

an array of paths

isDeep

public boolean isDeep(@Nonnull
                      java.lang.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

@Nonnull
public java.lang.String[] getFilters(java.lang.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

Returns:

an array of filters

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object