org.mule.runtime.config.spring

Class XmlConfigurationDocumentLoader

java.lang.Object

org.mule.runtime.config.spring.XmlConfigurationDocumentLoader

public 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(Optional, String, InputStream) will throw an exception containing all the errors.

Since:

4.0

See Also:

#loadDocument(Optional, String, InputStream)}

Constructor Summary

Constructors

Constructor and Description
XmlConfigurationDocumentLoader() Creates an XmlConfigurationDocumentLoader using the default DefaultXmlGathererErrorHandlerFactory to instantiate XmlGathererErrorHandlers objects when executing the loadDocument(Optional, String, InputStream) method.
XmlConfigurationDocumentLoader(XmlGathererErrorHandlerFactory xmlGathererErrorHandlerFactory) Creates an XmlConfigurationDocumentLoader using a parametrized XmlGathererErrorHandlerFactory to instantiate XmlGathererErrorHandlers objects when executing the loadDocument(Optional, String, InputStream) method.

Method Summary

Modifier and Type	Method and Description
Document	loadDocument(Optional<ExtensionManager> extensionManager, String filename, InputStream inputStream) Creates a Document from an InputStream with the required configuration of a mule configuration file parsing.
Document	loadDocument(String filename, InputStream inputStream) Creates a Document from an InputStream with the required configuration of a mule configuration file parsing.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlConfigurationDocumentLoader

public XmlConfigurationDocumentLoader()

Creates an XmlConfigurationDocumentLoader using the default DefaultXmlGathererErrorHandlerFactory to instantiate XmlGathererErrorHandlers objects when executing the loadDocument(Optional, 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.

XmlConfigurationDocumentLoader

public XmlConfigurationDocumentLoader(XmlGathererErrorHandlerFactory xmlGathererErrorHandlerFactory)

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

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

Parameters:

xmlGathererErrorHandlerFactory - to create XmlGathererErrorHandler in the loadDocument(Optional, String, InputStream)

Method Detail

loadDocument

public Document loadDocument(String filename,
                             InputStream inputStream)

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

Parameters:

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 DocumentLoader factory, or if the current filename contains 1 or more errors.

See Also:

DefaultXmlLoggerErrorHandler#getErrors()}

loadDocument

public Document loadDocument(Optional<ExtensionManager> extensionManager,
                             String filename,
                             InputStream inputStream)

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

Parameters:

extensionManager - if the current inputStream relies in other schemas pending to be loaded from an

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 DocumentLoader factory, or if the current filename contains 1 or more errors.

See Also:

DefaultXmlLoggerErrorHandler#getErrors()}