Spring Framework 6.1.4 · org.springframework.beans.factory.xml.PluggableSchemaResolver

EntityResolver implementation that attempts to resolve schema URLs into local classpath resources using a set of mappings files.

By default, this class will look for mapping files in the classpath using the pattern: META-INF/spring.schemas allowing for multiple files to exist on the classpath at any one time.

The format of META-INF/spring.schemas is a properties file where each line should be of the form systemId=schema-location where schema-location should also be a schema file in the classpath. Since systemId is commonly a URL, one must be careful to escape any ':' characters which are treated as delimiters in properties files.

The pattern for the mapping files can be overridden using the PluggableSchemaResolver(ClassLoader, String) constructor.

Field Summary

Modifier and Type	Field and Description
private final ClassLoader	classLoader
public static final String	DEFAULT_SCHEMA_MAPPINGS_LOCATION The location of the file that defines schema mappings.
private static final Log	logger
private volatile Map<String, String>	schemaMappings Stores the mapping of schema URL → local schema path.
private final String	schemaMappingsLocation

Constructor Summary

Access	Constructor and Description
public	PluggableSchemaResolver(ClassLoader the ClassLoader to use for loading (can be `null` to use the default ClassLoader) classLoader) Loads the schema URL → schema file location mappings using the default mapping file pattern "META-INF/spring.schemas".
public	PluggableSchemaResolver(ClassLoader the ClassLoader to use for loading (can be `null` to use the default ClassLoader) classLoader, String the location of the file that defines schema mappings (must not be empty) schemaMappingsLocation) Loads the schema URL → schema file location mappings using the given mapping file pattern.

Method Summary

Modifier and Type	Method and Description
private Map<String, String>	getSchemaMappings() Load the specified schema mappings lazily.
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:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

classLoader	back to summary
private final ClassLoader classLoader Annotations @Nullable

DEFAULT_SCHEMA_MAPPINGS_LOCATION	back to summary
public static final String DEFAULT_SCHEMA_MAPPINGS_LOCATION The location of the file that defines schema mappings. Can be present in multiple JAR files.

logger	back to summary
private static final Log logger

schemaMappings	back to summary
private volatile Map<String, String> schemaMappings Stores the mapping of schema URL → local schema path. Annotations @Nullable

schemaMappingsLocation	back to summary
private final String schemaMappingsLocation

Constructor Detail

PluggableSchemaResolver back to summary

PluggableSchemaResolver	back to summary
public PluggableSchemaResolver(ClassLoader classLoader) Loads the schema URL → schema file location mappings using the default mapping file pattern "META-INF/spring.schemas". Parameters classLoader:ClassLoader the ClassLoader to use for loading (can be `null` to use the default ClassLoader) See Also `PropertiesLoaderUtils#loadAllProperties(String, ClassLoader)`

public PluggableSchemaResolver(ClassLoader classLoader)

Loads the schema URL → schema file location mappings using the default mapping file pattern "META-INF/spring.schemas".

Parameters

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

PluggableSchemaResolver back to summary

PluggableSchemaResolver	back to summary
public PluggableSchemaResolver(ClassLoader classLoader, String schemaMappingsLocation) Loads the schema URL → schema file location mappings using the given mapping file pattern. Parameters classLoader:ClassLoader the ClassLoader to use for loading (can be `null` to use the default ClassLoader) schemaMappingsLocation:String the location of the file that defines schema mappings (must not be empty) See Also `PropertiesLoaderUtils#loadAllProperties(String, ClassLoader)`

public PluggableSchemaResolver(ClassLoader classLoader, String schemaMappingsLocation)

Loads the schema URL → schema file location mappings using the given mapping file pattern.

Parameters

classLoader:ClassLoader: the ClassLoader to use for loading (can be null to use the default ClassLoader)
schemaMappingsLocation:String: the location of the file that defines schema mappings (must not be empty)

Method Detail

getSchemaMappings	back to summary
private Map<String, String> getSchemaMappings() Load the specified schema mappings lazily.

resolveEntity	back to summary
public InputSource resolveEntity(String publicId, String systemId) throws 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 IOException: A Java-specific IO exception, possibly the result of creating a new InputStream or Reader for the InputSource.

resolveEntity

back to summary

public InputSource resolveEntity(String publicId, String systemId) throws 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

IOException:: A Java-specific IO exception, possibly the result of creating a new InputStream or Reader for the InputSource.

toString back to summary

toString	back 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

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

public Class PluggableSchemaResolver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail