org.apache.struts.plugins

Class ModuleConfigVerifier

public class ModuleConfigVerifier extends Object implements PlugIn

Convenient implementation of PlugIn that performs as many verification tests on the information stored in the ModuleConfig for this module as is practical. Based on the setting of the fatal property (which defaults to true), the detection of any such errors will cause a ServletException to be thrown from the init method, which will ultimately cause the initialization of your Struts controller servlet to fail.

Under all circumstances, errors that are detected will be logged via calls to ServletContext.log.

Since: Struts 1.1

Version: $Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $

Field Summary
protected ModuleConfigconfig

The ModuleConfig instance for our module.

booleanfatal

Should the existence of configuration errors be fatal.

protected ActionServletservlet

The ActionServlet instance we are associated with.

Method Summary
voiddestroy()

Receive notification that our owning module is being shut down.

voidinit(ActionServlet servlet, ModuleConfig config)
booleanisFatal()

Return the "configuation errors are fatal" flag.

protected voidlog(String message)

Log the specified message to our servlet context log, after a header including the module prefix.

voidsetFatal(boolean fatal)

Set the "configuration errors are fatal" flag.

protected booleanverifyActionMappingClass()

Return true if information returned by config.getActionMappingClass is all valid; otherwise, log error messages and return false.

protected booleanverifyForwardConfigs()

Return true if information returned by config.findForwardConfigs is all valid; otherwise, log error messages and return false.

protected booleanverifyMessageResourcesConfigs()

Return true if information returned by config.findMessageResourcesConfigs is all valid; otherwise, log error messages and return false.

protected booleanverifyPlugInConfigs()

Return true if information returned by config.findPluginConfigs is all valid; otherwise, log error messages and return false.

Field Detail

config

protected ModuleConfig config

The ModuleConfig instance for our module.

fatal

private boolean fatal

Should the existence of configuration errors be fatal.

servlet

protected ActionServlet servlet

The ActionServlet instance we are associated with.

Method Detail

destroy

public void destroy()

Receive notification that our owning module is being shut down.

init

public void init(ActionServlet servlet, ModuleConfig config)

isFatal

public boolean isFatal()

Return the "configuation errors are fatal" flag.

log

protected void log(String message)

Log the specified message to our servlet context log, after a header including the module prefix.

Parameters: message The message to be logged

setFatal

public void setFatal(boolean fatal)

Set the "configuration errors are fatal" flag.

Parameters: fatal The new flag value

verifyActionMappingClass

protected boolean verifyActionMappingClass()

Return true if information returned by config.getActionMappingClass is all valid; otherwise, log error messages and return false.

verifyForwardConfigs

protected boolean verifyForwardConfigs()

Return true if information returned by config.findForwardConfigs is all valid; otherwise, log error messages and return false.

verifyMessageResourcesConfigs

protected boolean verifyMessageResourcesConfigs()

Return true if information returned by config.findMessageResourcesConfigs is all valid; otherwise, log error messages and return false.

verifyPlugInConfigs

protected boolean verifyPlugInConfigs()

Return true if information returned by config.findPluginConfigs is all valid; otherwise, log error messages and return false.

Copyright B) 2000-2009 - The Apache Software Foundation