Uses of Interface
org.apache.cocoon.environment.Environment

Packages that use Environment
org.apache.cocoon   
org.apache.cocoon.ant   
org.apache.cocoon.components   
org.apache.cocoon.components.pipeline   
org.apache.cocoon.components.pipeline.impl   
org.apache.cocoon.components.profiler   
org.apache.cocoon.components.source   
org.apache.cocoon.components.source.impl   
org.apache.cocoon.components.treeprocessor Evaluation tree based implementation of the Processor interface  
org.apache.cocoon.components.treeprocessor.sitemap Implemention of the Sitemap language  
org.apache.cocoon.environment   
org.apache.cocoon.environment.background   
org.apache.cocoon.environment.commandline   
org.apache.cocoon.environment.http   
org.apache.cocoon.environment.portlet   
org.apache.cocoon.environment.wrapper   
org.apache.cocoon.portlet   
org.apache.cocoon.servlet   
org.apache.cocoon.sitemap   
 

Uses of Environment in org.apache.cocoon
 

Methods in org.apache.cocoon with parameters of type Environment
 boolean ProcessorWrapper.process(Environment environment)
          Process the given Environment producing the output
 ProcessingPipeline ProcessorWrapper.buildPipeline(Environment environment)
          Process the given Environment to assemble a ProcessingPipeline.
 void RequestListener.onRequestStart(Environment environment)
          In this method you can call, for example: Request req=ObjectModelHelper.getRequest(env.getObjectModel()); And then, you could use the following: req.getRequestURI() req.getQueryString() req.getSession().getId() req.getLocale().getLanguage().toString()
 void RequestListener.onRequestEnd(Environment environment)
          This method is called when a request has completed.
 void RequestListener.onRequestException(Environment environment, Throwable throwable)
          This method is called when an exception has occurred processing the request.
 boolean Processor.process(Environment environment)
          Process the given Environment producing the output.
 ProcessingPipeline Processor.buildPipeline(Environment environment)
          Process the given Environment to assemble a ProcessingPipeline.
protected  void Cocoon.debug(Environment environment, boolean internal)
          Log debug information about the current environment.
 boolean Cocoon.process(Environment environment)
          Process the given Environment to produce the output.
 ProcessingPipeline Cocoon.buildPipeline(Environment environment)
          Process the given Environment to assemble a ProcessingPipeline.
 

Uses of Environment in org.apache.cocoon.ant
 

Classes in org.apache.cocoon.ant that implement Environment
 class DelayedFileSavingEnvironment
          A command line file saving environment writing files in a delayed mode.
 

Uses of Environment in org.apache.cocoon.components
 

Methods in org.apache.cocoon.components that return Environment
static Environment CocoonComponentManager.getCurrentEnvironment()
          Return the current environment (for the cocoon: protocol)
 

Methods in org.apache.cocoon.components with parameters of type Environment
static void CocoonComponentManager.enterEnvironment(Environment env, ComponentManager manager, Processor processor)
          This hook must be called by the sitemap each time a sitemap is entered This method should never raise an exception, except when the parameters are not set!
static Object CocoonComponentManager.startProcessing(Environment env)
          This hook has to be called before a request is processed.
static void CocoonComponentManager.endProcessing(Environment env, Object key)
          This hook has to be called before a request is processed.
static Processor CocoonComponentManager.getLastProcessor(Environment env)
          Return the processor that is actually processing the request
 

Uses of Environment in org.apache.cocoon.components.pipeline
 

Methods in org.apache.cocoon.components.pipeline with parameters of type Environment
protected  void AbstractProcessingPipeline.setupPipeline(Environment environment)
          Setup pipeline components.
protected  void AbstractProcessingPipeline.connect(Environment environment, XMLProducer producer, XMLConsumer consumer)
          Connect the next component
protected  void AbstractProcessingPipeline.connectPipeline(Environment environment)
          Connect the XML pipeline.
 boolean AbstractProcessingPipeline.process(Environment environment)
          Process the given Environment, producing the output.
protected  void AbstractProcessingPipeline.preparePipeline(Environment environment)
          Prepare the pipeline
 void AbstractProcessingPipeline.prepareInternal(Environment environment)
          Prepare an internal processing
