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

Packages that use Environment
org.apache.cocoon   
org.apache.cocoon.ant   
org.apache.cocoon.components.blocks   
org.apache.cocoon.components.pipeline   
org.apache.cocoon.components.pipeline.impl   
org.apache.cocoon.components.profiler   
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.core   
org.apache.cocoon.core.logging   
org.apache.cocoon.environment   
org.apache.cocoon.environment.background   
org.apache.cocoon.environment.commandline   
org.apache.cocoon.environment.http   
org.apache.cocoon.environment.internal   
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 Processor.process(Environment environment)
          Process the given Environment producing the output.
 Processor.InternalPipelineDescription 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)
           
 Processor.InternalPipelineDescription Cocoon.buildPipeline(Environment environment)
           
 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.
 

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.blocks
 

Methods in org.apache.cocoon.components.blocks with parameters of type Environment
 boolean BlocksManager.process(Environment environment)
           
 boolean BlockManager.process(Environment environment)
           
 Processor.InternalPipelineDescription BlockManager.buildPipeline(Environment environment)
           
 boolean BlockProcessor.process(Environment environment)
           
 Processor.InternalPipelineDescription BlockProcessor.buildPipeline(Environment environment)
           
 

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

Methods in org.apache.cocoon.components.pipeline with parameters of type Environment
 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.
protected  void VirtualProcessingPipeline.setupPipeline(Environment environment)
          Setup pipeline components.
protected  void VirtualProcessingPipeline.connect(Environment environment, XMLProducer producer, XMLConsumer consumer)
          Connect the next component
protected  void VirtualProcessingPipeline.connectPipeline(Environment environment)
          Connect the XML pipeline.
protected  void VirtualProcessingPipeline.preparePipeline(Environment environment)
          Prepare the pipeline
 void VirtualProcessingPipeline.prepareInternal(Environment environment)
          Prepare an internal processing
protected  void VirtualProcessingPipeline.prepareInternalErrorHandler(Environment environment, ProcessingException ex)
          If prepareInternal fails, prepare internal error handler.
 boolean VirtualProcessingPipeline.process(Environment environment)
           
 boolean VirtualProcessingPipeline.process(Environment environment, XMLConsumer consumer)
          Process the given Environment, but do not use the serializer.
 XMLConsumer VirtualProcessingPipeline.getXMLConsumer(Environment environment, XMLConsumer consumer)
          Get the first consumer - used for VPC transformers
 XMLConsumer VirtualProcessingPipeline.getXMLConsumer(Environment environment)
          Get the first consumer - used for VPC serializers
protected  boolean VirtualProcessingPipeline.processXMLPipeline(Environment environment)
          Process the SAX event pipeline
protected  boolean VirtualProcessingPipeline.processErrorHandler(Environment environment, ProcessingException e, XMLConsumer consumer)
           
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  void AbstractProcessingPipeline.prepareInternalErrorHandler(Environment environment, ProcessingException ex)
          If prepareInternal fails, prepare internal error handler.
protected  boolean AbstractProcessingPipeline.processXMLPipeline(Environment environment)
          Process the SAX event pipeline
protected  void AbstractProcessingPipeline.setupReader(Environment environment)
          Setup the reader
protected  void AbstractProcessingPipeline.setMimeTypeForReader(Environment environment)
          Set the mime-type for a reader
protected  void AbstractProcessingPipeline.setMimeTypeForSerializer(Environment environment)
          Set the mime-type for a serializer
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.
protected  boolean AbstractProcessingPipeline.processErrorHandler(Environment environment, ProcessingException e, XMLConsumer consumer)
           
 

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

Methods in org.apache.cocoon.components.pipeline.impl with parameters of type Environment
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)
           
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.
 

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)
          Timed version of AbstractProcessingPipeline.setupPipeline(org.apache.cocoon.environment.Environment) and AbstractCachingProcessingPipeline.setupPipeline(org.apache.cocoon.environment.Environment).
 boolean ProfilingCachingProcessingPipeline.process(Environment environment)
          Process the given Environment, producing the output.
