Introduction

Selectors are executed during pipeline setup. They can be used to determine which pipeline fragments should be combined. They are best compared with a switch statement in java. Matchers and actions are related concepts.

Since this is important, let me repeat it: Selectors are executed during pipeline setup.

Overview

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

• org.apache.cocoon.selection.HostSelector
• org.apache.cocoon.selection.HostSelectorFactory
• org.apache.cocoon.selection.RequestParameterSelector
• org.apache.cocoon.selection.RequestSelector
• org.apache.cocoon.selection.RequestSelectorFactory
• org.apache.cocoon.selection.BrowserSelector
• org.apache.cocoon.selection.SessionAttributeSelector
• org.apache.cocoon.selection.ParameterSelector
• org.apache.cocoon.selection.BrowserSelectorFactory
• org.apache.cocoon.selection.SessionAttributeSelectorFactory
• org.apache.cocoon.selection.SessionStateSelector
• org.apache.cocoon.selection.HeaderSelector
• org.apache.cocoon.selection.CookieSelector
• org.apache.cocoon.selection.HeaderSelectorFactory
• org.apache.cocoon.selection.ParameterSelectorFactory
• org.apache.cocoon.selection.RequestAttributeSelector
• org.apache.cocoon.sunshine.sunrise.selection.MediaSelector

org.apache.cocoon.selection.HostSelector

A Selector that matches a string from within the host parameter of the HTTP request.

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.HostSelector"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.HostSelectorFactory

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.HostSelectorFactory"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.RequestParameterSelector

A Selector that matches a string against a configurable request parameter's value.

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.RequestParameterSelector"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.RequestSelector

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.RequestSelector"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.RequestSelectorFactory

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.RequestSelectorFactory"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.BrowserSelector

Tests a specific browser pattern against the requesting user-agent.

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.BrowserSelector"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.SessionAttributeSelector

A Selector that matches a string against a configurable session attribute's string represenation.

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.SessionAttributeSelector"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.ParameterSelector

A Selector that matches a string in the parameters object passed to it.

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.ParameterSelector"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.BrowserSelectorFactory

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.BrowserSelectorFactory"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.SessionAttributeSelectorFactory

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.SessionAttributeSelectorFactory"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.SessionStateSelector

This class generates source code to implement a selector that matches a string against an arbitrary session attribute.

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.SessionStateSelector"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.HeaderSelector

A Selector that matches a string against a configurable request header, e.g.

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.HeaderSelector"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.CookieSelector

A Selector that matches a string against a configurable cookie's value.

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.CookieSelector"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.HeaderSelectorFactory

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.HeaderSelectorFactory"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.ParameterSelectorFactory

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.ParameterSelectorFactory"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.selection.RequestAttributeSelector

A Selector that matches a string against a configurable request attribute's string represenation.

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.selection.RequestAttributeSelector"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>

org.apache.cocoon.sunshine.sunrise.selection.MediaSelector

This selector uses the sunRise media management.

Overview

Sitemap Definition

Serializer sitemap definition:

<map:selectors default="browser">
  ...
   <map:selector name="${coconName}"
      src="org.apache.cocoon.sunshine.sunrise.selection.MediaSelector"/>
  ...
</map:selectors>

Sitemap Usage

Serializer usage example:

<map:pipeline>
  <map:select type="">
    <map:when test="foo">
    ...
    </map:when>
    <map:otherwise>
    ...
    </map:otherwise>
  </map:selector>
  ...
</map:pipeline>