Module org.mule.runtime.dsl.api

Package org.mule.runtime.dsl.api.xml.parser

Class XmlConfigurationDocumentLoader

java.lang.Object

org.mule.runtime.dsl.api.xml.parser.XmlConfigurationDocumentLoader

public final class XmlConfigurationDocumentLoader
extends Object

Loads a mule configuration file into a Document object.

If when loading the configuration one, or more, ErrorHandler.error(SAXParseException) are call, at the end of loadDocument(Supplier, EntityResolver, String, InputStream) will throw an exception containing all the errors.

Since:

4.0

Method Summary

Modifier and Type	Method	Description
Document	loadDocument(Supplier<SAXParserFactory> saxParserFactorySupplier, String filename, InputStream inputStream, EntityResolver entityResolver)	Creates a Document from an InputStream with the required configuration of a mule configuration file parsing.
Document	loadDocument(Supplier<SAXParserFactory> saxParserFactorySupplier, EntityResolver entityResolver, String filename, InputStream inputStream)	Creates a Document from an InputStream with the required configuration of a mule configuration file parsing.
Document	loadDocument(Supplier<SAXParserFactory> saxParserFactorySupplier, EntityResolver entityResolver, String filename, InputStream inputStream, org.mule.apache.xerces.xni.grammars.XMLGrammarPool xmlGrammarPool)	Creates a Document from an InputStream with the required configuration of a mule configuration file parsing.
static XmlConfigurationDocumentLoader	noValidationDocumentLoader()	Creates an XmlConfigurationDocumentLoader that will ignore XSD validation when executing the loadDocument(Supplier, EntityResolver, String, InputStream) method.
static XmlConfigurationDocumentLoader	schemaValidatingDocumentLoader()	Creates an XmlConfigurationDocumentLoader using the default DefaultXmlGathererErrorHandlerFactory to instantiate XmlGathererErrorHandlers objects when executing the loadDocument(Supplier, EntityResolver, String, InputStream) method.
static XmlConfigurationDocumentLoader	schemaValidatingDocumentLoader(XmlGathererErrorHandlerFactory errorHandlerFactory)	Creates an XmlConfigurationDocumentLoader using a parametrized XmlGathererErrorHandlerFactory to instantiate XmlGathererErrorHandlers objects when executing the loadDocument(Supplier, EntityResolver, String, InputStream) method.

Methods inherited from class java.lang.Object

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

Method Details

schemaValidatingDocumentLoader

public static XmlConfigurationDocumentLoader schemaValidatingDocumentLoader()

Creates an XmlConfigurationDocumentLoader using the default DefaultXmlGathererErrorHandlerFactory to instantiate XmlGathererErrorHandlers objects when executing the loadDocument(Supplier, EntityResolver, String, InputStream) method.

Using the default constructor implies that all XSD validations will take place and, at the end of the parsing, all the errors will be contained in an MuleRuntimeException which will be thrown.

Returns:

a new instance of XmlConfigurationDocumentLoader

schemaValidatingDocumentLoader

public static XmlConfigurationDocumentLoader schemaValidatingDocumentLoader(XmlGathererErrorHandlerFactory errorHandlerFactory)

Creates an XmlConfigurationDocumentLoader using a parametrized XmlGathererErrorHandlerFactory to instantiate XmlGathererErrorHandlers objects when executing the loadDocument(Supplier, EntityResolver, String, InputStream) method.

Depending on what type of XmlGathererErrorHandler the factory returns, the loadDocument(Supplier, EntityResolver, String, InputStream) method will not thrown any exception if XmlGathererErrorHandler.getErrors() is an empty list.

Parameters:

errorHandlerFactory - to create XmlGathererErrorHandler in the loadDocument(Supplier, EntityResolver, String, InputStream)

Returns:

a new instance of XmlConfigurationDocumentLoader

noValidationDocumentLoader

public static XmlConfigurationDocumentLoader noValidationDocumentLoader()

Creates an XmlConfigurationDocumentLoader that will ignore XSD validation when executing the loadDocument(Supplier, EntityResolver, String, InputStream) method.

Returns:

a new instance of XmlConfigurationDocumentLoader

loadDocument

public Document loadDocument(Supplier<SAXParserFactory> saxParserFactorySupplier,
 String filename,
 InputStream inputStream,
 EntityResolver entityResolver)

Creates a Document from an InputStream with the required configuration of a mule configuration file parsing.

Parameters:

inputStream - the input stream with the XML configuration content.

Returns:

a new Document object with the provided content.

Throws:

org.mule.runtime.api.exception.MuleRuntimeException - if an error occurs in MuleDocumentLoader factory, or if the current filename contains 1 or more errors.

loadDocument

public Document loadDocument(Supplier<SAXParserFactory> saxParserFactorySupplier,
 EntityResolver entityResolver,
 String filename,
 InputStream inputStream)

Creates a Document from an InputStream with the required configuration of a mule configuration file parsing.

Parameters:

entityResolver - resolver for XML schemas.

filename - name of the file to display a better error messages (if there are any). Non null.

inputStream - the input stream with the XML configuration content.

Returns:

a new Document object with the provided content.

Throws:

org.mule.runtime.api.exception.MuleRuntimeException - if an error occurs in MuleDocumentLoader factory, or if the current filename contains 1 or more errors.

loadDocument

public Document loadDocument(Supplier<SAXParserFactory> saxParserFactorySupplier,
 EntityResolver entityResolver,
 String filename,
 InputStream inputStream,
 org.mule.apache.xerces.xni.grammars.XMLGrammarPool xmlGrammarPool)

Creates a Document from an InputStream with the required configuration of a mule configuration file parsing.

Parameters:

entityResolver - resolver for XML schemas.

filename - name of the file to display a better error messages (if there are any). Non null.

inputStream - the input stream with the XML configuration content.

xmlGrammarPool - a XMLGrammarPool pool to be used while file parsing.

Returns:

a new Document object with the provided content.

Throws:

org.mule.runtime.api.exception.MuleRuntimeException - if an error occurs in MuleDocumentLoader factory, or if the current filename contains 1 or more errors.