protected  boolean AbstractProcessingPipeline.processXMLPipeline(Environment environment)
          Process the SAX event pipeline
protected  void AbstractProcessingPipeline.setupReader(Environment environment)
          Setup the reader
protected  boolean AbstractProcessingPipeline.checkIfModified(Environment environment, long lastModified)
           
protected  boolean AbstractProcessingPipeline.processReader(Environment environment)
          Process the pipeline using a reader.
 boolean AbstractProcessingPipeline.process(Environment environment, XMLConsumer consumer)
          Process the given Environment, but do not use the serializer.
 boolean ProcessingPipeline.process(Environment environment)
          Process the given Environment, producing the output.
 void ProcessingPipeline.prepareInternal(Environment environment)
          Prepare an internal processing
 boolean ProcessingPipeline.process(Environment environment, XMLConsumer consumer)
          Process the given Environment, but do not use the serializer.
 

Uses of Environment in org.apache.cocoon.components.pipeline.impl
 

Methods in org.apache.cocoon.components.pipeline.impl with parameters of type Environment
protected  void CachingProcessingPipeline.cacheResults(Environment environment, OutputStream os)
          Cache longest cacheable key
protected  void CachingProcessingPipeline.connectCachingPipeline(Environment environment)
          Connect the pipeline.
protected  void CachingPointProcessingPipeline.cacheResults(Environment environment, OutputStream os)
          Cache longest cacheable path plus cache points.
protected  void CachingPointProcessingPipeline.connectCachingPipeline(Environment environment)
          Connect the caching point pipeline.
protected abstract  void AbstractCachingProcessingPipeline.cacheResults(Environment environment, OutputStream os)
          Abstract methods defined in subclasses
protected abstract  void AbstractCachingProcessingPipeline.connectCachingPipeline(Environment environment)
           
protected  boolean AbstractCachingProcessingPipeline.processXMLPipeline(Environment environment)
          Process the given Environment, producing the output.
protected  void AbstractCachingProcessingPipeline.generateCachingKey(Environment environment)
          The components of the pipeline are checked if they are Cacheable.
protected  void AbstractCachingProcessingPipeline.validatePipeline(Environment environment)
          Calculate the key that can be used to get something from the cache, and handle expires properly.
protected  void AbstractCachingProcessingPipeline.setupPipeline(Environment environment)
          Setup the evenet pipeline.
protected  void AbstractCachingProcessingPipeline.connectPipeline(Environment environment)
          Connect the pipeline.
protected  boolean AbstractCachingProcessingPipeline.processReader(Environment environment)
          Process the pipeline using a reader.
protected  boolean ExpiresCachingProcessingPipeline.processXMLPipeline(Environment environment)
          Process the given Environment, producing the output.
protected  void ExpiresCachingProcessingPipeline.connectPipeline(Environment environment)
          Connect the XML pipeline.
protected  void ExpiresCachingProcessingPipeline.preparePipeline(Environment environment)
          Prepare the pipeline
protected  boolean ExpiresCachingProcessingPipeline.processReader(Environment environment)
           
 

Uses of Environment in org.apache.cocoon.components.profiler
 

Methods in org.apache.cocoon.components.profiler with parameters of type Environment
protected  void ProfilingNonCachingProcessingPipeline.setupPipeline(Environment environment)
          Setup pipeline components.
 boolean ProfilingNonCachingProcessingPipeline.process(Environment environment)
          Process the given Environment, producing the output.
protected  boolean ProfilingNonCachingProcessingPipeline.processXMLPipeline(Environment environment)
          Process the SAX event pipeline
protected  boolean ProfilingNonCachingProcessingPipeline.processReader(Environment environment)
          Process the pipeline using a reader.
protected  void ProfilingNonCachingProcessingPipeline.connect(Environment environment, XMLProducer producer, XMLConsumer consumer)
          Connect the next component
protected  void ProfilingCachingProcessingPipeline.setupPipeline(Environment environment)
          Setup pipeline components.
 boolean ProfilingCachingProcessingPipeline.process(Environment environment)
          Process the given Environment, producing the output.
