|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.struts.plugins.ModuleConfigVerifier
Convenient implementation of PlugIn
that performs as many
verification tests on the information stored in the ModuleConfig
for this application 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()
.
Field Summary | |
protected ModuleConfig |
config
The ModuleConfig instance for our application module. |
private boolean |
fatal
Should the existence of configuration errors be fatal. |
protected ActionServlet |
servlet
The ActionServlet instance we are associated with. |
Constructor Summary | |
ModuleConfigVerifier()
|
Method Summary | |
void |
destroy()
Receive notification that our owning module is being shut down. |
void |
init(ActionServlet servlet,
ModuleConfig config)
Receive notification that the specified module is being started up. |
boolean |
isFatal()
Return the "configuation errors are fatal" flag. |
protected void |
log(java.lang.String message)
Log the specified message to our servlet context log, after a header including the module prefix. |
void |
setFatal(boolean fatal)
Set the "configuration errors are fatal" flag. |
protected boolean |
verifyActionMappingClass()
Return true if information returned by
config.getActionMappingClass() is all valid;
otherwise, log error messages and return false . |
protected boolean |
verifyForwardConfigs()
Return true if information returned by
config.findForwardConfigs() is all valid;
otherwise, log error messages and return |
protected boolean |
verifyMessageResourcesConfigs()
Return true if information returned by
config.findMessageResourcesConfigs() is all valid;
otherwise, log error messages and return |
protected boolean |
verifyPlugInConfigs()
Return true if information returned by
config.findPluginConfigs() is all valid;
otherwise, log error messages and return |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected ModuleConfig config
The ModuleConfig
instance for our application module.
protected ActionServlet servlet
The ActionServlet
instance we are associated with.
private boolean fatal
Should the existence of configuration errors be fatal.
Constructor Detail |
public ModuleConfigVerifier()
Method Detail |
public boolean isFatal()
Return the "configuation errors are fatal" flag.
public void setFatal(boolean fatal)
Set the "configuration errors are fatal" flag.
fatal
- The new flag valuepublic void destroy()
Receive notification that our owning module is being shut down.
destroy
in interface PlugIn
public void init(ActionServlet servlet, ModuleConfig config) throws javax.servlet.ServletException
Receive notification that the specified module is being started up.
init
in interface PlugIn
servlet
- ActionServlet that is managing all the
modules in this web applicationconfig
- ModuleConfig for the module with which
this plug-in is associated
javax.servlet.ServletException
- if this PlugIn
cannot
be successfully initializedprotected void log(java.lang.String message)
Log the specified message to our servlet context log, after a header including the module prefix.
message
- The message to be loggedprotected boolean verifyActionMappingClass()
Return true
if information returned by
config.getActionMappingClass()
is all valid;
otherwise, log error messages and return false
.
protected boolean verifyForwardConfigs()
Return true
if information returned by
config.findForwardConfigs() is all valid;
otherwise, log error messages and return
false
.
protected boolean verifyMessageResourcesConfigs()
Return true
if information returned by
config.findMessageResourcesConfigs() is all valid;
otherwise, log error messages and return
false
.
protected boolean verifyPlugInConfigs()
Return true
if information returned by
config.findPluginConfigs() is all valid;
otherwise, log error messages and return
false
.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |