Package org.infinispan.configuration.parsing

Class ParserRegistry

java.lang.Object

org.infinispan.configuration.parsing.ParserRegistry

All Implemented Interfaces:

NamespaceMappingParser

public class ParserRegistry
extends java.lang.Object
implements NamespaceMappingParser

ParserRegistry is a namespace-mapping-aware meta-parser which provides a way to delegate the parsing of multi-namespace XML files to appropriate parsers, defined by the ConfigurationParser interface. A registry of available parsers is built using the ServiceLoader system. Implementations of ConfigurationParser should include a META-INF/services/org.infinispan.configuration.parsing.ConfigurationParser file containing a list of available parsers.

Since:

5.2

Author:

Tristan Tarrant

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParserRegistry.NamespaceParserPair

Constructor Summary

Constructors

Constructor	Description
ParserRegistry()
ParserRegistry(java.lang.ClassLoader classLoader)
ParserRegistry(java.lang.ClassLoader classLoader, boolean defaultOnly, java.util.Properties properties)

Method Summary

Modifier and Type	Method	Description
ConfigurationBuilderHolder	parse(java.io.InputStream is, ConfigurationBuilderHolder holder, XMLResourceResolver resourceResolver)
ConfigurationBuilderHolder	parse(java.io.InputStream is, XMLResourceResolver resourceResolver)	Parses the supplied InputStream returning a new ConfigurationBuilderHolder
ConfigurationBuilderHolder	parse(java.lang.String s)
ConfigurationBuilderHolder	parse(java.net.URL url)
ConfigurationBuilderHolder	parse(java.net.URL url, ConfigurationBuilderHolder holder)
ConfigurationBuilderHolder	parse(XMLExtendedStreamReader reader, ConfigurationBuilderHolder holder)
void	parseElement(XMLExtendedStreamReader reader, ConfigurationBuilderHolder holder)	Recursively parses the current element of an XML stream using an appropriate ConfigurationParser depending on the element's namespace.
ConfigurationBuilderHolder	parseFile(java.io.File file)
ConfigurationBuilderHolder	parseFile(java.lang.String filename)
void	serialize(java.io.OutputStream os, java.lang.String name, Configuration configuration)	Serializes a single configuration to an OutputStream
void	serialize(java.io.OutputStream os, GlobalConfiguration globalConfiguration, java.util.Map<java.lang.String,Configuration> configurations)	Serializes a full configuration to an OutputStream
java.lang.String	serialize(java.lang.String name, Configuration configuration)	Serializes a single configuration to a String
void	serialize(XMLExtendedStreamWriter writer, GlobalConfiguration globalConfiguration, java.util.Map<java.lang.String,Configuration> configurations)	Serializes a full configuration to an XMLExtendedStreamWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

ParserRegistry

public ParserRegistry()

ParserRegistry

public ParserRegistry(java.lang.ClassLoader classLoader)

ParserRegistry

public ParserRegistry(java.lang.ClassLoader classLoader,
                      boolean defaultOnly,
                      java.util.Properties properties)

Method Detail

parse

public ConfigurationBuilderHolder parse(java.net.URL url)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseFile

public ConfigurationBuilderHolder parseFile(java.lang.String filename)
                                     throws java.io.IOException

Throws:

java.io.IOException

parseFile

public ConfigurationBuilderHolder parseFile(java.io.File file)
                                     throws java.io.IOException

Throws:

java.io.IOException

parse

public ConfigurationBuilderHolder parse(java.lang.String s)

parse

public ConfigurationBuilderHolder parse(java.io.InputStream is,
                                        XMLResourceResolver resourceResolver)

Parses the supplied InputStream returning a new ConfigurationBuilderHolder

Parameters:

is - an InputStream pointing to a configuration file

resourceResolver - an optional resolver for Xinclude

Returns:

a new ConfigurationBuilderHolder which contains the parsed configuration

parse

public ConfigurationBuilderHolder parse(java.net.URL url,
                                        ConfigurationBuilderHolder holder)
                                 throws java.io.IOException,
                                        javax.xml.stream.XMLStreamException

Throws:

java.io.IOException

javax.xml.stream.XMLStreamException

parse

public ConfigurationBuilderHolder parse(java.io.InputStream is,
                                        ConfigurationBuilderHolder holder,
                                        XMLResourceResolver resourceResolver)
                                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parse

public ConfigurationBuilderHolder parse(XMLExtendedStreamReader reader,
                                        ConfigurationBuilderHolder holder)
                                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

parseElement

public void parseElement(XMLExtendedStreamReader reader,
                         ConfigurationBuilderHolder holder)
                  throws javax.xml.stream.XMLStreamException

Description copied from interface: NamespaceMappingParser

Recursively parses the current element of an XML stream using an appropriate ConfigurationParser depending on the element's namespace.

Specified by:

parseElement in interface NamespaceMappingParser

Parameters:

reader - the XML stream reader

holder - a configuration holder

Throws:

javax.xml.stream.XMLStreamException

serialize

public void serialize(java.io.OutputStream os,
                      GlobalConfiguration globalConfiguration,
                      java.util.Map<java.lang.String,Configuration> configurations)
               throws javax.xml.stream.XMLStreamException

Serializes a full configuration to an OutputStream

Parameters:

os - the output stream where the configuration should be serialized to

globalConfiguration - the global configuration. Can be null

configurations - a map of named configurations

Throws:

javax.xml.stream.XMLStreamException

serialize

public void serialize(XMLExtendedStreamWriter writer,
                      GlobalConfiguration globalConfiguration,
                      java.util.Map<java.lang.String,Configuration> configurations)
               throws javax.xml.stream.XMLStreamException

Serializes a full configuration to an XMLExtendedStreamWriter

Parameters:

writer - the writer where the configuration should be serialized to

globalConfiguration - the global configuration. Can be null

configurations - a map of named configurations

Throws:

javax.xml.stream.XMLStreamException

serialize

public void serialize(java.io.OutputStream os,
                      java.lang.String name,
                      Configuration configuration)
               throws javax.xml.stream.XMLStreamException

Serializes a single configuration to an OutputStream

Parameters:

os -

name -

configuration -

Throws:

javax.xml.stream.XMLStreamException

serialize

public java.lang.String serialize(java.lang.String name,
                                  Configuration configuration)

Serializes a single configuration to a String

Parameters:

name - the name of the configuration

configuration - the Configuration

Returns:

the XML representation of the specified configuration