Top Description Fields Constructors Methods
org.springframework.beans.factory.xml

public Class ResourceEntityResolver

extends DelegatingEntityResolver
Class Inheritance
Imports
java.io.File, .IOException, java.net.URLDecoder, java.nio.charset.StandardCharsets, org.apache.commons.logging.Log, .LogFactory, org.xml.sax.InputSource, .SAXException, org.springframework.core.io.Resource, .ResourceLoader, org.springframework.lang.Nullable, org.springframework.util.ResourceUtils

EntityResolver implementation that tries to resolve entity references through a org.springframework.core.io.ResourceLoader (usually, relative to the resource base of an ApplicationContext), if applicable. Extends DelegatingEntityResolver to also provide DTD and XSD lookup.

Allows to use standard XML entities to include XML snippets into an application context definition, for example to split a large XML file into various modules. The include paths can be relative to the application context's resource base as usual, instead of relative to the JVM working directory (the XML parser's default).

Note

In addition to relative paths, every URL that specifies a file in the current system root, i.e. the JVM working directory, will be interpreted relative to the application context too.

Author
Juergen Hoeller
Since
31.07.2003
See Also
org.springframework.core.io.ResourceLoader, org.springframework.context.ApplicationContext

Field Summary

Modifier and TypeField and Description
private static final Log
private final ResourceLoader
Inherited from org.springframework.beans.factory.xml.DelegatingEntityResolver:
DTD_SUFFIXXSD_SUFFIX

Constructor Summary

AccessConstructor and Description
public
ResourceEntityResolver(ResourceLoader
the ResourceLoader (or ApplicationContext) to load XML entity includes with
resourceLoader
)

Create a ResourceEntityResolver for the specified ResourceLoader (usually, an ApplicationContext).

Method Summary

Modifier and TypeMethod and Description
public InputSource
resolveEntity(String
The public identifier of the external entity being referenced, or null if none was supplied.
publicId
,
String
The system identifier of the external entity being referenced.
systemId
)

Overrides org.springframework.beans.factory.xml.DelegatingEntityResolver.resolveEntity.

Implements org.xml.sax.EntityResolver.resolveEntity.

Allow the application to resolve external entities.
protected InputSource

Returns:

an InputSource object describing the new input source, or null to request that the parser open a regular URI connection to the system identifier
resolveSchemaEntity
(String
the public identifier of the external entity being referenced, or null if none was supplied
publicId
,
String
the system identifier of the external entity being referenced, representing the URL of the DTD or XSD
systemId
)

A fallback method for resolveEntity(String, String) that is used when a "schema" entity (DTD or XSD) cannot be resolved as a local resource.

Inherited from org.springframework.beans.factory.xml.DelegatingEntityResolver:
toString

Field Detail

loggerback to summary
private static final Log logger
resourceLoaderback to summary
private final ResourceLoader resourceLoader

Constructor Detail

ResourceEntityResolverback to summary
public ResourceEntityResolver(ResourceLoader resourceLoader)

Create a ResourceEntityResolver for the specified ResourceLoader (usually, an ApplicationContext).

Parameters
resourceLoader:ResourceLoader

the ResourceLoader (or ApplicationContext) to load XML entity includes with

Method Detail

resolveEntityback to summary
public InputSource resolveEntity(String publicId, String systemId) throws SAXException, IOException

Overrides org.springframework.beans.factory.xml.DelegatingEntityResolver.resolveEntity.

Implements org.xml.sax.EntityResolver.resolveEntity.

Doc from org.xml.sax.EntityResolver.resolveEntity.

Allow the application to resolve external entities.

The parser will call this method before opening any external entity except the top-level document entity. Such entities include the external DTD subset and external parameter entities referenced within the DTD (in either case, only if the parser reads external parameter entities), and external general entities referenced within the document element (if the parser reads external general entities). The application may request that the parser locate the entity itself, that it use an alternative URI, or that it use data provided by the application (as a character or byte input stream).

Application writers can use this method to redirect external system identifiers to secure and/or local URIs, to look up public identifiers in a catalogue, or to read an entity from a database or other input source (including, for example, a dialog box). Neither XML nor SAX specifies a preferred policy for using public or system IDs to resolve resources. However, SAX specifies how to interpret any InputSource returned by this method, and that if none is returned, then the system ID will be dereferenced as a URL.

If the system identifier is a URL, the SAX parser must resolve it fully before reporting it to the application.

Parameters
publicId:String

The public identifier of the external entity being referenced, or null if none was supplied.

systemId:String

The system identifier of the external entity being referenced.

Returns:InputSource

An InputSource object describing the new input source, or null to request that the parser open a regular URI connection to the system identifier.

Annotations
@Override
@Nullable
Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
IOException:
A Java-specific IO exception, possibly the result of creating a new InputStream or Reader for the InputSource.
resolveSchemaEntityback to summary
protected InputSource resolveSchemaEntity(String publicId, String systemId)

A fallback method for resolveEntity(String, String) that is used when a "schema" entity (DTD or XSD) cannot be resolved as a local resource. The default behavior is to perform remote resolution over HTTPS.

Subclasses can override this method to change the default behavior.

  • Return null to fall back to the parser's default behavior.
  • Throw an exception to prevent remote resolution of the DTD or XSD.
Parameters
publicId:String

the public identifier of the external entity being referenced, or null if none was supplied

systemId:String

the system identifier of the external entity being referenced, representing the URL of the DTD or XSD

Returns:InputSource

an InputSource object describing the new input source, or null to request that the parser open a regular URI connection to the system identifier

Annotations
@Nullable
Since
6.0.4