Spring Beans 6.1.4 · org.springframework.beans.factory.xml.XmlBeanDefinitionReader

Modifier and Type	Field and Description
private static final Map<String, Integer>	constants Map of constant names to constant values for the validation constants defined in this class.
private DocumentLoader	documentLoader
private Class<? extends BeanDefinitionDocumentReader>	documentReaderClass
private EntityResolver	entityResolver
private ErrorHandler	errorHandler
private ReaderEventListener	eventListener
private boolean	namespaceAware
private NamespaceHandlerResolver	namespaceHandlerResolver
private ProblemReporter	problemReporter
private final ThreadLocal<Set<EncodedResource>>	resourcesCurrentlyBeingLoaded
private SourceExtractor	sourceExtractor
public static final int	VALIDATION_AUTO Indicates that the validation mode should be detected automatically.
public static final int	VALIDATION_DTD Indicates that DTD validation should be used.
public static final int	VALIDATION_NONE Indicates that the validation should be disabled.
public static final int	VALIDATION_XSD Indicates that XSD validation should be used.
private int	validationMode
private final XmlValidationModeDetector	validationModeDetector

Access	Constructor and Description
public	XmlBeanDefinitionReader(BeanDefinitionRegistry the BeanFactory to load bean definitions into, in the form of a BeanDefinitionRegistry registry) Create new XmlBeanDefinitionReader for the given bean factory.

Method Summary

Modifier and Type	Method and Description
protected BeanDefinitionDocumentReader	createBeanDefinitionDocumentReader() Create the `BeanDefinitionDocumentReader` to use for actually reading bean definitions from an XML document.
protected NamespaceHandlerResolver	createDefaultNamespaceHandlerResolver() Create the default implementation of `NamespaceHandlerResolver` used if none is specified.
public XmlReaderContext	createReaderContext(Resource resource) Create the `XmlReaderContext` to pass over to the document reader.
protected int	detectValidationMode(Resource resource) Detect which kind of validation to perform on the XML file identified by the supplied `Resource`.
protected int	Returns: the number of bean definitions found doLoadBeanDefinitions(InputSource the SAX InputSource to read from inputSource, Resource the resource descriptor for the XML file resource) Actually load bean definitions from the specified XML file.
protected Document	Returns: the DOM Document doLoadDocument(InputSource the SAX InputSource to read from inputSource, Resource the resource descriptor for the XML file resource) Actually load the specified document using the configured DocumentLoader.
protected EntityResolver	getEntityResolver() Return the EntityResolver to use, building a default resolver if none specified.
public NamespaceHandlerResolver	getNamespaceHandlerResolver() Lazily create a default NamespaceHandlerResolver, if not set before.
public int	getValidationMode() Return the validation mode to use.
protected int	getValidationModeForResource(Resource resource) Determine the validation mode for the specified `Resource`.
public boolean	isNamespaceAware() Return whether the XML parser should be XML namespace aware.
public int	Returns: the number of bean definitions found loadBeanDefinitions(Resource the resource descriptor for the XML file resource) Implements org.springframework.beans.factory.support.BeanDefinitionReader.loadBeanDefinitions. Load bean definitions from the specified XML file.
public int	Returns: the number of bean definitions found loadBeanDefinitions(EncodedResource the resource descriptor for the XML file, allowing to specify an encoding to use for parsing the file encodedResource) Load bean definitions from the specified XML file.
public int	Returns: the number of bean definitions found loadBeanDefinitions(InputSource the SAX InputSource to read from inputSource) Load bean definitions from the specified XML file.
public int	Returns: the number of bean definitions found loadBeanDefinitions(InputSource the SAX InputSource to read from inputSource, String a description of the resource (can be `null` or empty) resourceDescription) Load bean definitions from the specified XML file.
public int	Returns: the number of bean definitions found registerBeanDefinitions(Document the DOM document doc, Resource the resource descriptor (for context information) resource) Register the bean definitions contained in the given DOM document.
public void	setDocumentLoader(DocumentLoader documentLoader) Specify the `DocumentLoader` to use.
public void	setDocumentReaderClass(Class<? extends BeanDefinitionDocumentReader> the desired BeanDefinitionDocumentReader implementation class documentReaderClass) Specify the `BeanDefinitionDocumentReader` implementation to use, responsible for the actual reading of the XML bean definition document.
public void	setEntityResolver(EntityResolver entityResolver) Set a SAX entity resolver to be used for parsing.
public void	setErrorHandler(ErrorHandler errorHandler) Set an implementation of the `org.xml.sax.ErrorHandler` interface for custom handling of XML parsing errors and warnings.
public void	setEventListener(ReaderEventListener eventListener) Specify which `ReaderEventListener` to use.
public void	setNamespaceAware(boolean namespaceAware) Set whether the XML parser should be XML namespace aware.
public void	setNamespaceHandlerResolver(NamespaceHandlerResolver namespaceHandlerResolver) Specify the `NamespaceHandlerResolver` to use.
public void	setProblemReporter(ProblemReporter problemReporter) Specify which `org.springframework.beans.factory.parsing.ProblemReporter` to use.
public void	setSourceExtractor(SourceExtractor sourceExtractor) Specify the `SourceExtractor` to use.
public void	setValidating(boolean validating) Set whether to use XML validation.
public void	setValidationMode(int validationMode) Set the validation mode to use.
public void	setValidationModeName(String validationModeName) Set the validation mode to use by name.

