com.jalios.jcms.tools

Class AbstractChecker

java.lang.Object

com.jalios.jcms.tools.AbstractChecker

Direct Known Subclasses:

FormHandlerChecker, HbmChecker, JPropertiesChecker, JsChecker, JspChecker, LangPropertiesChecker, TypeChecker

public abstract class AbstractChecker
extends java.lang.Object

Common parent class for validation checkers.

Since:

jcms-8.0.3, jcms-9.0

Version:

$Revision: 89297 $

Author:

Sylvain Devaux

Field Summary

Fields

Modifier and Type	Field and Description
protected static Channel	CHANNEL
protected static org.apache.commons.io.filefilter.SuffixFileFilter	PROP_SUFFIX_FILE_FILTER
static java.lang.String	REVISION

Constructor Summary

Constructors

Constructor and Description
AbstractChecker()

Method Summary

Methods

Modifier and Type	Method and Description
static LangProperties	loadLanguageProperties(java.io.File webappDir)
static LangProperties	loadProperties(java.io.File webappDir) Loads all plugins' plugin.prop, custom.prop, and jcms.prop.
static LangProperties	loadProperties(java.io.File webappDir, org.apache.commons.io.filefilter.IOFileFilter fileFilter) Loads all plugins' plugin.prop, custom.prop, and jcms.prop, filtering on given fileFilter. Only accept *.prop file.
protected static void	saveError(CheckResult result, java.lang.String msg, org.apache.log4j.Logger logger) Logs the msg as warning Level, and append it to the global CheckResult object.

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

CHANNEL

protected static final Channel CHANNEL

PROP_SUFFIX_FILE_FILTER

protected static final org.apache.commons.io.filefilter.SuffixFileFilter PROP_SUFFIX_FILE_FILTER

Constructor Detail

AbstractChecker

public AbstractChecker()

Method Detail

saveError

protected static void saveError(CheckResult result,
             java.lang.String msg,
             org.apache.log4j.Logger logger)

Logs the msg as warning Level, and append it to the global CheckResult object.

Parameters:

result - the global check result.

msg - the error description

logger - the logger to use for warning

Since:

jcms-8.0.3, jcms-9.0.0

loadProperties

public static LangProperties loadProperties(java.io.File webappDir)
                                     throws java.io.IOException

Loads all plugins' plugin.prop, custom.prop, and jcms.prop.

Parameters:

webappDir - the webapp dir to load properties from.

Returns:

loaded properties

Throws:

java.io.IOException - if an exception occurs while loading properties

loadProperties

public static LangProperties loadProperties(java.io.File webappDir,
                            org.apache.commons.io.filefilter.IOFileFilter fileFilter)
                                     throws java.io.IOException

Loads all plugins' plugin.prop, custom.prop, and jcms.prop, filtering on given fileFilter.
Only accept *.prop file.

Parameters:

webappDir - the webapp dir to load properties from.

fileFilter - an optional user FileFilter to escape property file(s) (add is not possible since we use a AndFileFilter computation)

Returns:

loaded properties

Throws:

java.io.IOException - if an exception occurs while loading properties

loadLanguageProperties

public static LangProperties loadLanguageProperties(java.io.File webappDir)
                                             throws java.io.IOException

Throws:

java.io.IOException