HandlerPlugin Schema

The HandlerPlugin schema defines the base configuration for core request processing plugins in the Rusty Beam processing pipeline. These plugins handle primary request/response processing such as serving files, processing selectors, handling errors, redirects, and WebSocket connections.

Schema Definition

Schema URL: https://rustybeam.net/schema/HandlerPlugin

Parent Schema: https://rustybeam.net/schema/Plugin

Properties

Inheritance: This schema inherits all properties from Plugin including library and plugin.
Property Type Cardinality Description
config_file https://rustybeam.net/schema/Text 0..1 Path to external configuration file for plugins that require additional configuration (e.g., redirect rules)
rulesfile https://rustybeam.net/schema/URL 0..1 Path to rules file for plugins that use rule-based processing (e.g., redirect plugin)

Usage Examples

File Handler Plugin

<td itemprop="plugin" itemscope itemtype="https://rustybeam.net/schema/FileHandlerPlugin">
    <span itemprop="library">file://./plugins/librusty_beam_file_handler.so</span>
</td>

Redirect Plugin with Configuration

<td itemprop="plugin" itemscope itemtype="https://rustybeam.net/schema/RedirectPlugin">
    <span itemprop="library">file://./plugins/librusty_beam_redirect.so</span>
    <span itemprop="config_file">config/server-config.html</span>
</td>

Selector Handler Plugin

<td itemprop="plugin" itemscope itemtype="https://rustybeam.net/schema/SelectorHandlerPlugin">
    <span itemprop="library">file://./plugins/librusty_beam_selector_handler.so</span>
</td>

Child Schemas

Plugin Order: Handler plugins typically appear in the middle to end of the plugin pipeline, after authentication/authorization plugins but before utility plugins like access logging.

See Also