Inherited from org.springframework.beans.factory.support.AbstractBeanDefinitionReader:: getBeanClassLoader getBeanNameGenerator getEnvironment getRegistry getResourceLoader loadBeanDefinitions loadBeanDefinitions loadBeanDefinitions loadBeanDefinitions setBeanClassLoader setBeanNameGenerator setEnvironment setResourceLoader

constants	back to summary
private static final Map<String, Integer> constants Map of constant names to constant values for the validation constants defined in this class.

documentLoader	back to summary
private DocumentLoader documentLoader

documentReaderClass	back to summary
private Class<? extends BeanDefinitionDocumentReader> documentReaderClass

entityResolver	back to summary
private EntityResolver entityResolver Annotations @Nullable

errorHandler	back to summary
private ErrorHandler errorHandler

eventListener	back to summary
private ReaderEventListener eventListener

namespaceAware	back to summary
private boolean namespaceAware

namespaceHandlerResolver	back to summary
private NamespaceHandlerResolver namespaceHandlerResolver Annotations @Nullable

problemReporter	back to summary
private ProblemReporter problemReporter

resourcesCurrentlyBeingLoaded	back to summary
private final ThreadLocal<Set<EncodedResource>> resourcesCurrentlyBeingLoaded

sourceExtractor	back to summary
private SourceExtractor sourceExtractor

VALIDATION_AUTO	back to summary
public static final int VALIDATION_AUTO Indicates that the validation mode should be detected automatically.

VALIDATION_DTD	back to summary
public static final int VALIDATION_DTD Indicates that DTD validation should be used.

VALIDATION_NONE	back to summary
public static final int VALIDATION_NONE Indicates that the validation should be disabled.

VALIDATION_XSD	back to summary
public static final int VALIDATION_XSD Indicates that XSD validation should be used.

validationMode	back to summary
private int validationMode

validationModeDetector	back to summary
private final XmlValidationModeDetector validationModeDetector

XmlBeanDefinitionReader	back to summary
public XmlBeanDefinitionReader(BeanDefinitionRegistry registry) Create new XmlBeanDefinitionReader for the given bean factory. Parameters registry:BeanDefinitionRegistry the BeanFactory to load bean definitions into, in the form of a BeanDefinitionRegistry

Method Detail

createBeanDefinitionDocumentReader back to summary

createBeanDefinitionDocumentReader	back to summary
protected BeanDefinitionDocumentReader createBeanDefinitionDocumentReader() Create the `BeanDefinitionDocumentReader` to use for actually reading bean definitions from an XML document. The default implementation instantiates the specified "documentReaderClass". See Also `setDocumentReaderClass`

