Introduction

Matchers are executed during pipeline setup. They decide if a pipeline fragment is used within a pipeline. Usually, the decision is based on a match on the requested URI but matchers exist, that match different things as well. Most often the fragment contained in a matcher has a generator as well as a serializer. This is not a necessity, matchers can be nested while chaining does not work. Related concepts are selectors and actions.

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

Overview

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

• org.apache.cocoon.matching.RegexpHostMatcher
• org.apache.cocoon.matching.RegexpTargetHostMatcher
• org.apache.cocoon.matching.RegexpTargetHostMatcherFactory
• org.apache.cocoon.matching.WildcardURIMatcher
• org.apache.cocoon.matching.WildcardURIMatcherFactory
• org.apache.cocoon.matching.WildcardSessionAttributeMatcher
• org.apache.cocoon.matching.RegexpHeaderMatcher
• org.apache.cocoon.matching.RequestAttributeMatcher
• org.apache.cocoon.matching.WildcardRequestAttributeMatcher
• org.apache.cocoon.matching.WildcardHeaderMatcher
• org.apache.cocoon.matching.WildcardHeaderMatcherFactory
• org.apache.cocoon.matching.RequestParameterMatcher
• org.apache.cocoon.matching.WildcardRequestParameterMatcher
• org.apache.cocoon.matching.WildcardParameterValueMatcher
• org.apache.cocoon.matching.WildcardParameterValueMatcherFactory
• org.apache.cocoon.matching.ParameterMatcher
• org.apache.cocoon.matching.WildcardHostMatcher
• org.apache.cocoon.matching.RegexpSessionAttributeMatcher
• org.apache.cocoon.matching.RegexpParameterMatcher
• org.apache.cocoon.matching.CookieMatcher
• org.apache.cocoon.matching.RegexpRequestAttributeMatcher
• org.apache.cocoon.matching.RegexpURIMatcher
• org.apache.cocoon.matching.RegexpURIMatcherFactory
• org.apache.cocoon.matching.RequestParamMatcher
• org.apache.cocoon.matching.RegexpRequestParameterMatcher
• org.apache.cocoon.matching.SessionAttributeMatcher
• org.apache.cocoon.matching.WildcardParameterMatcher
• org.apache.cocoon.matching.HeaderMatcher
• org.apache.cocoon.matching.WildcardSessionAttributeMatcherFactory
• org.apache.cocoon.matching.modular.WildcardMatcher
• org.apache.cocoon.matching.modular.CachingWildcardMatcher

org.apache.cocoon.matching.RegexpHostMatcher

Matches the target host ("Host" request header) against a regular expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RegexpHostMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.RegexpTargetHostMatcher

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RegexpTargetHostMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.RegexpTargetHostMatcherFactory

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RegexpTargetHostMatcherFactory"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.WildcardURIMatcher

Match the request URI against a wildcard expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.WildcardURIMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.WildcardURIMatcherFactory

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.WildcardURIMatcherFactory"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.WildcardSessionAttributeMatcher

Matches a session attribute against a wildcard expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.WildcardSessionAttributeMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.RegexpHeaderMatcher

Matches a request header (e.g.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RegexpHeaderMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.RequestAttributeMatcher

This class allows for matching based on a request attribute.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RequestAttributeMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.WildcardRequestAttributeMatcher

Matches a request attribute against a wildcard expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.WildcardRequestAttributeMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.WildcardHeaderMatcher

Matches a request header (e.g.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.WildcardHeaderMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.WildcardHeaderMatcherFactory

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.WildcardHeaderMatcherFactory"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.RequestParameterMatcher

This class allows for matching based on a request parameter.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RequestParameterMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.WildcardRequestParameterMatcher

Matches a request parameter against a wildcard expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.WildcardRequestParameterMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.WildcardParameterValueMatcher

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.WildcardParameterValueMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.WildcardParameterValueMatcherFactory

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.WildcardParameterValueMatcherFactory"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.ParameterMatcher

This class allows for matching based on a parameter provided from the sitemap.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.ParameterMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.WildcardHostMatcher

Matches the target host ("Host" request header) against a wildcard expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.WildcardHostMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.RegexpSessionAttributeMatcher

Matches a session attribute against a regular expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RegexpSessionAttributeMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.RegexpParameterMatcher

Matches a sitemap parameter against a regular expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RegexpParameterMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.CookieMatcher

Matches cookies agains given name.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.CookieMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.RegexpRequestAttributeMatcher

Matches a request attribute against a regular expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RegexpRequestAttributeMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.RegexpURIMatcher

Matches the request URIs against a regular expression pattern.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RegexpURIMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.RegexpURIMatcherFactory

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RegexpURIMatcherFactory"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.RequestParamMatcher

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RequestParamMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.RegexpRequestParameterMatcher

Matches a request parameter against a regular expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.RegexpRequestParameterMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.SessionAttributeMatcher

This class allows for matching based on a session attribute.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.SessionAttributeMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.WildcardParameterMatcher

Matches a sitemap parameter against a wildcard expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.WildcardParameterMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.HeaderMatcher

This class allows for matching based on a request header.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.HeaderMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.WildcardSessionAttributeMatcherFactory

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.WildcardSessionAttributeMatcherFactory"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.modular.WildcardMatcher

Matches against a wildcard expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.modular.WildcardMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>

org.apache.cocoon.matching.modular.CachingWildcardMatcher

Matches against a wildcard expression.

Sitemap Definition

Matchers sitemap definition:

<map:matchers default="wildcard">
  ...
  <map:matcher name="" 
    src="org.apache.cocoon.matching.modular.CachingWildcardMatcher"/>
  ...
</map:matchers>

Sitemap Usage

Matchers usage example:

<map:pipeline>
  <map:match type="" pattern="*foo*bar"/>
    ...
    <map:serialize name="html" ... />
    ...
  </map:match>
  ...
</map:pipeline>