protected  boolean ProfilingCachingProcessingPipeline.processXMLPipeline(Environment environment)
          Process the SAX event pipeline
protected  boolean ProfilingCachingProcessingPipeline.processReader(Environment environment)
          Process the pipeline using a reader.
protected  void ProfilingCachingProcessingPipeline.connect(Environment environment, XMLProducer producer, XMLConsumer consumer)
          Connect the next component
 

Constructors in org.apache.cocoon.components.profiler with parameters of type Environment
EnvironmentInfo(Environment environment)
           
 

Uses of Environment in org.apache.cocoon.components.source
 

Methods in org.apache.cocoon.components.source with parameters of type Environment
 Source SourceHandlerImpl.getSource(Environment environment, String location)
          Deprecated. Get a Source object.
 Source SourceHandlerImpl.getSource(Environment environment, URL base, String location)
          Deprecated. Get a Source object.
 Source SourceHandler.getSource(Environment environment, String location)
          Deprecated. Get a Source object.
 Source SourceHandler.getSource(Environment environment, URL base, String location)
          Deprecated. Get a Source object.
 Source SourceFactory.getSource(Environment environment, String location)
          Deprecated. Get a Source object.
 Source SourceFactory.getSource(Environment environment, URL base, String location)
          Deprecated. Get a Source object.
 Source FileSourceFactory.getSource(Environment environment, String location)
          Deprecated.  
 Source FileSourceFactory.getSource(Environment environment, URL base, String location)
          Deprecated.  
 Source CocoonSourceFactory.getSource(Environment environment, String location)
          Resolve the source
 Source CocoonSourceFactory.getSource(Environment environment, URL base, String location)
          Resolve the source
 

Constructors in org.apache.cocoon.components.source with parameters of type Environment
AbstractSAXSource(Environment environment, ComponentManager manager, Logger logger)
          Deprecated. The constructor.
 

Uses of Environment in org.apache.cocoon.components.source.impl
 

Fields in org.apache.cocoon.components.source.impl declared as Environment
protected  Environment AvalonToCocoonSourceInvocationHandler.environment
          The environment
protected  Environment AvalonToCocoonSource.environment
          The environment
 

Methods in org.apache.cocoon.components.source.impl with parameters of type Environment
static Source AvalonToCocoonSourceInvocationHandler.createProxy(Source source, SourceResolver resolver, Environment environment, ComponentManager manager)
          Creates a dynamic proxy for an excalibur Source object to make it behave like a cocoon Source.
 

Constructors in org.apache.cocoon.components.source.impl with parameters of type Environment
AvalonToCocoonSourceInvocationHandler(Source source, SourceResolver resolver, Environment environment, ComponentManager manager)
          Constructor
AvalonToCocoonSource(Source source, SourceResolver resolver, Environment environment, ComponentManager manager)
          Constructor
 

Uses of Environment in org.apache.cocoon.components.treeprocessor
 

Methods in org.apache.cocoon.components.treeprocessor with parameters of type Environment
 boolean NullNode.invoke(Environment env, InvokeContext context)
           
 boolean SimpleParentProcessingNode.invoke(Environment env, InvokeContext context)
          Define common invoke behavior here
 boolean ContainerNode.invoke(Environment env, InvokeContext context)
           
 boolean CategoryNode.invoke(Environment env, InvokeContext context)
           
 boolean CategoryNode.invokeByName(String name, Environment env, InvokeContext context)
           
 boolean TreeProcessor.process(Environment environment)
          Process the given Environment producing the output.
 ProcessingPipeline TreeProcessor.buildPipeline(Environment environment)
          Process the given Environment to assemble a ProcessingPipeline.
protected  boolean TreeProcessor.process(Environment environment, InvokeContext context)
          Do the actual processing, be it producing the response or just building the pipeline
protected  void TreeProcessor.setupRootNode(Environment env)
           
 boolean ProcessingNode.invoke(Environment env, InvokeContext context)
          Process environment.
protected  boolean AbstractParentProcessingNode.invokeNodes(ProcessingNode[] nodes, Environment env, InvokeContext context, String currentName, Map currentMap)
          Invoke all nodes of a node array in order, until one succeeds.