protected BeanDefinitionDocumentReader createBeanDefinitionDocumentReader()

Create the BeanDefinitionDocumentReader to use for actually reading bean definitions from an XML document.

The default implementation instantiates the specified "documentReaderClass".

See Also: setDocumentReaderClass

createDefaultNamespaceHandlerResolver back to summary

createDefaultNamespaceHandlerResolver	back to summary
protected NamespaceHandlerResolver createDefaultNamespaceHandlerResolver() Create the default implementation of `NamespaceHandlerResolver` used if none is specified. The default implementation returns an instance of `DefaultNamespaceHandlerResolver`. See Also `DefaultNamespaceHandlerResolver#DefaultNamespaceHandlerResolver(ClassLoader)`

protected NamespaceHandlerResolver createDefaultNamespaceHandlerResolver()

Create the default implementation of NamespaceHandlerResolver used if none is specified.

The default implementation returns an instance of DefaultNamespaceHandlerResolver.

See Also: DefaultNamespaceHandlerResolver#DefaultNamespaceHandlerResolver(ClassLoader)

createReaderContext	back to summary
public XmlReaderContext createReaderContext(Resource resource) Create the `XmlReaderContext` to pass over to the document reader.

detectValidationMode back to summary

detectValidationMode	back to summary
protected int detectValidationMode(Resource resource) Detect which kind of validation to perform on the XML file identified by the supplied `Resource`. If the file has a `DOCTYPE` definition then DTD validation is used otherwise XSD validation is assumed. Override this method if you would like to customize resolution of the `VALIDATION_AUTO` mode.

protected int detectValidationMode(Resource resource)

Detect which kind of validation to perform on the XML file identified by the supplied Resource. If the file has a DOCTYPE definition then DTD validation is used otherwise XSD validation is assumed.

Override this method if you would like to customize resolution of the VALIDATION_AUTO mode.

doLoadBeanDefinitions back to summary

doLoadBeanDefinitions	back to summary
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource) throws BeanDefinitionStoreException Actually load bean definitions from the specified XML file. Parameters inputSource:InputSource the SAX InputSource to read from resource:Resource the resource descriptor for the XML file Returns:int the number of bean definitions found Exceptions BeanDefinitionStoreException: in case of loading or parsing errors See Also `doLoadDocument`, `registerBeanDefinitions`

protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource) throws BeanDefinitionStoreException

Actually load bean definitions from the specified XML file.

Parameters

inputSource:InputSource: the SAX InputSource to read from
resource:Resource: the resource descriptor for the XML file

Returns:int

the number of bean definitions found

Exceptions

BeanDefinitionStoreException:: in case of loading or parsing errors

doLoadDocument back to summary

doLoadDocument	back to summary
protected Document doLoadDocument(InputSource inputSource, Resource resource) throws Exception Actually load the specified document using the configured DocumentLoader. Parameters inputSource:InputSource the SAX InputSource to read from resource:Resource the resource descriptor for the XML file Returns:Document the DOM Document Exceptions Exception: when thrown from the DocumentLoader See Also `setDocumentLoader`, `DocumentLoader#loadDocument`

protected Document doLoadDocument(InputSource inputSource, Resource resource) throws Exception

Actually load the specified document using the configured DocumentLoader.

Parameters

inputSource:InputSource: the SAX InputSource to read from
resource:Resource: the resource descriptor for the XML file

Returns:Document

the DOM Document

Exceptions

Exception:: when thrown from the DocumentLoader

getEntityResolver	back to summary
protected EntityResolver getEntityResolver() Return the EntityResolver to use, building a default resolver if none specified.

getNamespaceHandlerResolver back to summary

getNamespaceHandlerResolver	back to summary
public NamespaceHandlerResolver getNamespaceHandlerResolver() Lazily create a default NamespaceHandlerResolver, if not set before. See Also `createDefaultNamespaceHandlerResolver()`

public NamespaceHandlerResolver getNamespaceHandlerResolver()

