org.apache.struts.plugins
public class DigestingPlugIn extends Object implements PlugIn
An implementation of PlugIn
which
can be configured to instantiate a graph of objects
using the Commons Digester and place the root object
of that graph into the Application context.
Since: Struts 1.2
Version: $Rev: 164530 $
See Also: PlugIn
Field Summary | |
---|---|
protected String | configPath |
protected String | configSource |
protected String | digesterPath |
protected String | digesterSource |
protected String | key |
static Log | log
Commons Logging instance. |
protected ModuleConfig | moduleConfig |
protected boolean | push |
protected String | rulesets |
protected ActionServlet | servlet |
protected static String | SOURCE_CLASSPATH |
protected static String | SOURCE_FILE |
protected static String | SOURCE_SERVLET |
Constructor Summary | |
---|---|
DigestingPlugIn()
Constructor for DigestingPlugIn. |
Method Summary | |
---|---|
protected void | applyRuleSets(Digester digester)
Instantiate any RuleSet classes defined in the
rulesets property and use them to add rules to our
Digester . |
void | destroy()
Receive notification that our owning module is being shut down. |
protected Digester | digesterFromXml(String path, String source) Instantiate a Digester from an XML input stream using the Commons
|
protected URL | getClassPathURL(String path)
Given a string, return a URL to a classpath resource of that name. |
String | getConfigPath() |
String | getConfigSource() |
protected URL | getConfigURL(String path, String source) Look up a resource path using one of a set of known path resolution mechanisms and return a URL to the resource. |
String | getDigesterPath() |
String | getDigesterSource() |
protected URL | getFileURL(String path)
Given a string, return a URL to a Filesystem resource of that name. |
String | getKey() |
boolean | getPush() |
String | getRulesets() |
protected URL | getServletContextURL(String path)
Given a string, return a URL to a Servlet Context resource of that name. |
void | init(ActionServlet servlet, ModuleConfig config) Initialize a |
protected Digester | initializeDigester()
Initialize the Digester which will be used to process the
main configuration. |
protected Digester | newDigesterInstance() Instantiate a Subclasses may wish to override this to provide a subclass of Digester, or to configure the Digester using object methods. |
void | setConfigPath(String configPath) |
void | setConfigSource(String configSource)
Set the source of the config file. |
void | setDigesterPath(String digesterPath) The path to a Digester XML configuration file, relative to the
|
void | setDigesterSource(String digesterSource) The lookup mechanism to be used to resolve |
void | setKey(String key) |
void | setPush(boolean push) If set to Defaults to |
void | setRulesets(String ruleSets) A comma-delimited list of one or more classes which implement
|
protected void | storeGeneratedObject(Object obj)
This method is called after the Digester runs to store the generated
object somewhere. |
RuleSet
classes defined in the
rulesets
property and use them to add rules to our
Digester
.Parameters: digester the Digester instance to add RuleSet objects to.
Throws: ServletException
Instantiate a Digester from an XML input stream using the Commons
DigesterLoader
.
Parameters: path the path to the digester rules XML to be found using source
source a string indicating the lookup method to be used with path
Returns: a configured Digester
Throws: FileNotFoundException MalformedURLException
See Also: DigestingPlugIn
Parameters: path a Classpath-relative string identifying a resource.
Returns: a URL identifying the resource on the classpath. TODO Do we need to be smarter about ClassLoaders?
Returns: the configPath property
See Also: configSource
Returns: the string describing which access method should be used to resolve configPath.
See Also: configPath
Look up a resource path using one of a set of known path resolution mechanisms and return a URL to the resource.
Parameters: path a String which is meaningful to one of the known resolution mechanisms. source one of the known path resolution mechanisms:
Returns: a URL pointing to the given path in the given mechanism.
Throws: FileNotFoundException MalformedURLException
Returns: the configured path to a Digester XML config file, or null.
See Also: digesterSource DigestingPlugIn
Returns: the configured lookup mechanism for resolving
digesterPath
.
See Also: DigestingPlugIn
Parameters: path a path to a file.
Returns: a URL identifying the resource in the in the file system.
Throws: MalformedURLException FileNotFoundException
Returns: The ServletContext attribute name the generated object is stored under.
Returns: Whether or not this PlugIn
instance will be pushed
onto the Digester
stack before digester.parse()
is called.
Returns: The configured list of RuleSet
classes.
Parameters: path a Classpath-relative string identifying a resource.
Returns: a URL identifying the resource in the Servlet Context
Throws: MalformedURLException
Initialize a Digester
and use it to parse a
configuration file, resulting in a root object which will be placed into
the ServletContext.
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: ServletException if this PlugIn
cannot
be successfully initialized
Digester
which will be used to process the
main configuration.Returns: a Digester, ready to use.
Throws: ServletException
Instantiate a Digester
.
Subclasses may wish to override this to provide a subclass of Digester, or to configure the Digester using object methods.
Returns: a basic instance of org.apache.commons.digester.Digester
Parameters: configPath the path to configuration information for this PlugIn.
See Also: configSource
Parameters: configSource the source (lookup method) for the config file.
See Also: configPath
The path to a Digester XML configuration file, relative to the
digesterSource
property. (Optional)
See Also: digesterSource DigestingPlugIn
The lookup mechanism to be used to resolve digesterPath
(optional).
Parameters: digesterSource
See Also: DigestingPlugIn
Parameters: key The ServletContext attribute name to store the generated object under.
If set to true
, this PlugIn will be pushed onto
the Digester stack before the digester parse
method is
called.
Defaults to false
Parameters: push
A comma-delimited list of one or more classes which implement
org.apache.commons.digester.RuleSet
. (Optional)
key
.Parameters: obj The object to save.