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

public Class DelegatingEntityResolver

extends Object
implements EntityResolver
Class Inheritance
All Implemented Interfaces
org.xml.sax.EntityResolver
Known Direct Subclasses
org.springframework.beans.factory.xml.ResourceEntityResolver
Imports
java.io.IOException, org.xml.sax.EntityResolver, .InputSource, .SAXException, org.springframework.lang.Nullable, org.springframework.util.Assert

EntityResolver implementation that delegates to a BeansDtdResolver and a PluggableSchemaResolver for DTDs and XML schemas, respectively.
Authors
Rob Harrop, Juergen Hoeller, Rick Evans
Since
2.0
See Also
BeansDtdResolver, PluggableSchemaResolver

Field Summary

Modifier and TypeField and Description
public static final String
DTD_SUFFIX

Suffix for DTD files.

private final EntityResolver
private final EntityResolver
public static final String
XSD_SUFFIX

Suffix for schema definition files.

Constructor Summary

AccessConstructor and Description
public
DelegatingEntityResolver(ClassLoader
the ClassLoader to use for loading (can be null to use the default ClassLoader)
classLoader
)

Create a new DelegatingEntityResolver that delegates to a default BeansDtdResolver and a default PluggableSchemaResolver.

public
DelegatingEntityResolver(EntityResolver
the EntityResolver to resolve DTDs with
dtdResolver
,
EntityResolver
the EntityResolver to resolve XML schemas with
schemaResolver
)

Create a new DelegatingEntityResolver that delegates to the given EntityResolvers.

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
)

Implements org.xml.sax.EntityResolver.resolveEntity.

Allow the application to resolve external entities.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

DTD_SUFFIXback to summary
public static final String DTD_SUFFIX

Suffix for DTD files.

dtdResolverback to summary
private final EntityResolver dtdResolver
schemaResolverback to summary
private final EntityResolver schemaResolver
XSD_SUFFIXback to summary
public static final String XSD_SUFFIX

Suffix for schema definition files.

Constructor Detail

DelegatingEntityResolverback to summary
public DelegatingEntityResolver(ClassLoader classLoader)

Create a new DelegatingEntityResolver that delegates to a default BeansDtdResolver and a default PluggableSchemaResolver.

Configures the PluggableSchemaResolver with the supplied ClassLoader.

Parameters
classLoader:ClassLoader

the ClassLoader to use for loading (can be null to use the default ClassLoader)

DelegatingEntityResolverback to summary
public DelegatingEntityResolver(EntityResolver dtdResolver, EntityResolver schemaResolver)

Create a new DelegatingEntityResolver that delegates to the given EntityResolvers.

Parameters
dtdResolver:EntityResolver

the EntityResolver to resolve DTDs with

schemaResolver:EntityResolver

the EntityResolver to resolve XML schemas with

Method Detail

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

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.
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override