Lazily create a default NamespaceHandlerResolver, if not set before.

See Also: createDefaultNamespaceHandlerResolver()

getValidationMode	back to summary
public int getValidationMode() Return the validation mode to use.

getValidationModeForResource back to summary

getValidationModeForResource	back to summary
protected int getValidationModeForResource(Resource resource) Determine the validation mode for the specified `Resource`. If no explicit validation mode has been configured, then the validation mode gets `detected` from the given resource. Override this method if you would like full control over the validation mode, even when something other than `VALIDATION_AUTO` was set. See Also `detectValidationMode`

protected int getValidationModeForResource(Resource resource)

Determine the validation mode for the specified Resource. If no explicit validation mode has been configured, then the validation mode gets detected from the given resource.

Override this method if you would like full control over the validation mode, even when something other than VALIDATION_AUTO was set.

See Also: detectValidationMode

isNamespaceAware	back to summary
public boolean isNamespaceAware() Return whether the XML parser should be XML namespace aware.

loadBeanDefinitions	back to summary
public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException Implements org.springframework.beans.factory.support.BeanDefinitionReader.loadBeanDefinitions. Load bean definitions from the specified XML file. Parameters resource:Resource the resource descriptor for the XML file Returns:int the number of bean definitions found Annotations @Override Exceptions BeanDefinitionStoreException: in case of loading or parsing errors

loadBeanDefinitions

back to summary

public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException

Implements org.springframework.beans.factory.support.BeanDefinitionReader.loadBeanDefinitions.

Load bean definitions from the specified XML file.

Parameters

resource:Resource: the resource descriptor for the XML file

Returns:int

the number of bean definitions found

Annotations

@Override

Exceptions

BeanDefinitionStoreException:: in case of loading or parsing errors

loadBeanDefinitions	back to summary
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException Load bean definitions from the specified XML file. Parameters encodedResource:EncodedResource the resource descriptor for the XML file, allowing to specify an encoding to use for parsing the file Returns:int the number of bean definitions found Exceptions BeanDefinitionStoreException: in case of loading or parsing errors

loadBeanDefinitions

back to summary

public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException

Load bean definitions from the specified XML file.

Parameters

encodedResource:EncodedResource: the resource descriptor for the XML file, allowing to specify an encoding to use for parsing the file

Returns:int

the number of bean definitions found

Exceptions

BeanDefinitionStoreException:: in case of loading or parsing errors

loadBeanDefinitions	back to summary
public int loadBeanDefinitions(InputSource inputSource) throws BeanDefinitionStoreException Load bean definitions from the specified XML file. Parameters inputSource:InputSource the SAX InputSource to read from Returns:int the number of bean definitions found Exceptions BeanDefinitionStoreException: in case of loading or parsing errors

loadBeanDefinitions

back to summary

public int loadBeanDefinitions(InputSource inputSource) throws BeanDefinitionStoreException

Load bean definitions from the specified XML file.

Parameters

inputSource:InputSource: the SAX InputSource to read from

Returns:int

the number of bean definitions found

Exceptions

BeanDefinitionStoreException:: in case of loading or parsing errors

loadBeanDefinitions back to summary

loadBeanDefinitions	back to summary
public int loadBeanDefinitions(InputSource inputSource, String resourceDescription) throws BeanDefinitionStoreException Load bean definitions from the specified XML file. Parameters inputSource:InputSource the SAX InputSource to read from resourceDescription:String a description of the resource (can be `null` or empty) Returns:int the number of bean definitions found Exceptions BeanDefinitionStoreException: in case of loading or parsing errors

public int loadBeanDefinitions(InputSource inputSource, String resourceDescription) throws BeanDefinitionStoreException

Load bean definitions from the specified XML file.

Parameters

inputSource:InputSource: the SAX InputSource to read from
resourceDescription:String: a description of the resource (can be null or empty)

Returns:int

the number of bean definitions found

Exceptions

BeanDefinitionStoreException:: in case of loading or parsing errors

