hudson.util.io
Class ParserConfigurator

java.lang.Object
  hudson.util.io.ParserConfigurator

All Implemented Interfaces:

ExtensionPoint, Serializable

Direct Known Subclasses:

XMLEntityResolver

public abstract class ParserConfigurator
extends Object
implements ExtensionPoint, Serializable

Configures XML parsers to be used for various XML parsing activities inside Jenkins.

XML parsing is a complex enough activity that often certain degree of customization of the parsing behaviour is desired. This extension point enables that. To avoid creating new extension point for each different parsing scene, this extension point takes the type-less "context" argument, which should identify the context of the parse by type.

This extension point is added late in the game, so existing XML parsing behaviour should be retrofitted to use this as we find them. Similarly, additional overloaded versions are likely needed to support SAX, JAXP, and other means of parsing.

Since:

1.416

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

ParserConfigurator()

Method Summary

static ExtensionList<ParserConfigurator>	all() Returns all the registered ParserConfigurators.
static void	applyConfiguration(org.dom4j.io.SAXReader reader, Object context)
void	configure(org.dom4j.io.SAXReader reader, Object context) Configures the given SAXReader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParserConfigurator

public ParserConfigurator()

Method Detail

configure

public void configure(org.dom4j.io.SAXReader reader,
                      Object context)

Configures the given SAXReader

Parameters:

context - Object that represents the context in which the parser is used. It is up to the caller to decide what to pass in here.

all

public static ExtensionList<ParserConfigurator> all()

Returns all the registered ParserConfigurators.

applyConfiguration

public static void applyConfiguration(org.dom4j.io.SAXReader reader,
                                      Object context)
                               throws IOException,
                                      InterruptedException

Throws:

IOException

InterruptedException