com.opensymphony.module.sitemesh.factory

Class DefaultFactory

java.lang.Object

com.opensymphony.module.sitemesh.Factory

com.opensymphony.module.sitemesh.factory.BaseFactory

com.opensymphony.module.sitemesh.factory.DefaultFactory

All Implemented Interfaces:

PageParserSelector

public class DefaultFactory
extends BaseFactory

DefaultFactory, reads configuration from the sitemesh.configfile init param, or /WEB-INF/sitemesh.xml if not specified, or uses the default configuration if sitemesh.xml does not exist.

To use the sitemesh.configfile parameter, add the following to your web.xml:

 <context-param>
      <param-name>sitemesh.configfile</param-name>
      <param-value>/WEB-INF/etc/sitemesh.xml</param-value>
  </context-param>
 

Version:

$Revision: 1.8 $

Author:

Joe Walnes, Mathias Bogaert

Field Summary

Fields

Modifier and Type	Field and Description
static long	configCheckMillis
(package private) java.io.File	configFile
(package private) java.lang.String	configFileName
private long	configLastCheck
(package private) long	configLastModified
(package private) java.util.Map	configProps
private static java.lang.String	DEFAULT_CONFIG_FILENAME
(package private) java.io.File	excludesFile
(package private) java.lang.String	excludesFileName

Fields inherited from class com.opensymphony.module.sitemesh.factory.BaseFactory

config, decoratorMapper, excludeUrls, pageParsers

Constructor Summary

Constructors

Constructor and Description
DefaultFactory(Config config)

Method Summary

Modifier and Type	Method and Description
private void	loadConfig() Load configuration from file.
private void	loadDecoratorMappers(org.w3c.dom.NodeList nodes)
private void	loadExcludes()
private void	loadExcludeUrls(org.w3c.dom.NodeList nodes) Reads in all the url patterns to exclude from decoration.
private void	loadPageParsers(org.w3c.dom.NodeList nodes) Loop through children of 'page-parsers' element and add all 'parser' mappings.
private org.w3c.dom.Element	loadSitemeshXML()
void	refresh() Check if configuration file has been modified, and if so reload it.
private java.lang.String	replaceProperties(java.lang.String str) Replaces any properties that appear in the supplied string with their actual values

Methods inherited from class com.opensymphony.module.sitemesh.factory.BaseFactory

addExcludeUrl, clearDecoratorMappers, clearExcludeUrls, clearParserMappings, getDecoratorMapper, getDecoratorMapper, getPageParser, isPathExcluded, mapParser, pushDecoratorMapper, shouldParsePage

Methods inherited from class com.opensymphony.module.sitemesh.Factory

getInstance

Methods inherited from class java.lang.Object

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

Field Detail

configFileName

java.lang.String configFileName

DEFAULT_CONFIG_FILENAME

private static final java.lang.String DEFAULT_CONFIG_FILENAME

See Also:

Constant Field Values

configFile

java.io.File configFile

configLastModified

long configLastModified

configLastCheck

private long configLastCheck

configCheckMillis

public static long configCheckMillis

configProps

java.util.Map configProps

excludesFileName

java.lang.String excludesFileName

excludesFile

java.io.File excludesFile

Constructor Detail

DefaultFactory

public DefaultFactory(Config config)

Method Detail

loadConfig

private void loadConfig()

Load configuration from file.

loadSitemeshXML

private org.w3c.dom.Element loadSitemeshXML()
                                     throws javax.xml.parsers.ParserConfigurationException,
                                            java.io.IOException,
                                            org.xml.sax.SAXException

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

loadExcludes

private void loadExcludes()
                   throws javax.xml.parsers.ParserConfigurationException,
                          java.io.IOException,
                          org.xml.sax.SAXException

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

loadPageParsers

private void loadPageParsers(org.w3c.dom.NodeList nodes)

Loop through children of 'page-parsers' element and add all 'parser' mappings.

loadDecoratorMappers

private void loadDecoratorMappers(org.w3c.dom.NodeList nodes)

loadExcludeUrls

private void loadExcludeUrls(org.w3c.dom.NodeList nodes)

Reads in all the url patterns to exclude from decoration.

refresh

public void refresh()

Check if configuration file has been modified, and if so reload it.

Specified by:

refresh in class Factory

replaceProperties

private java.lang.String replaceProperties(java.lang.String str)

Replaces any properties that appear in the supplied string with their actual values

Parameters:

str - the string to replace the properties in

Returns:

the same string but with any properties expanded out to their actual values