@ConsumerType
public interface Pipe
Modifier and Type | Field and Description |
---|---|
static String |
NN_CONF
Node name for the pipe's configuration
|
static String |
PN_DISTRIBUTION_AGENT
Distribution agent (for distributing output resources)
|
static String |
PN_EXPR
expression of the pipe, usage depends on the pipe implementation
|
static String |
PN_NAME
Name of the pipe
|
static String |
PN_PATH
resource's path associated to the path, usage depends on the pipe implementation
|
Modifier and Type | Method and Description |
---|---|
void |
after()
to be executed before output is retrieved
|
void |
before()
to be executed before output is retrieved
|
PipeBindings |
getBindings()
returns the pipe's bindings
|
String |
getDistributionAgent()
Get Distribution agent
|
org.apache.sling.api.resource.Resource |
getInput()
Get pipe current's resource *before* next execution, meaning either the
configured resource, either previous' pipe output resource
|
String |
getName()
Return the name of that pipe
|
Iterator<org.apache.sling.api.resource.Resource> |
getOutput()
Executes the pipe, can be contained in a parent or not
|
Object |
getOutputBinding()
returns the binding output used in container pipe's expression
|
SuperPipe |
getParent() |
org.apache.sling.api.resource.Resource |
getResource()
get the pipe configuration resource
|
boolean |
isDryRun()
returns true if that pipe is set not to write content
|
boolean |
modifiesContent()
returns true if that pipe modifies content during its execution
|
void |
setParent(SuperPipe pipe)
sets the parent pipe this pipe is referred by
|
static final String PN_NAME
static final String PN_EXPR
static final String PN_PATH
static final String NN_CONF
static final String PN_DISTRIBUTION_AGENT
boolean modifiesContent()
boolean isDryRun()
String getName()
void setParent(SuperPipe pipe)
pipe
- referrer that refers to this instanceSuperPipe getParent()
org.apache.sling.api.resource.Resource getInput() throws ScriptException
ScriptException
- in case computed input goes wrongorg.apache.sling.api.resource.Resource getResource()
Object getOutputBinding()
PipeBindings getBindings()
Iterator<org.apache.sling.api.resource.Resource> getOutput()
void before() throws Exception
Exception
- in case anything goes wrongvoid after() throws Exception
Exception
- in case anything goes wrongString getDistributionAgent()
Copyright © 2007–2019 The Apache Software Foundation. All rights reserved.