public class ConfigLoader extends Object
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.
ConfigDecoratorMapper
,
PathMapper
Modifier and Type | Class | Description |
---|---|---|
private static class |
ConfigLoader.State |
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.
|
Modifier and Type | Field | Description |
---|---|---|
private Config |
config |
|
private File |
configFile |
|
private String |
configFileName |
|
private ConfigLoader.State |
state |
Mark volatile so that the installation of new versions is guaranteed to
be visible across threads.
|
Constructor | Description |
---|---|
ConfigLoader(File configFile) |
Create new ConfigLoader using supplied File.
|
ConfigLoader(String configFileName,
Config config) |
Create new ConfigLoader using supplied filename and config.
|
Modifier and Type | Method | Description |
---|---|---|
private static String |
getAttribute(Element element,
String name) |
|
private static String |
getContainedText(Node parent,
String childTagName) |
|
Decorator |
getDecoratorByName(String name) |
Retrieve Decorator based on name specified in configuration file.
|
String |
getMappedName(String path) |
Get name of Decorator mapped to given path.
|
private ConfigLoader.State |
loadConfig() |
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) |
private volatile ConfigLoader.State state
private File configFile
private String configFileName
private Config config
public ConfigLoader(File configFile) throws javax.servlet.ServletException
javax.servlet.ServletException
public Decorator getDecoratorByName(String name) throws javax.servlet.ServletException
javax.servlet.ServletException
public String getMappedName(String path) throws javax.servlet.ServletException
javax.servlet.ServletException
private ConfigLoader.State loadConfig() throws javax.servlet.ServletException
javax.servlet.ServletException
private void parseConfig(ConfigLoader.State newState, Document document)
private void populatePathMapper(ConfigLoader.State newState, NodeList patternNodes, String role, String name)
private void storeDecorator(ConfigLoader.State newState, Decorator d)
private ConfigLoader.State refresh() throws javax.servlet.ServletException
javax.servlet.ServletException