org.springframework.context.support: public class: ResourceEntityResolver

org.springframework.context.support
public class: ResourceEntityResolver [javadoc | source]

java.lang.Object
   org.springframework.beans.factory.xml.BeansDtdResolver
      org.springframework.context.support.ResourceEntityResolver

All Implemented Interfaces:
EntityResolver

EntityResolver implementation that tries to resolve entity references relative to the resource base of the application context, if applicable. Extends BeansDtdResolver to also provide DTD lookup in the class path.

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.

Also see:

org.springframework.context.ApplicationContext#getResource

author: Juergen - Hoeller

since: 31.07.2003 -

Constructor:
public ResourceEntityResolver(ApplicationContext applicationContext) { this.applicationContext = applicationContext; }

Method from org.springframework.context.support.ResourceEntityResolver Summary:
resolveEntity

Methods from org.springframework.beans.factory.xml.BeansDtdResolver:
resolveEntity

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.springframework.context.support.ResourceEntityResolver Detail:
public InputSource resolveEntity(String publicId, String systemId) throws IOException { InputSource source = super.resolveEntity(publicId, systemId); if (source == null && systemId != null) { String resourcePath = null; try { String decodedSystemId = URLDecoder.decode(systemId); String givenUrl = new URL(decodedSystemId).toString(); String systemRootUrl = new File("").toURL().toString(); // try relative to resource base if currently in system root if (givenUrl.startsWith(systemRootUrl)) { resourcePath = givenUrl.substring(systemRootUrl.length()); } } catch (MalformedURLException ex) { // no URL - > try relative to resource base resourcePath = systemId; } if (resourcePath != null) { if (logger.isDebugEnabled()) { logger.debug("Trying to locate entity [" + systemId + "] as application context resource [" + resourcePath + "]"); } Resource resource = this.applicationContext.getResource(resourcePath); if (logger.isInfoEnabled()) { logger.info("Found entity [" + systemId + "] as application context resource [" + resourcePath + "]"); } source = new InputSource(resource.getInputStream()); source.setPublicId(publicId); source.setSystemId(systemId); } } return source; }

Method from org.springframework.context.support.ResourceEntityResolver Detail:

 public InputSource resolveEntity(String publicId,
    String systemId) throws IOException {
		InputSource source = super.resolveEntity(publicId, systemId);
		if (source == null && systemId != null) {
			String resourcePath = null;
			try {
				String decodedSystemId = URLDecoder.decode(systemId);
				String givenUrl = new URL(decodedSystemId).toString();
				String systemRootUrl = new File("").toURL().toString();
				// try relative to resource base if currently in system root
				if (givenUrl.startsWith(systemRootUrl)) {
					resourcePath = givenUrl.substring(systemRootUrl.length());
				}
			}
			catch (MalformedURLException ex) {
				// no URL - > try relative to resource base
				resourcePath = systemId;
			}
			if (resourcePath != null) {
				if (logger.isDebugEnabled()) {
					logger.debug("Trying to locate entity [" + systemId + "] as application context resource [" +
											 resourcePath + "]");
				}
				Resource resource = this.applicationContext.getResource(resourcePath);
				if (logger.isInfoEnabled()) {
					logger.info("Found entity [" + systemId + "] as application context resource [" + resourcePath + "]");
				}
				source = new InputSource(resource.getInputStream());
				source.setPublicId(publicId);
				source.setSystemId(systemId);
			}
		}
		return source;
}