org.apache.struts.validator

Class ValidatorPlugIn

Implemented Interfaces:
PlugIn

public class ValidatorPlugIn
extends java.lang.Object
implements PlugIn

Loads ValidatorResources based on configuration in the struts-config.xml file.
Version:
$Rev: 105785 $ $Date: 2004-11-19 06:58:36 +0000 (Fri, 19 Nov 2004) $
Since:
Struts 1.1

Field Summary

private static String
RESOURCE_DELIM
Delimitter for Validator resources.
static String
STOP_ON_ERROR_KEY
Application scope key that StopOnError is stored under.
static String
VALIDATOR_KEY
Application scope key that ValidatorResources is stored under.
private ModuleConfig
config
The module configuration for our owning module.
private static Log
log
Commons Logging instance.
private String
pathnames
A comma delimitted list of Validator resource.
protected ValidatorResources
resources
The set of Form instances that have been created and initialized, keyed by the struts form name.
private ActionServlet
servlet
The ActionServlet owning this application.
private boolean
stopOnFirstError
Informs the Validators if it has to stop validation when finding the first error or if it should continue.

Method Summary

void
destroy()
Gracefully shut down, releasing any resources that were allocated at initialization.
protected void
destroyResources()
Destroy ValidatorResources.
String
getPathnames()
Gets a comma delimitted list of Validator resources.
void
init(ActionServlet servlet, ModuleConfig config)
Initialize and load our resources.
protected void
initResources()
Initialize the validator resources for this module.
boolean
isStopOnFirstError()
Gets the value for stopOnFirstError.
void
setPathnames(String pathnames)
Sets a comma delimitted list of Validator resources.
void
setStopOnFirstError(boolean stopOnFirstError)
Sets the value for stopOnFirstError.

Field Details

RESOURCE_DELIM

private static final String RESOURCE_DELIM
Delimitter for Validator resources.

STOP_ON_ERROR_KEY

public static final String STOP_ON_ERROR_KEY
Application scope key that StopOnError is stored under.
Since:
Struts 1.2

VALIDATOR_KEY

public static final String VALIDATOR_KEY
Application scope key that ValidatorResources is stored under.

config

private ModuleConfig config
The module configuration for our owning module.

log

private static Log log
Commons Logging instance.

pathnames

private String pathnames
A comma delimitted list of Validator resource.

resources

protected ValidatorResources resources
The set of Form instances that have been created and initialized, keyed by the struts form name.

servlet

private ActionServlet servlet
The ActionServlet owning this application.

stopOnFirstError

private boolean stopOnFirstError
Informs the Validators if it has to stop validation when finding the first error or if it should continue. Default to true to keep Struts 1.1 backwards compatibility.

Method Details

destroy

public void destroy()
Gracefully shut down, releasing any resources that were allocated at initialization.
Specified by:
destroy in interface PlugIn

destroyResources

protected void destroyResources()
Destroy ValidatorResources.

getPathnames

public String getPathnames()
Gets a comma delimitted list of Validator resources.
Returns:
comma delimited list of Validator resource path names

init

public void init(ActionServlet servlet,
                 ModuleConfig config)
            throws ServletException
Initialize and load our resources.
Specified by:
init in interface PlugIn
Parameters:
servlet - The ActionServlet for our application
config - The ModuleConfig for our owning module

initResources

protected void initResources()
            throws IOException,
                   ServletException
Initialize the validator resources for this module.

isStopOnFirstError

public boolean isStopOnFirstError()
Gets the value for stopOnFirstError.
Returns:
A boolean indicating whether JavaScript validation should stop when it finds the first error (Struts 1.1 behaviour) or continue validation.
Since:
Struts 1.2

setPathnames

public void setPathnames(String pathnames)
Sets a comma delimitted list of Validator resources.
Parameters:
pathnames - delimited list of Validator resource path names

setStopOnFirstError

public void setStopOnFirstError(boolean stopOnFirstError)
Sets the value for stopOnFirstError.
Parameters:
stopOnFirstError - A boolean indicating whether JavaScript validation should stop when it finds the first error (Struts 1.1 behaviour) or continue validation.
Since:
Struts 1.2

Copyright B) 2000-2007 - The Apache Software Foundation