com.opensymphony.module.sitemesh.mapper

Class ConfigLoader

java.lang.Object

com.opensymphony.module.sitemesh.mapper.ConfigLoader

public class ConfigLoader
extends java.lang.Object

The ConfigLoader reads a configuration XML file that contains Decorator definitions (name, url, init-params) and path-mappings (pattern, name).

These can then be accessed by the getDecoratorByName() methods and getMappedName() methods respectively.

The DTD for the configuration file in old (deprecated) format is located at http://www.opensymphony.com/dtds/sitemesh_1_0_decorators.dtd .

The DTD for the configuration file in new format is located at http://www.opensymphony.com/dtds/sitemesh_1_5_decorators.dtd .

Editing the config file will cause it to be auto-reloaded.

This class is used by ConfigDecoratorMapper, and uses PathMapper for pattern matching.

See Also:

ConfigDecoratorMapper, PathMapper

Constructor Summary

Constructors

Constructor and Description
ConfigLoader(java.io.File configFile) Create new ConfigLoader using supplied File.
ConfigLoader(java.lang.String configFileName, Config config) Create new ConfigLoader using supplied filename and config.

Method Summary

Modifier and Type	Method and Description
Decorator	getDecoratorByName(java.lang.String name) Retrieve Decorator based on name specified in configuration file.
java.lang.String	getMappedName(java.lang.String path) Get name of Decorator mapped to given path.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigLoader

public ConfigLoader(java.io.File configFile)
             throws javax.servlet.ServletException

Create new ConfigLoader using supplied File.

Throws:

javax.servlet.ServletException

ConfigLoader

public ConfigLoader(java.lang.String configFileName,
                    Config config)
             throws javax.servlet.ServletException

Create new ConfigLoader using supplied filename and config.

Throws:

javax.servlet.ServletException

Method Detail

getDecoratorByName

public Decorator getDecoratorByName(java.lang.String name)
                             throws javax.servlet.ServletException

Retrieve Decorator based on name specified in configuration file.

Throws:

javax.servlet.ServletException

getMappedName

public java.lang.String getMappedName(java.lang.String path)
                               throws javax.servlet.ServletException

Get name of Decorator mapped to given path.

Throws:

javax.servlet.ServletException