@ProviderType
public interface PipeBuilder
Modifier and Type | Method and Description |
---|---|
PipeBuilder |
$(String expr)
attach a sling query find pipe to the current context
|
PipeBuilder |
acls()
attach an ACL pipe to the current context
|
PipeBuilder |
allow(String expr)
attach an ACL pipe to the current context and sets allow acls on the resource
|
PipeBuilder |
auth(Object... conf)
attach an authorizable pipe to the current context
|
PipeBuilder |
bindings(Object... bindings)
Adds binding to current pipe
|
Pipe |
build()
builds a configured pipe.
|
Pipe |
build(String path)
builds a configured pipe.
|
PipeBuilder |
children(String expr)
attach a sling query children pipe to the current context
|
PipeBuilder |
closest(String expr)
attach a sling query closest pipe to the current context
|
PipeBuilder |
conf(Object... properties)
Building up a set of configurations for the current pipe
|
PipeBuilder |
csv(String expr)
attach a csv pipe to the current context
|
PipeBuilder |
deny(String expr)
attach an ACL pipe to the current context and sets deny acls on the resource
|
PipeBuilder |
echo(String path)
attach a base pipe to the current context
|
PipeBuilder |
egrep(String expr)
attach a Regexp pipe to the current context
|
PipeBuilder |
expr(String value)
set an expr configuration to the current pipe in the context
|
PipeBuilder |
grep(Object... conf)
attach a filter pipe to the current context
|
PipeBuilder |
json(String expr)
attach a json pipe to the current context
|
PipeBuilder |
mkdir(String expr)
Attach a path pipe to the current context
|
PipeBuilder |
mp()
attach a MULTI value property pipe to the current context
|
PipeBuilder |
mv(String expr)
attach a move pipe to the current context
|
PipeBuilder |
name(String name)
sets a pipe name, important in case you want to reuse it in another expression
|
PipeBuilder |
not(String expr)
attach a not pipe to the current context
|
PipeBuilder |
outputs(String... keys)
add outputs passed key
|
PipeBuilder |
parent()
attach a sling query parent pipe to the current context
|
PipeBuilder |
parents(String expr)
attach a sling query parents pipe to the current context
|
PipeBuilder |
path(String value)
set a path configuration to the current pipe in the context
|
PipeBuilder |
pipe(String type)
attach a new pipe to the current context
|
PipeBuilder |
pkg(String expr)
attach a package pipe, in filter collection mode as default
|
PipeBuilder |
ref(String expr)
attach a reference pipe to the current context
|
PipeBuilder |
rm()
attach a rm pipe to the current context
|
ExecutionResult |
run()
builds and run configured pipe
|
ExecutionResult |
run(Map<String,Object> bindings)
allow execution of a pipe, with more parameter
|
org.apache.sling.event.jobs.Job |
runAsync(Map<String,Object> bindings)
run a pipe asynchronously
|
ExecutionResult |
runParallel(int numThreads,
Map<String,Object> bindings)
run referenced pipes in parallel
|
ExecutionResult |
runWith(Object... bindings)
allow execution of a pipe, with more parameter
|
PipeBuilder |
shallowRef(String expr)
attach a shallow reference pipe to the current context
|
PipeBuilder |
siblings(String expr)
attach a sling query siblings pipe to the current context
|
PipeBuilder |
traverse()
attach a traverse pipe to the current context
|
PipeBuilder |
with(Object... params)
parameterized current pipe in the context
|
PipeBuilder |
withStrings(String... params)
parameterized current pipe in the context
|
PipeBuilder |
write(Object... conf)
attach a write pipe to the current context
|
PipeBuilder |
xpath(String expr)
attach a xpath pipe to the current context
|
PipeBuilder pipe(String type)
type
- resource type (should be registered by the plumber)PipeBuilder mv(String expr)
expr
- target of the resource to movePipeBuilder write(Object... conf) throws IllegalAccessException
conf
- configuration parametersIllegalAccessException
- in case it's called with bad configurationPipeBuilder grep(Object... conf) throws IllegalAccessException
conf
- configuration parametersIllegalAccessException
- in case it's called with bad configurationPipeBuilder auth(Object... conf) throws IllegalAccessException
conf
- configuration key value pairs for authorizable (see pipe's doc)IllegalAccessException
- in case it's called with bad configurationPipeBuilder xpath(String expr)
expr
- xpath expressionPipeBuilder children(String expr)
expr
- sling query expressionPipeBuilder siblings(String expr)
expr
- sling query expressionPipeBuilder rm()
PipeBuilder csv(String expr)
expr
- csv expr or URL or path in the resource treePipeBuilder json(String expr)
expr
- json expr or URL or path in the resource treePipeBuilder egrep(String expr)
expr
- text expr or URL or path in the resource treePipeBuilder mkdir(String expr)
expr
- path to createPipeBuilder echo(String path)
path
- pipe pathPipeBuilder traverse()
PipeBuilder parent()
PipeBuilder parents(String expr)
expr
- expressionPipeBuilder closest(String expr)
expr
- expressionPipeBuilder $(String expr)
expr
- expressionPipeBuilder ref(String expr)
expr
- referencePipeBuilder shallowRef(String expr)
expr
- referencePipeBuilder pkg(String expr)
expr
- path of the pipePipeBuilder not(String expr)
expr
- referencePipeBuilder mp()
PipeBuilder acls() throws IllegalAccessException
IllegalAccessException
- in case it's called with bad configurationPipeBuilder allow(String expr) throws IllegalAccessException
expr
- prinicipalName/AuthorizableId of the user to give allow privileges toIllegalAccessException
- in case it's called with bad configurationPipeBuilder deny(String expr) throws IllegalAccessException
expr
- prinicipalName/AuthorizableId of the user/group to give deny privileges toIllegalAccessException
- in case it's called with bad configurationPipeBuilder with(Object... params) throws IllegalAccessException
params
- key value pair of parametersIllegalAccessException
- in case it's called with wrong # of argumentsPipeBuilder withStrings(String... params)
params
- key value pair of parametersIllegalAccessException
- in case it's called with wrong # of argumentsPipeBuilder expr(String value) throws IllegalAccessException
value
- expression valueIllegalAccessException
- in case it's called in a bad timePipeBuilder name(String name) throws IllegalAccessException
name
- to overwrite default binding name (otherwise it will be "one", "two", ...)IllegalAccessException
- in case it's called before a pipe is configuredPipeBuilder path(String value) throws IllegalAccessException
value
- path valueIllegalAccessException
- in case it's called before a pipe is configuredPipeBuilder conf(Object... properties) throws IllegalAccessException
properties
- configuration key value pairs (must be an even number of arguments)IllegalAccessException
- in case it's called in a bad timePipeBuilder bindings(Object... bindings) throws IllegalAccessException
bindings
- bindings key valueIllegalAccessException
PipeBuilder outputs(String... keys)
keys
- properties of the outputs resource to outputPipe build() throws org.apache.sling.api.resource.PersistenceException
/var/pipes
org.apache.sling.api.resource.PersistenceException
- error occuring when saving the pipe configurationPipe build(String path) throws org.apache.sling.api.resource.PersistenceException
path
path
- path under which the generated configuration should be storedorg.apache.sling.api.resource.PersistenceException
- error occuring when saving the pipe configurationExecutionResult run()
ExecutionResult run(Map<String,Object> bindings)
bindings
- additional bindingsExecutionResult runWith(Object... bindings)
bindings
- additional bindings, should be key/value formatorg.apache.sling.event.jobs.Job runAsync(Map<String,Object> bindings) throws org.apache.sling.api.resource.PersistenceException
bindings
- additional bindings for the execution (can be null)org.apache.sling.api.resource.PersistenceException
- in case something goes wrong in the job creationExecutionResult runParallel(int numThreads, Map<String,Object> bindings)
numThreads
- number of threads to use for running the contained pipesbindings
- additional bindings for the execution (can be null)Copyright © 2007–2022 The Apache Software Foundation. All rights reserved.