protected  boolean AbstractParentProcessingNode.invokeNodes(ProcessingNode[] nodes, Environment env, InvokeContext context)
          Invoke all nodes of a node array in order, until one succeeds.
 

Uses of Environment in org.apache.cocoon.components.treeprocessor.sitemap
 

Methods in org.apache.cocoon.components.treeprocessor.sitemap with parameters of type Environment
 boolean TransformNode.invoke(Environment env, InvokeContext context)
           
 boolean SwitchSelectNode.invoke(Environment env, InvokeContext context)
           
 boolean SerializeNode.invoke(Environment env, InvokeContext context)
           
 boolean SelectNode.invoke(Environment env, InvokeContext context)
           
 boolean ScriptNode.invoke(Environment env, InvokeContext context)
          This method should never be called by the TreeProcessor, since a element should not be in an "executable" sitemap node.
 boolean RedirectToURINode.invoke(Environment env, InvokeContext context)
           
 boolean ReadNode.invoke(Environment env, InvokeContext context)
           
 boolean PreparableMatchNode.invoke(Environment env, InvokeContext context)
           
static Redirector PipelinesNode.getRedirector(Environment env)
           
 boolean PipelinesNode.invoke(Environment env, InvokeContext context)
          Process the environment.
 boolean PipelineNode.invoke(Environment env, InvokeContext context)
           
 boolean MountNode.invoke(Environment env, InvokeContext context)
           
 boolean MatchNode.invoke(Environment env, InvokeContext context)
           
 boolean HandleErrorsNode.invoke(Environment env, InvokeContext context)
           
 boolean GenerateNode.invoke(Environment env, InvokeContext context)
           
 boolean FlowNode.invoke(Environment env, InvokeContext context)
          This method should never be called by the TreeProcessor, since a <map:flow> element should not be in an "executable" sitemap node.
 boolean ErrorHandlerHelper.invokeErrorHandler(ProcessingNode node, Exception ex, Environment env)
           
 boolean ContinueNode.invoke(Environment env, InvokeContext context)
           
 boolean CallNode.invoke(Environment env, InvokeContext context)
           
 boolean CallFunctionNode.invoke(Environment env, InvokeContext context)
           
 boolean AggregateNode.invoke(Environment env, InvokeContext context)
           
 boolean ActTypeNode.invoke(Environment env, InvokeContext context)
           
 boolean ActionSetNode.invoke(Environment env, InvokeContext context)
           
 Map ActionSetNode.call(Environment env, InvokeContext context, Parameters params)
          Call the actions composing the action-set and return the combined result of these actions.
 boolean ActSetNode.invoke(Environment env, InvokeContext context)
           
 

Uses of Environment in org.apache.cocoon.environment
 

Classes in org.apache.cocoon.environment that implement Environment
 class AbstractEnvironment
          Base class for any environment
 

Fields in org.apache.cocoon.environment declared as Environment
protected  Environment ForwardRedirector.env
          The Environment to use for redirection (either internal or external)
 

Constructors in org.apache.cocoon.environment with parameters of type Environment
ForwardRedirector(Environment env)
           
 

Uses of Environment in org.apache.cocoon.environment.background
 

Classes in org.apache.cocoon.environment.background that implement Environment
 class BackgroundEnvironment
          A simple implementation of org.apache.cocoon.environment.Environment for pipeline calls which are not externally triggered.
 

Methods in org.apache.cocoon.environment.background with parameters of type Environment
 boolean BackgroundEnvironment.NullProcessor.process(Environment environment)
           
 ProcessingPipeline BackgroundEnvironment.NullProcessor.buildPipeline(Environment environment)
           
 

Uses of Environment in org.apache.cocoon.environment.commandline
 

Classes in org.apache.cocoon.environment.commandline that implement Environment
 class AbstractCommandLineEnvironment
          This environment is used to save the requested file to disk.
 class FileSavingEnvironment
          This environment is used to save the requested file to disk.
 class LinkSamplingEnvironment
          This environment is sample the links of the resource.
 

