| org.apache.cocoon.selection |
|
| Java Source File Name | Type | Comment |
| AbstractRegexpSelector.java | Class | The
AbstractRegexpSelector abstract class defines a simple selector
operating over configured regular-expression patterns.
Configuration of an
AbstractRegexpSelector is quite simple: first of
all the patterns used for selections must be configured:
<map:components>
... |
| AbstractSwitchSelector.java | Class | Abstract SwitchSelector class. |
| BrowserSelector.java | Class | Tests a specific browser pattern against the requesting user-agent. |
| BrowserSelectorTestCase.java | Class | |
| CookieSelector.java | Class | A Selector that matches a string against a configurable cookie's value. |
| CookieSelectorTestCase.java | Class | |
| ExceptionSelector.java | Class | In a <map:handle-errors>, selects depending on the exception that caused the error.
The configuration of this selector allows to map exception class names to symbolic names
that are used in the <map:when> alternatives.
Example configuration :
<map:selector type="error" src="....ExceptionSelector">
<exception class="org.xml.sax.SAXException" name="sax" unroll="true"/>
<exception name="not-found" class="org.apache.cocoon.ResourceNotFoundException"/>
<exception class="org.apache.cocoon.ProcessingException" unroll="true"/>
<exception name="denied" class="java.security.SecurityException"/>
<exception name="denied" class="my.comp.auth.AuthenticationFailure"/>
</map:selector>
This example shows several features :
the "class" is the class name of the exception (which can be any Throwable),
an exception can be given a name, which is used in the <map:when> tests,
an exception can be unrolled, meaning we try to get its cause and then consider this cause for
the exception name
Note that both "name" and "unroll" can be specified. |
| ExceptionSelectorTestCase.java | Class | |
| HeaderSelector.java | Class | A Selector that matches a string against a configurable
request header, e.g. |
| HeaderSelectorTestCase.java | Class | |
| HostSelector.java | Class | A Selector that matches a string from within the host parameter
of the HTTP request. |
| HostSelectorTestCase.java | Class | |
| NamedPatternsSelector.java | Class | Abstract class for selectors that select a value when it matches
some patterns associated to the select expression. |
| ParameterSelector.java | Class | A Selector that matches a string in the parameters object passed to it. |
| ParameterSelectorTestCase.java | Class | |
| RegexpHeaderSelector.java | Class | The
RegexpHeaderSelector class defines a selector matching
specific headers to configured regular-expression patterns.
The configuration of an
RegexpHeaderSelector follows exactly
what has been outlined in
AbstractRegexpSelector regarding regular
expression patterns, and additionally it requires an extra configuration element
specifying the header whose value needs to be matched:
<map:components>
... |
| RegexpHeaderSelectorTestCase.java | Class | Test case for RegexpHeaderSelector. |
| RegexpRequestParameterSelector.java | Class | The
RegexpRequestParameterSelector class defines a selector matching
specific request parameters to configured regular-expression patterns.
The configuration of an
RegexpRequestParameterSelector follows exactly
what has been outlined in
AbstractRegexpSelector regarting regular
expression patterns, and additionally it requires an extra configuration element
specifying the request parameter whose value needs to be matched:
<map:components>
... |
| RegexpRequestParameterSelectorTestCase.java | Class | |
| RequestAttributeSelector.java | Class | A Selector that matches a string against a configurable request
attribute's string represenation. |
| RequestAttributeSelectorTestCase.java | Class | |
| RequestMethodSelector.java | Class | A Selector that matches a getMethod() of the HTTP request. |
| RequestMethodSelectorTestCase.java | Class | |
| RequestParameterSelector.java | Class | A Selector that matches a string against a configurable request parameter's value. |
| RequestParameterSelectorTestCase.java | Class | |
| RequestSelector.java | Class | |
| ResourceExistsSelector.java | Class | Selects the first of a set of Resources (usually files) that exists.
A parameter 'prefix',
<map:parameter src="prefix" value="some/path"/<
may be supplied to the selector instance. |
| ResourceExistsSelectorTestCase.java | Class | |
| Selector.java | Interface | |
| SessionAttributeSelector.java | Class | A Selector that matches a string against a configurable session
attribute's string represenation. |
| SessionAttributeSelectorTestCase.java | Class | |
| SessionStateSelector.java | Class | This class generates source code to implement a selector that
matches a string against an arbitrary session attribute. |
| SimpleSelector.java | Class | A very simple selector that operates on string literals, useful especially
in conjunction with input modules. |
| SimpleSelectorTestCase.java | Class | |
| SwitchSelector.java | Interface | SwitchSelector is an enhanced Selector interface that allows a
context object to be created to optimize selector conditional testing.
The original Selector interface supports an if-then-else style
of conditional testing depending on whether a particular expression is true.
This causes Selector.select() to be invoked for each <map:when>
statement which may be undesirable due to performance or logic reasons.
Example, the following sitemap snippet:
<map:select type="aSelector">
<map:when test="test-expr1">...</map:when>
<map:when test="test-expr2">...</map:when>
</map:select>
is interpreted as (pseudo-code):
if (aSelector.select("test-expr1", objectModel, params)) {
...
} else if (aSelector.select("test-expr2", objectModel, params)) {
...
}
ie. |
| XPathExceptionSelector.java | Class | Additional to the inherited functionality from its superclass ExceptionSelector,
this selector allows to define xpath expressions to evaluate supplemental information
given in the thrown exception. |