protected  boolean ProfilingCachingProcessingPipeline.processXMLPipeline(Environment environment)
          Process the SAX event pipeline FIXME: VG: Why override processXMLPipeline, not process(env, consumer)?
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.impl
 

Methods in org.apache.cocoon.components.source.impl with parameters of type Environment
static SitemapSourceInfo SitemapSourceInfo.parseURI(Environment env, String sitemapURI)
           
static String SitemapSourceInfo.getView(String query, Environment env)
           
 

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

Methods in org.apache.cocoon.components.treeprocessor with parameters of type Environment
 boolean SimpleParentProcessingNode.invoke(Environment env, InvokeContext context)
          Define common invoke behavior here
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.
 boolean ProcessingNode.invoke(Environment env, InvokeContext context)
          Process environment.
 boolean NullNode.invoke(Environment env, InvokeContext context)
           
 boolean ContainerNode.invoke(Environment env, InvokeContext context)
           
 boolean TreeProcessor.process(Environment environment)
          Process the given Environment producing the output.
 Processor.InternalPipelineDescription TreeProcessor.buildPipeline(Environment environment)
          Process the given Environment to assemble a ProcessingPipeline.
 boolean ConcreteTreeProcessor.process(Environment environment)
          Process the given Environment producing the output.
 Processor.InternalPipelineDescription ConcreteTreeProcessor.buildPipeline(Environment environment)
          Process the given Environment to assemble a ProcessingPipeline.
protected  boolean ConcreteTreeProcessor.process(Environment environment, InvokeContext context)
          Do the actual processing, be it producing the response or just building the pipeline
protected  boolean ConcreteTreeProcessor.handleCocoonRedirect(String uri, Environment environment, InvokeContext context)
           
 boolean CategoryNode.invoke(Environment env, InvokeContext context)
           
 boolean CategoryNode.invokeByName(String name, Environment env, InvokeContext context)
           
 Processor.InternalPipelineDescription InvokeContext.getInternalPipelineDescription(Environment env)
          Get the pipeline description
 

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

Methods in org.apache.cocoon.components.treeprocessor.sitemap with parameters of type Environment
 boolean HandleErrorsNode.invoke(Environment env, InvokeContext context)
           
 boolean ErrorHandlerHelper.invokeErrorHandler(Exception ex, Environment env, InvokeContext context)
          Handle error.
 Processor.InternalPipelineDescription ErrorHandlerHelper.prepareErrorHandler(Exception ex, Environment env, InvokeContext context)
          Prepare error handler for the internal pipeline error handling.
 boolean ErrorHandlerHelper.invokeErrorHandler(ProcessingNode node, Exception ex, Environment env, InvokeContext context)
          Handle error using specified error handler processing node.
 boolean TransformNode.invoke(Environment env, InvokeContext context)
           
 boolean PreparableMatchNode.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 SwitchSelectNode.invoke(Environment env, InvokeContext context)
           
 boolean CallFunctionNode.invoke(Environment env, InvokeContext context)
           
 boolean ActTypeNode.invoke(Environment env, InvokeContext context)
           
 boolean MatchNode.invoke(Environment env, InvokeContext context)
           
 boolean ActSetNode.invoke(Environment env, InvokeContext context)
           
 boolean CallNode.invoke(Environment env, InvokeContext context)
           
 boolean PipelinesNode.invoke(Environment env, InvokeContext context)
          Process the environment.
 boolean ReadNode.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 PipelineNode.invoke(Environment env, InvokeContext context)
           
 boolean RedirectToURINode.invoke(Environment env, InvokeContext context)
           
 boolean GenerateNode.invoke(Environment env, InvokeContext context)
           
 boolean SerializeNode.invoke(Environment env, InvokeContext context)
           
 boolean AggregateNode.invoke(Environment env, InvokeContext context)
           
 boolean SelectNode.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 MountNode.invoke(Environment env, InvokeContext context)
           
 

Uses of Environment in org.apache.cocoon.core
 

Methods in org.apache.cocoon.core with parameters of type Environment
 Object CoreUtil.initializeRequest(Environment env)
          Initialize the current request.
 

