Introduction

All pipelines consist at least of two components: a generator, that produces the content and a serialiser, that delivers the content to the client.

More precisely: a generator generates SAX events and a serializer consumes these events and produces a character stream.

Some things to note here: each generator has a unique name, this name is mapped to a java class, one name is declared as default generator. In addition each generator may have additional configurations as child elements.

Additional attributes are targeted at the component manager. The optional "label" attribute is relevant for the view concept below. The optional "logger" attribute defines the logging category where messages produced by a component should go. If there's no "logger" attribute, the category used is the one defined for the "sitemap" component in cocoon.xconf.

We have chosen in this example sitemap to use a different logging category for each component, which allows fine-grained classification of log messages. But you are free to use any category you want.

It is possible to have the same java class declared as different generators by using different names. No configuration options are shared between these instances, however.

All components follow this schema.

Overview

The following section presents the generators available in Cocoon. It was auto-generated from the java source files.

• org.apache.cocoon.components.language.markup.xsp.JSGenerator
• org.apache.cocoon.components.profiler.ProfilerGenerator
• org.apache.cocoon.generation.ServerPagesGenerator
• org.apache.cocoon.generation.RequestGenerator
• org.apache.cocoon.generation.DirectoryGenerator
• org.apache.cocoon.generation.ImageDirectoryGenerator
• org.apache.cocoon.generation.ScriptGenerator
• org.apache.cocoon.generation.XMLDBGenerator
• org.apache.cocoon.generation.XPathDirectoryGenerator
• org.apache.cocoon.generation.HTMLGenerator
• org.apache.cocoon.generation.StreamGenerator
• org.apache.cocoon.generation.FragmentExtractorGenerator
• org.apache.cocoon.generation.XMLDBCollectionGenerator
• org.apache.cocoon.generation.LinkStatusGenerator
• org.apache.cocoon.generation.RequestAttributeGenerator
• org.apache.cocoon.generation.SessionAttributeGenerator
• org.apache.cocoon.generation.VelocityGenerator
• org.apache.cocoon.generation.FileGenerator
• org.apache.cocoon.generation.MP3DirectoryGenerator
• org.apache.cocoon.generation.JspGenerator
• org.apache.cocoon.generation.SearchGenerator
• org.apache.cocoon.generation.StatusGenerator
• org.apache.cocoon.samples.parentcm.Generator
• org.apache.cocoon.sitemap.NotifyingGenerator
• org.apache.cocoon.sitemap.ErrorNotifier
• org.apache.cocoon.sitemap.ContentAggregator
• org.apache.cocoon.webapps.authentication.generation.ConfigurationGenerator
• org.apache.cocoon.webapps.portal.generation.ConfigurationGenerator
• org.apache.cocoon.webapps.portal.generation.PortalGenerator

org.apache.cocoon.components.language.markup.xsp.JSGenerator

Class representing interpreted XSP-generated ServerPagesGenerator programs written in Javascript language

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.components.language.markup.xsp.JSGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.components.profiler.ProfilerGenerator

Generates an XML representation of the current status of Profiler.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.components.profiler.ProfilerGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.ServerPagesGenerator

This class acts as a proxy to a dynamically loadedGenerator delegating actual SAX event generation.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.ServerPagesGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.RequestGenerator

Generates an XML representation of the incoming request.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.RequestGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.DirectoryGenerator

Generates an XML directory listing.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.DirectoryGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.ImageDirectoryGenerator

An extension of DirectoryGenerators that adds extra attributes for image files.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.ImageDirectoryGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.ScriptGenerator

The Scriptgenerator executes arbitraty scripts using the BSF framework and additional interpreter (Rhino, Jython, etc.) as a Cocoon Generator.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.ScriptGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.XMLDBGenerator

This class implements generation of XML documents from a XML:DB compliant database.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.XMLDBGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.XPathDirectoryGenerator

Generates an XML directory listing performing XPath queries on XML files.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.XPathDirectoryGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.HTMLGenerator

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.HTMLGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.StreamGenerator

The StreamGenerator is a class that reads XML from a request InputStream and generates SAX Events.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.StreamGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.FragmentExtractorGenerator

The generation half of FragmentExtractor.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.FragmentExtractorGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.XMLDBCollectionGenerator

This class implements generation of a XML:DB collection contents as a directory listing.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.XMLDBCollectionGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.LinkStatusGenerator

Generates a list of links that are reachable from the src and their status.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.LinkStatusGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.RequestAttributeGenerator

The RequestAttributeGenerator is a class that reads XML from a request attribute and generates SAX Events.

Overview

Parameter

This table describes parameters available for configuring this sitemap component.

HttpRequestAttributes

This table describes http request attributes controlling the behaviour of this sitemap component.

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="req-attr " 
    src="org.apache.cocoon.generation.RequestAttributeGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.SessionAttributeGenerator

Generates a document from a session attribute.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.SessionAttributeGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.VelocityGenerator

Cocoon Generator that produces dynamic XML SAX events from a Velocity template file.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.VelocityGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.FileGenerator

The FileGenerator is a class that reads XML from a source and generates SAX Events.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.FileGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.MP3DirectoryGenerator

An extension of DirectoryGenerators that adds extra attributes for MP3 files.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.MP3DirectoryGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.JspGenerator

Allows JSP to be used as a generator.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.JspGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.SearchGenerator

Generates an XML representation of a search result.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="search " 
    src="org.apache.cocoon.generation.SearchGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.generation.StatusGenerator

Generates an XML representation of the current status of Cocoon.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.generation.StatusGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.samples.parentcm.Generator

Generator for the parent component manager sample.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.samples.parentcm.Generator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.sitemap.NotifyingGenerator

Generates an XML representation of the current notification.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.sitemap.NotifyingGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.sitemap.ErrorNotifier

Generates an XML representation of the current notification.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.sitemap.ErrorNotifier"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.sitemap.ContentAggregator

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.sitemap.ContentAggregator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.webapps.authentication.generation.ConfigurationGenerator

This is the authentication Configuration Generator.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.webapps.authentication.generation.ConfigurationGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.webapps.portal.generation.ConfigurationGenerator

This generator generates the configuration of the portal for the current user.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.webapps.portal.generation.ConfigurationGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.webapps.portal.generation.PortalGenerator

This generator generates the portal for the current user.

Overview

Sitemap Definition

Generator sitemap definition:

<map:generators default="file">
  ...
  <map:generator name="" 
    src="org.apache.cocoon.webapps.portal.generation.PortalGenerator"/>
  ...
</map:generators>

Sitemap Usage

Generator usage example:

<map:pipeline>
  <map:match pattern="foo"/>
    <map:generate type="$cocoonName" src="foobar"/>
    ...
  </map:match>
  ...
</map:pipeline>