Class ConfigLoader
java.lang.Object
com.opensymphony.module.sitemesh.mapper.ConfigLoader
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.
- Version:
- $Revision: 1.8 $
- Author:
- Joe Walnes, Mathias Bogaert
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
State visibile across threads stored in a single container so that we can efficiently atomically access it with the guarantee that we wont see a partially loaded configuration in the face of one thread reloading the configuration while others are trying to read it. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Config
private File
private String
private ConfigLoader.State
Mark volatile so that the installation of new versions is guaranteed to be visible across threads. -
Constructor Summary
ConstructorsConstructorDescriptionConfigLoader
(File configFile) Create new ConfigLoader using supplied File.ConfigLoader
(String configFileName, Config config) Create new ConfigLoader using supplied filename and config. -
Method Summary
Modifier and TypeMethodDescriptionprivate static String
getAttribute
(Element element, String name) private static String
getContainedText
(Node parent, String childTagName) getDecoratorByName
(String name) Retrieve Decorator based on name specified in configuration file.getMappedName
(String path) Get name of Decorator mapped to given path.private ConfigLoader.State
Load configuration from file.private void
parseConfig
(ConfigLoader.State newState, Document document) private void
populatePathMapper
(ConfigLoader.State newState, NodeList patternNodes, String role, String name) private ConfigLoader.State
refresh()
Check if configuration file has been updated, and if so, reload.private void
storeDecorator
(ConfigLoader.State newState, Decorator d)
-
Field Details
-
state
Mark volatile so that the installation of new versions is guaranteed to be visible across threads. -
configFile
-
configFileName
-
config
-
-
Constructor Details
-
ConfigLoader
Create new ConfigLoader using supplied File.- Throws:
javax.servlet.ServletException
-
ConfigLoader
Create new ConfigLoader using supplied filename and config.- Throws:
javax.servlet.ServletException
-
-
Method Details
-
getDecoratorByName
Retrieve Decorator based on name specified in configuration file.- Throws:
javax.servlet.ServletException
-
getMappedName
Get name of Decorator mapped to given path.- Throws:
javax.servlet.ServletException
-
loadConfig
Load configuration from file.- Throws:
javax.servlet.ServletException
-
parseConfig
-
populatePathMapper
private void populatePathMapper(ConfigLoader.State newState, NodeList patternNodes, String role, String name) -
getAttribute
-
getContainedText
-
storeDecorator
-
refresh
Check if configuration file has been updated, and if so, reload.- Throws:
javax.servlet.ServletException
-