registerBeanDefinitions back to summary

registerBeanDefinitions	back to summary
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException Register the bean definitions contained in the given DOM document. Called by `loadBeanDefinitions`. Creates a new instance of the parser class and invokes `registerBeanDefinitions` on it. Parameters doc:Document the DOM document resource:Resource the resource descriptor (for context information) Returns:int the number of bean definitions found Exceptions BeanDefinitionStoreException: in case of parsing errors See Also `loadBeanDefinitions`, `setDocumentReaderClass`, `BeanDefinitionDocumentReader#registerBeanDefinitions`

public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException

Creates a new instance of the parser class and invokes registerBeanDefinitions on it.

Parameters

doc:Document: the DOM document
resource:Resource: the resource descriptor (for context information)

Returns:int

the number of bean definitions found

Exceptions

BeanDefinitionStoreException:: in case of parsing errors

setDocumentLoader back to summary

setDocumentLoader	back to summary
public void setDocumentLoader(DocumentLoader documentLoader) Specify the `DocumentLoader` to use. The default implementation is `DefaultDocumentLoader` which loads `Document` instances using JAXP.

public void setDocumentLoader(DocumentLoader documentLoader)

Specify the DocumentLoader to use.

The default implementation is DefaultDocumentLoader which loads Document instances using JAXP.

setDocumentReaderClass back to summary

setDocumentReaderClass	back to summary
public void setDocumentReaderClass(Class<? extends BeanDefinitionDocumentReader> documentReaderClass) Specify the `BeanDefinitionDocumentReader` implementation to use, responsible for the actual reading of the XML bean definition document. The default is `DefaultBeanDefinitionDocumentReader`. Parameters documentReaderClass:Class<? extends BeanDefinitionDocumentReader> the desired BeanDefinitionDocumentReader implementation class

public void setDocumentReaderClass(Class<? extends BeanDefinitionDocumentReader> documentReaderClass)

Specify the BeanDefinitionDocumentReader implementation to use, responsible for the actual reading of the XML bean definition document.

The default is DefaultBeanDefinitionDocumentReader.

Parameters

documentReaderClass:Class<? extends BeanDefinitionDocumentReader>: the desired BeanDefinitionDocumentReader implementation class

setEntityResolver back to summary

setEntityResolver	back to summary
public void setEntityResolver(EntityResolver entityResolver) Set a SAX entity resolver to be used for parsing. By default, `ResourceEntityResolver` will be used. Can be overridden for custom entity resolution, for example relative to some specific base path.

public void setEntityResolver(EntityResolver entityResolver)

Set a SAX entity resolver to be used for parsing.

By default, ResourceEntityResolver will be used. Can be overridden for custom entity resolution, for example relative to some specific base path.

setErrorHandler back to summary

setErrorHandler	back to summary
public void setErrorHandler(ErrorHandler errorHandler) Set an implementation of the `org.xml.sax.ErrorHandler` interface for custom handling of XML parsing errors and warnings. If not set, a default SimpleSaxErrorHandler is used that simply logs warnings using the logger instance of the view class, and rethrows errors to discontinue the XML transformation. See Also `SimpleSaxErrorHandler`

public void setErrorHandler(ErrorHandler errorHandler)

Set an implementation of the org.xml.sax.ErrorHandler interface for custom handling of XML parsing errors and warnings.

If not set, a default SimpleSaxErrorHandler is used that simply logs warnings using the logger instance of the view class, and rethrows errors to discontinue the XML transformation.

See Also: SimpleSaxErrorHandler

setEventListener back to summary

setEventListener	back to summary
public void setEventListener(ReaderEventListener eventListener) Specify which `ReaderEventListener` to use. The default implementation is EmptyReaderEventListener which discards every event notification. External tools can provide an alternative implementation to monitor the components being registered in the BeanFactory.

public void setEventListener(ReaderEventListener eventListener)

Specify which ReaderEventListener to use.

The default implementation is EmptyReaderEventListener which discards every event notification. External tools can provide an alternative implementation to monitor the components being registered in the BeanFactory.