Uses of Environment in org.apache.cocoon.core.logging
 

Methods in org.apache.cocoon.core.logging with parameters of type Environment
 Object CocoonLogKitLoggerManager.initializePerRequestLoggingContext(Environment env)
           
 Object PerRequestLoggerManager.initializePerRequestLoggingContext(Environment env)
          Initialize the context for logging.
 

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)
          Constructor
 

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.
 

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
          HTTP Servlet environment.
 

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

Classes in org.apache.cocoon.environment.internal that implement Environment
 class ForwardEnvironmentWrapper
          Local extension of EnvironmentWrapper to propagate otherwise blocked methods to the actual environment.
 

Fields in org.apache.cocoon.environment.internal declared as Environment
 Environment EnvironmentInfo.environment
           
 

Methods in org.apache.cocoon.environment.internal that return Environment
static Environment EnvironmentHelper.leaveEnvironment()
          This method is used for leaving the current environment.
static Environment EnvironmentHelper.getCurrentEnvironment()
          Return the environment
 

Methods in org.apache.cocoon.environment.internal with parameters of type Environment
 void EnvironmentHelper.changeContext(Environment env)
          Change the context of the environment.
static void EnvironmentHelper.enterProcessor(Processor processor, ServiceManager manager, Environment env)
          This hook must be called by the sitemap each time a sitemap is entered.
static void EnvironmentHelper.enterEnvironment(Environment env)
          This method is used for entering a new environment.
static XMLConsumer EnvironmentHelper.createPushEnvironmentConsumer(XMLConsumer consumer, Environment environment)
          Create an environment aware xml consumer that push an environment before calling the consumer.
 

Constructors in org.apache.cocoon.environment.internal with parameters of type Environment
ForwardEnvironmentWrapper(Environment env, SitemapSourceInfo info, Logger logger)
           
EnvironmentInfo(Processor processor, int oldStackCount, ServiceManager manager, Environment environment)
           
 

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
EnvironmentWrapper(Environment env, SitemapSourceInfo info, Logger logger)
          Construct a new environment.
EnvironmentWrapper(Environment env, SitemapSourceInfo info, Logger logger, boolean wrapResponse)
          Construct a new environment.
RequestWrapper(Request request, String requestURI, String queryString, Environment env)
          Constructor
RequestWrapper(Request request, String requestURI, String queryString, Environment env, boolean rawMode)
          Constructor
 

Uses of Environment in org.apache.cocoon.portlet
 

Methods in org.apache.cocoon.portlet that return Environment
protected  Environment ManagedCocoonPortlet.getEnvironment(String servletPath, String pathInfo, String uri, javax.portlet.ActionRequest req, javax.portlet.ActionResponse res)
          Create the environment for the request
protected  Environment ManagedCocoonPortlet.getEnvironment(String servletPath, String pathInfo, String uri, javax.portlet.RenderRequest req, javax.portlet.RenderResponse res)
          Create the environment for the request
protected  Environment CocoonPortlet.getEnvironment(String servletPath, String pathInfo, String uri, javax.portlet.ActionRequest req, javax.portlet.ActionResponse res)
          Create the environment for the request
protected  Environment CocoonPortlet.getEnvironment(String servletPath, String pathInfo, 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 ManagedCocoonPortlet.manageException(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res, Environment env, String uri, String title, String message, String description, Exception e)
           
protected  void ManagedCocoonPortlet.manageException(javax.portlet.RenderRequest req, javax.portlet.RenderResponse res, Environment env, String uri, String title, String message, String description, Exception e)
           
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
 

Methods in org.apache.cocoon.sitemap that return Environment
 Environment SitemapEvent.getEnvironment()
           
 

Constructors in org.apache.cocoon.sitemap with parameters of type Environment
LeaveSitemapEvent(Processor source, Environment env)
           
EnterSitemapEvent(Processor source, Environment env)
           
SitemapErrorHandler(ErrorHandlerHelper handler, Environment environment, InvokeContext context)
          Construct error handler with everything needed to handle an error.
SitemapEvent(Processor source, Environment env)
           
 



Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.