The <dispatch> Element
Purpose
The <dispatch> element defines a dispatch configuration.
It may appear either inside the <dispatches> element to define a global dispatch configuration or inside an <action> element to define a local dispatch configuration.
A <dispatch> element requires either the path or action attribute to specify the dispatch target.
Attributes
| Name | Type | Description |
|---|---|---|
| name | NMTOKEN | The dispatch name. The name attribute must be unique under <dispatch> siblings. Omitting the name sets the corresponding configuration property to null. Therefore, only one sibling may do this. |
| path | CDATA | Dynamic - The dispatch path. The interpretation of this attribute may depend on the dispatcher. The default dispatcher assumes a context-relative path, if it starts with a slash ('/'). Otherwise, if the redirection flag is set, it assumes an absolute URL. Otherwise, a path relative to the current request path is assumed. |
| action | CDATA | The dispatch action path. This is the path of the action, this configuration dispatches to. If the module attribute is set, it specifies the name of the module containing the action; otherwise, the current module is assumed. Either the path or action attribute must be set. |
| module | NMTOKEN | The dispatch action module. See above. The module attribute requires the action attribute to be set. |
| redirect | true|false | Instruct the dispatcher to use redirection, if set to true. The default is false. |
| dispatcher | NMTOKEN | Specifies a custom dispatcher to be used. |
Body
The body of the <dispatch> element is defined by the following sequence:
(param*)