|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.orbeon.oxf.pipeline.api.PipelineContext
public class PipelineContext
PipelineContext represents a context object passed to all the processors running in a given pipeline session.
Nested Class Summary | |
---|---|
static interface |
PipelineContext.ContextListener
ContextListener interface to listen on PipelineContext events. |
static class |
PipelineContext.ContextListenerAdapter
ContextListener adapter class to facilitate implementations of the ContextListener interface. |
static interface |
PipelineContext.Trace
|
Field Summary | |
---|---|
static String |
EXTERNAL_CONTEXT
Key name for the EXTERNAL_CONTEXT attribute of type ExternalContext. |
Constructor Summary | |
---|---|
PipelineContext()
Create a new pipeline context. |
Method Summary | |
---|---|
void |
addContextListener(PipelineContext.ContextListener listener)
Add a new listener to the context. |
void |
destroy(boolean success)
Destroy the pipeline context. |
Object |
getAttribute(Object key)
Get an attribute in the context. |
PipelineContext.Trace |
getTraceForUpdate()
Return the trace for update if available. |
boolean |
isDestroyed()
Check whether this context has been destroyed. |
void |
setAttribute(Object key,
Object o)
Set an attribute in the context. |
boolean |
startTrace(String propertyName)
Start a trace using the class from the given global property name if present. |
void |
stopTrace()
Stop the trace for the remaining duration of this context. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String EXTERNAL_CONTEXT
Constructor Detail |
---|
public PipelineContext()
Method Detail |
---|
public boolean startTrace(String propertyName)
propertyName
- property name containing a class name
public void stopTrace()
public PipelineContext.Trace getTraceForUpdate()
public void setAttribute(Object key, Object o)
key
- the attribute keyo
- the attribute value to associate with the keypublic Object getAttribute(Object key)
key
- the attribute key
public void addContextListener(PipelineContext.ContextListener listener)
listener
- listener to addpublic void destroy(boolean success)
success
- true if the pipeline executed without exceptions, false otherwisepublic boolean isDestroyed()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |