org.forgerock.openam.utils

Interface DocumentBuilderProvider

public interface DocumentBuilderProvider

Abstract factory interface for supplying configured DocumentBuilder instances. The underlying implementation may cache or pool instances for performance.

Note: usually you will want to use the PerThreadDocumentBuilderProvider wrapped around a SafeDocumentBuilderProvider.

Method Summary

Modifier and Type	Method and Description
DocumentBuilder	getDocumentBuilder(boolean validating) Gets a pre-configured DocumentBuilder from the underlying implementation.

Method Detail

getDocumentBuilder

DocumentBuilder getDocumentBuilder(boolean validating)
                            throws ParserConfigurationException

Gets a pre-configured DocumentBuilder from the underlying implementation. Note: DocumentBuilder instances are not thread-safe and so should not shared between threads. Multiple calls to this method on the same provider from the same thread may return the same instance, but are not required to.

Parameters:

validating - Whether the returned document builder should perform XML validation or not.

Returns:

a pre-configured document builder.

Throws:

ParserConfigurationException - if there is an error configuring the document builder.