Constructors in org.apache.cocoon.environment.commandline with parameters of type Environment
CommandLineRequest(Environment env, String contextPath, String servletPath, String pathInfo)
           
CommandLineRequest(Environment env, String contextPath, String servletPath, String pathInfo, Map attributes)
           
CommandLineRequest(Environment env, String contextPath, String servletPath, String pathInfo, Map attributes, Map parameters)
           
CommandLineRequest(Environment env, String contextPath, String servletPath, String pathInfo, Map attributes, Map parameters, Map headers)
           
 

Uses of Environment in org.apache.cocoon.environment.http
 

Classes in org.apache.cocoon.environment.http that implement Environment
 class HttpEnvironment
           
 

Uses of Environment in org.apache.cocoon.environment.portlet
 

Classes in org.apache.cocoon.environment.portlet that implement Environment
 class PortletEnvironment
          Implements Environment interface for the JSR-168 Portlet environment.
 

Uses of Environment in org.apache.cocoon.environment.wrapper
 

Classes in org.apache.cocoon.environment.wrapper that implement Environment
 class EnvironmentWrapper
          This is a wrapper class for the Environment object.
 class MutableEnvironmentFacade
          Enviroment facade, whose delegate object can be changed.
 

Fields in org.apache.cocoon.environment.wrapper declared as Environment
protected  Environment EnvironmentWrapper.environment
          The wrapped environment
 

Constructors in org.apache.cocoon.environment.wrapper with parameters of type Environment
RequestWrapper(Request request, String requestURI, String queryString, Environment env)
          Constructor
RequestWrapper(Request request, String requestURI, String queryString, Environment env, boolean rawMode)
          Constructor
EnvironmentWrapper(Environment env, String requestURI, String queryString, Logger logger)
          Constructs an EnvironmentWrapper object from a Request and Response objects
EnvironmentWrapper(Environment env, String requestURI, String queryString, Logger logger, boolean rawMode)
          Constructs an EnvironmentWrapper object from a Request and Response objects
EnvironmentWrapper(Environment env, String requestURI, String queryString, Logger logger, ComponentManager manager, boolean rawMode)
          Constructs an EnvironmentWrapper object from a Request and Response objects
EnvironmentWrapper(Environment env, String requestURI, String queryString, Logger logger, ComponentManager manager, boolean rawMode, String view)
          Constructs an EnvironmentWrapper object from a Request and Response objects
EnvironmentWrapper(Environment env, ComponentManager manager, String uri, Logger logger)
           
 

Uses of Environment in org.apache.cocoon.portlet
 

Methods in org.apache.cocoon.portlet that return Environment
protected  Environment CocoonPortlet.getEnvironment(String servletPath, String uri, javax.portlet.ActionRequest req, javax.portlet.ActionResponse res)
          Create the environment for the request
protected  Environment CocoonPortlet.getEnvironment(String servletPath, String uri, javax.portlet.RenderRequest req, javax.portlet.RenderResponse res)
          Create the environment for the request
 

Methods in org.apache.cocoon.portlet with parameters of type Environment
protected  void CocoonPortlet.manageException(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res, Environment env, String uri, String title, String message, String description, Exception e)
           
protected  void CocoonPortlet.manageException(javax.portlet.RenderRequest req, javax.portlet.RenderResponse res, Environment env, String uri, String title, String message, String description, Exception e)
           
 

Uses of Environment in org.apache.cocoon.servlet
 

Methods in org.apache.cocoon.servlet that return Environment
protected  Environment CocoonServlet.getEnvironment(String uri, HttpServletRequest req, HttpServletResponse res)
          Create the environment for the request
 

Methods in org.apache.cocoon.servlet with parameters of type Environment
protected  void CocoonServlet.manageException(HttpServletRequest req, HttpServletResponse res, Environment env, String uri, int errorStatus, String title, String message, String description, Exception e)
           
 

Uses of Environment in org.apache.cocoon.sitemap
 

Constructors in org.apache.cocoon.sitemap with parameters of type Environment
SitemapRedirector(Environment e)
          Deprecated. Constructor with environment--so redirection happens as expected
 



Copyright ⌐ 1999-2004 The Apache Software Foundation. All Rights Reserved.