ModuleConfigVerifier (Apache Struts API Documentation)
Keywords: org.apache.struts.plugins.ModuleConfigVerifier,ModuleConfigVerifier class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts.plugins
Class ModuleConfigVerifier

    java.lang.Object
      |
      +--org.apache.struts.plugins.ModuleConfigVerifier

All Implemented Interfaces:
  PlugIn

public class ModuleConfigVerifier
extends java.lang.Object
implements PlugIn

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()`.

Since:
  Struts 1.1
Version:
  $Revision: 1.1 $ $Date: 2003-08-22 09:34:00 +0100 (Fri, 22 Aug 2003) $
Author:
  Craig R. McClanahan

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 `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`.`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### config

    protected ModuleConfig config

  The `ModuleConfig` instance for our application module.

### servlet

    protected ActionServlet servlet

  The `ActionServlet` instance we are associated with.

### fatal

    private boolean fatal

  Should the existence of configuration errors be fatal.

Constructor Detail

### ModuleConfigVerifier

    public ModuleConfigVerifier()

Method Detail

### isFatal

    public boolean isFatal()

  Return the "configuation errors are fatal" flag.

### setFatal

    public void setFatal(boolean fatal)

  Set the "configuration errors are fatal" flag.

  Parameters:
    `fatal` - The new flag value

### destroy

    public void destroy()

  Receive notification that our owning module is being shut down.

  Specified by:
    `destroy` in interface `PlugIn`

### init

    public void init(ActionServlet servlet,
                     ModuleConfig config)
              throws javax.servlet.ServletException

  Receive notification that the specified module is being started up.

  Specified by:
    `init` in interface `PlugIn`
  Parameters:
    `servlet` - ActionServlet that is managing all the modules in this web application
    `config` - ModuleConfig for the module with which this plug-in is associated
  Throws:
    `javax.servlet.ServletException` - if this `PlugIn` cannot be successfully initialized

### log

    protected void log(java.lang.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

### 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`.`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2003 - Apache Software Foundation