org.apache.cocoon.components.treeprocessor
Class InvokeContext

java.lang.Object
  |
  +--org.apache.cocoon.components.treeprocessor.InvokeContext

All Implemented Interfaces:

org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.framework.component.Recomposable

public class InvokeContext

extends java.lang.Object

implements org.apache.avalon.framework.component.Recomposable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.logger.Loggable

The invocation context of ProcessingNodes.

This class serves two purposes :

• Avoid explicit enumeration of all needed parameters in ProcessingNode.invoke(Environment, InvokeContext), thus allowing easier addition of new parameters,
• Hold pipelines, and provide "just in time" lookup for them.

Version:

CVS $Id: InvokeContext.java,v 1.1.2.1 2002/04/23 16:11:32 sylvain Exp $

Author:

Sylvain Wallez

Constructor Summary

InvokeContext()
Create an InvokeContext without existing pipelines.

InvokeContext(StreamPipeline pipeline, EventPipeline eventPipeline)
Create an InvokeContext with existing pipelines.

Method Summary

void	compose(org.apache.avalon.framework.component.ComponentManager manager)
void	dispose() Release the pipelines, if any, if they were looked up by this context.
protected void	dumpParameters(java.util.List list) Dumps all sitemap parameters to log
EventPipeline	getEventPipeline() Get the EventPipeline.
java.util.List	getMapStack() Get the current Map stack used to resolve expressions.
StreamPipeline	getStreamPipeline() Get the StreamPipeline.
boolean	isInternalRequest() Is this an internal request ?
void	popMap() Pop the topmost element of the current Map stack.
void	pushMap(java.util.Map map) Push a Map on top of the current Map stack.
void	recompose(org.apache.avalon.framework.component.ComponentManager manager)
void	setLogger(org.apache.log.Logger logger)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InvokeContext

public InvokeContext()

Create an InvokeContext without existing pipelines. This also means the current request is external.

InvokeContext

public InvokeContext(StreamPipeline pipeline,
                     EventPipeline eventPipeline)

Create an InvokeContext with existing pipelines. This also means the current request is internal.

Method Detail

setLogger

public void setLogger(org.apache.log.Logger logger)

Specified by:

setLogger in interface org.apache.avalon.framework.logger.Loggable

compose

public void compose(org.apache.avalon.framework.component.ComponentManager manager)
             throws org.apache.avalon.framework.component.ComponentException

Specified by:

compose in interface org.apache.avalon.framework.component.Composable

recompose

public void recompose(org.apache.avalon.framework.component.ComponentManager manager)
               throws org.apache.avalon.framework.component.ComponentException

Specified by:

recompose in interface org.apache.avalon.framework.component.Recomposable

getEventPipeline

public final EventPipeline getEventPipeline()
                                     throws java.lang.Exception

Get the EventPipeline. If none already exists, a set of new pipelines is looked up.

getStreamPipeline

public final StreamPipeline getStreamPipeline()
                                       throws java.lang.Exception

Get the StreamPipeline. If none already exists, a set of new pipelines is looked up.

isInternalRequest

public final boolean isInternalRequest()

Is this an internal request ?

getMapStack

public final java.util.List getMapStack()

Get the current Map stack used to resolve expressions.

pushMap

public final void pushMap(java.util.Map map)

Push a Map on top of the current Map stack.

dumpParameters

protected void dumpParameters(java.util.List list)

Dumps all sitemap parameters to log

popMap

public final void popMap()

Pop the topmost element of the current Map stack.

dispose

public void dispose()

Release the pipelines, if any, if they were looked up by this context.

Specified by:

dispose in interface org.apache.avalon.framework.activity.Disposable