setNamespaceAware	back to summary
public void setNamespaceAware(boolean namespaceAware) Set whether the XML parser should be XML namespace aware. Default is "false". This is typically not needed when schema validation is active. However, without validation, this has to be switched to "true" in order to properly process schema namespaces.

setNamespaceAware

back to summary

public void setNamespaceAware(boolean namespaceAware)

Set whether the XML parser should be XML namespace aware. Default is "false".

This is typically not needed when schema validation is active. However, without validation, this has to be switched to "true" in order to properly process schema namespaces.

setNamespaceHandlerResolver back to summary

setNamespaceHandlerResolver	back to summary
public void setNamespaceHandlerResolver(NamespaceHandlerResolver namespaceHandlerResolver) Specify the `NamespaceHandlerResolver` to use. If none is specified, a default instance will be created through `createDefaultNamespaceHandlerResolver()`.

public void setNamespaceHandlerResolver(NamespaceHandlerResolver namespaceHandlerResolver)

Specify the NamespaceHandlerResolver to use.

If none is specified, a default instance will be created through createDefaultNamespaceHandlerResolver().

setProblemReporter back to summary

setProblemReporter	back to summary
public void setProblemReporter(ProblemReporter problemReporter) Specify which `org.springframework.beans.factory.parsing.ProblemReporter` to use. The default implementation is `org.springframework.beans.factory.parsing.FailFastProblemReporter` which exhibits fail fast behaviour. External tools can provide an alternative implementation that collates errors and warnings for display in the tool UI.

public void setProblemReporter(ProblemReporter problemReporter)

Specify which org.springframework.beans.factory.parsing.ProblemReporter to use.

The default implementation is org.springframework.beans.factory.parsing.FailFastProblemReporter which exhibits fail fast behaviour. External tools can provide an alternative implementation that collates errors and warnings for display in the tool UI.

setSourceExtractor back to summary

setSourceExtractor	back to summary
public void setSourceExtractor(SourceExtractor sourceExtractor) Specify the `SourceExtractor` to use. The default implementation is `NullSourceExtractor` which simply returns `null` as the source object. This means that - during normal runtime execution - no additional source metadata is attached to the bean configuration metadata.

public void setSourceExtractor(SourceExtractor sourceExtractor)

Specify the SourceExtractor to use.

The default implementation is NullSourceExtractor which simply returns null as the source object. This means that - during normal runtime execution - no additional source metadata is attached to the bean configuration metadata.

setValidating back to summary

setValidating	back to summary
public void setValidating(boolean validating) Set whether to use XML validation. Default is `true`. This method switches namespace awareness on if validation is turned off, in order to still process schema namespaces properly in such a scenario. See Also `setValidationMode`, `setNamespaceAware`

public void setValidating(boolean validating)

Set whether to use XML validation. Default is true.

This method switches namespace awareness on if validation is turned off, in order to still process schema namespaces properly in such a scenario.

See Also: setValidationMode, setNamespaceAware

setValidationMode back to summary

setValidationMode	back to summary
public void setValidationMode(int validationMode) Set the validation mode to use. Defaults to `VALIDATION_AUTO`. Note that this only activates or deactivates validation itself. If you are switching validation off for schema files, you might need to activate schema namespace support explicitly: see `setNamespaceAware`.

public void setValidationMode(int validationMode)

Set the validation mode to use. Defaults to VALIDATION_AUTO.

Note that this only activates or deactivates validation itself. If you are switching validation off for schema files, you might need to activate schema namespace support explicitly: see setNamespaceAware.

setValidationModeName back to summary

setValidationModeName	back to summary
public void setValidationModeName(String validationModeName) Set the validation mode to use by name. Defaults to `VALIDATION_AUTO`. See Also `setValidationMode`

public void setValidationModeName(String validationModeName)

Set the validation mode to use by name. Defaults to VALIDATION_AUTO.

See Also: setValidationMode

public Class XmlBeanDefinitionReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail