org.sitemesh.config.properties

Class PropertiesFilterConfigurator

java.lang.Object

org.sitemesh.config.properties.PropertiesConfigurator

org.sitemesh.config.properties.PropertiesFilterConfigurator

public class PropertiesFilterConfigurator
extends PropertiesConfigurator

Configures a SiteMeshFilterBuilder from string key/value pairs. The keys are:

decoratorMappings: A list of mappings of path patterns to decorators. Each entry should consist of pattern=decorator, separated by whitespace or commas. If multiple decorators are required, they should be delimited with a pipe | char (and no whitespace) e.g. /admin/*=/decorators/admin.html, *.secret=/decorators/secret.html|/decorators/common.html

mimeTypes (optional): A list of mime-types, separated by whitespace or commas, that should attempt to be decorated. Defaults to text/html.

tagRuleBundles (optional): The names of any additional TagRuleBundles to install, separated by whitespace or commas. These will be added to the default bundles (as set up in BaseSiteMeshBuilder.setupDefaults()): CoreHtmlTagRuleBundle and DecoratorTagRuleBundle. Note: The contentProcessor and tagRuleBundles are mutually exclusive - you should not set them both.

contentProcessor (optional): The name of the ContentProcessor to use. Note: The contentProcessor and tagRuleBundles are mutually exclusive - you should not set them both.

exclude (optional): A list of path patterns to exclude from decoration, separated by whitespace or commas. e.g. /javadoc/*, somepage.html, *.jsp

Where a name is used, this typically means the fully qualified class name, which must have a default constructor. However, a custom ObjectFactory implementation (passed into the #ConfigPropertiesBuilder(org.sitemesh.config.ObjectFactory) constructor may change the behavior of this (e.g. to plug into a dependency injection framework).

Author:

Joe Walnes

Field Summary

Fields

Modifier and Type	Field and Description
static String	DECORATOR_SELECTOR
static String	EXCLUDE_PARAM
static String	INCLUDE_ERROR_PAGES_PARAM
static String	MIME_TYPES_PARAM

Fields inherited from class org.sitemesh.config.properties.PropertiesConfigurator

CONTENT_PROCESSOR_PARAM, DECORATOR_MAPPINGS_PARAM, TAG_RULE_BUNDLES_PARAM

Constructor Summary

Constructors

Constructor and Description
PropertiesFilterConfigurator(ObjectFactory objectFactory, Map<String,String> properties)

Method Summary

Methods

Modifier and Type	Method and Description
void	configureFilter(BaseSiteMeshFilterBuilder builder)

Methods inherited from class org.sitemesh.config.properties.PropertiesConfigurator

configureCommon, getObjectFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXCLUDE_PARAM

public static final String EXCLUDE_PARAM

See Also:

Constant Field Values

MIME_TYPES_PARAM

public static final String MIME_TYPES_PARAM

See Also:

Constant Field Values

INCLUDE_ERROR_PAGES_PARAM

public static final String INCLUDE_ERROR_PAGES_PARAM

See Also:

Constant Field Values

DECORATOR_SELECTOR

public static final String DECORATOR_SELECTOR

See Also:

Constant Field Values

Constructor Detail

PropertiesFilterConfigurator

public PropertiesFilterConfigurator(ObjectFactory objectFactory,
                            Map<String,String> properties)

Method Detail

configureFilter

public void configureFilter(BaseSiteMeshFilterBuilder builder)