Class ParserRegistry

java.lang.Object

org.infinispan.configuration.parsing.ParserRegistry

All Implemented Interfaces:

NamespaceMappingParser

public class ParserRegistry
extends 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
static class	ParserRegistry.QName

Constructor Summary

Constructors

Constructor	Description
ParserRegistry()
ParserRegistry(ClassLoader classLoader)
ParserRegistry(ClassLoader classLoader, boolean defaultOnly, Properties properties)

Method Summary

Modifier and Type	Method	Description
ConfigurationBuilderHolder	parse(InputStream is, ConfigurationResourceResolver resourceResolver, MediaType mediaType)	Parses the supplied InputStream returning a new ConfigurationBuilderHolder
ConfigurationBuilderHolder	parse(InputStream is, MediaType mediaType)	Parses the supplied InputStream returning a new ConfigurationBuilderHolder.
ConfigurationBuilderHolder	parse(InputStream is, ConfigurationBuilderHolder holder, ConfigurationResourceResolver resourceResolver, MediaType mediaType)
ConfigurationBuilderHolder	parse(String s)
ConfigurationBuilderHolder	parse(String s, MediaType mediaType)
ConfigurationBuilderHolder	parse(URL url)
ConfigurationBuilderHolder	parse(URL url, ConfigurationBuilderHolder holder)
ConfigurationBuilderHolder	parse(Path path)
ConfigurationBuilderHolder	parse(ConfigurationReader reader, ConfigurationBuilderHolder holder)
void	parseAttribute(ConfigurationReader reader, int i, ConfigurationBuilderHolder holder)	Handle a namespaced attribute
void	parseElement(ConfigurationReader reader, ConfigurationBuilderHolder holder)	Recursively parses the current element of an XML stream using an appropriate ConfigurationParser depending on the element's namespace.
ConfigurationBuilderHolder	parseFile(File file)
ConfigurationBuilderHolder	parseFile(String filename)
void	serialize(OutputStream os, String name, Configuration configuration)	Deprecated, for removal: This API element is subject to removal in a future version. use serialize(ConfigurationWriter, GlobalConfiguration, Map) instead
void	serialize(OutputStream os, GlobalConfiguration globalConfiguration, Map<String, Configuration> configurations)	Deprecated, for removal: This API element is subject to removal in a future version. use serialize(ConfigurationWriter, GlobalConfiguration, Map) instead
String	serialize(String name, Configuration configuration)	Deprecated, for removal: This API element is subject to removal in a future version. use serialize(ConfigurationWriter, GlobalConfiguration, Map) instead
void	serialize(ConfigurationWriter writer, String name, Configuration configuration)	Serializes a single cache configuration
void	serialize(ConfigurationWriter writer, GlobalConfiguration globalConfiguration, Map<String, Configuration> configurations)	Serializes a full configuration to an ConfigurationWriter
<T> void	serializeWith(ConfigurationWriter writer, ConfigurationSerializer<T> serializer, T t)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ParserRegistry

public ParserRegistry()

ParserRegistry

public ParserRegistry(ClassLoader classLoader)

ParserRegistry

public ParserRegistry(ClassLoader classLoader,
 boolean defaultOnly,
 Properties properties)

Method Details

parse

public ConfigurationBuilderHolder parse(Path path)
                                 throws IOException

Throws:

IOException

parse

public ConfigurationBuilderHolder parse(URL url)
                                 throws IOException

Throws:

IOException

parseFile

public ConfigurationBuilderHolder parseFile(String filename)
                                     throws IOException

Throws:

IOException

parseFile

public ConfigurationBuilderHolder parseFile(File file)
                                     throws IOException

Throws:

IOException

parse

public ConfigurationBuilderHolder parse(String s)

parse

public ConfigurationBuilderHolder parse(String s,
 MediaType mediaType)

parse

public ConfigurationBuilderHolder parse(InputStream is,
 MediaType mediaType)

Parses the supplied InputStream returning a new ConfigurationBuilderHolder. This method uses a default ConfigurationResourceResolver.

Parameters:

is - an InputStream pointing to a configuration file

Returns:

a new ConfigurationBuilderHolder which contains the parsed configuration

parse

public ConfigurationBuilderHolder parse(InputStream is,
 ConfigurationResourceResolver resourceResolver,
 MediaType mediaType)

Parses the supplied InputStream returning a new ConfigurationBuilderHolder

Parameters:

is - an InputStream pointing to a configuration file

resourceResolver - a ConfigurationResourceResolver resolver for Xinclude

Returns:

a new ConfigurationBuilderHolder which contains the parsed configuration

parse

public ConfigurationBuilderHolder parse(URL url,
 ConfigurationBuilderHolder holder)
                                 throws IOException

Throws:

IOException

parse

public ConfigurationBuilderHolder parse(InputStream is,
 ConfigurationBuilderHolder holder,
 ConfigurationResourceResolver resourceResolver,
 MediaType mediaType)

parse

public ConfigurationBuilderHolder parse(ConfigurationReader reader,
 ConfigurationBuilderHolder holder)

parseElement

public void parseElement(ConfigurationReader reader,
 ConfigurationBuilderHolder holder)

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 configuration stream reader

holder - a configuration holder

parseAttribute

public void parseAttribute(ConfigurationReader reader,
 int i,
 ConfigurationBuilderHolder holder)
                    throws ConfigurationReaderException

Description copied from interface: NamespaceMappingParser

Handle a namespaced attribute

Specified by:

parseAttribute in interface NamespaceMappingParser

Parameters:

reader - the configuration stream reader

i - the index of the attribute

holder - a configuration holder

Throws:

ConfigurationReaderException

serialize

@Deprecated(forRemoval=true,
            since="14.0")
public void serialize(OutputStream os,
 GlobalConfiguration globalConfiguration,
 Map<String, Configuration> configurations)

Deprecated, for removal: This API element is subject to removal in a future version.

use serialize(ConfigurationWriter, GlobalConfiguration, Map) instead

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

serialize

public void serialize(ConfigurationWriter writer,
 GlobalConfiguration globalConfiguration,
 Map<String, Configuration> configurations)

Serializes a full configuration to an ConfigurationWriter

Parameters:

writer - the writer where the configuration should be serialized to

globalConfiguration - the global configuration. Can be null

configurations - a map of named configurations

serializeWith

public <T> void serializeWith(ConfigurationWriter writer,
 ConfigurationSerializer<T> serializer,
 T t)

serialize

@Deprecated(forRemoval=true,
            since="14.0")
public void serialize(OutputStream os,
 String name,
 Configuration configuration)

Deprecated, for removal: This API element is subject to removal in a future version.

use serialize(ConfigurationWriter, GlobalConfiguration, Map) instead

Serializes a single configuration to an OutputStream

Parameters:

os -

name -

configuration -

serialize

@Deprecated(forRemoval=true,
            since="14.0")
public String serialize(String name,
 Configuration configuration)

Deprecated, for removal: This API element is subject to removal in a future version.

use serialize(ConfigurationWriter, GlobalConfiguration, Map) instead

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

toString

public String toString()

Overrides:

toString in class Object

serialize

public void serialize(ConfigurationWriter writer,
 String name,
 Configuration configuration)

Serializes a single cache configuration

Parameters:

writer -

name -

configuration -