org.apache.solr.common.util

Class SystemIdResolver

java.lang.Object

org.apache.solr.common.util.SystemIdResolver

All Implemented Interfaces:

org.xml.sax.EntityResolver, org.xml.sax.ext.EntityResolver2

public final class SystemIdResolver
extends java.lang.Object
implements org.xml.sax.EntityResolver, org.xml.sax.ext.EntityResolver2

This is a helper class to support resolving of XIncludes or other hrefs inside XML files on top of a ResourceLoader. Just plug this class on top of a ResourceLoader and pass it as EntityResolver to SAX parsers or via wrapper methods as URIResolver to XSL transformers or XMLResolver to STAX parsers. The resolver handles special SystemIds with an URI scheme of solrres: that point to resources. To produce such systemIds when you initially call the parser, use createSystemIdFromResourceName(java.lang.String) which produces a SystemId that can be included along the InputStream coming from ResourceLoader.openResource(java.lang.String).

In general create the InputSource to be passed to the parser like:

  InputSource is = new InputSource(loader.openSchema(name));
  is.setSystemId(SystemIdResolver.createSystemIdFromResourceName(name));
  final DocumentBuilder db = DocumentBuilderFactory.newInstance().newDocumentBuilder();
  db.setEntityResolver(new SystemIdResolver(loader));
  Document doc = db.parse(is);
 

Field Summary

Fields

Modifier and Type	Field and Description
private ResourceLoader	loader
private static org.slf4j.Logger	log
static java.lang.String	RESOURCE_LOADER_AUTHORITY_ABSOLUTE
static java.lang.String	RESOURCE_LOADER_URI_SCHEME

Constructor Summary

Constructors

Constructor and Description
SystemIdResolver(ResourceLoader loader)

Method Summary

Modifier and Type	Method and Description
org.xml.sax.EntityResolver	asEntityResolver()
javax.xml.transform.URIResolver	asURIResolver()
javax.xml.stream.XMLResolver	asXMLResolver()
static java.lang.String	createSystemIdFromResourceName(java.lang.String name)
org.xml.sax.InputSource	getExternalSubset(java.lang.String name, java.lang.String baseURI)
org.xml.sax.InputSource	resolveEntity(java.lang.String publicId, java.lang.String systemId)
org.xml.sax.InputSource	resolveEntity(java.lang.String name, java.lang.String publicId, java.lang.String baseURI, java.lang.String systemId)
(package private) java.net.URI	resolveRelativeURI(java.lang.String baseURI, java.lang.String systemId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

private static final org.slf4j.Logger log

RESOURCE_LOADER_URI_SCHEME

public static final java.lang.String RESOURCE_LOADER_URI_SCHEME

See Also:

Constant Field Values

RESOURCE_LOADER_AUTHORITY_ABSOLUTE

public static final java.lang.String RESOURCE_LOADER_AUTHORITY_ABSOLUTE

See Also:

Constant Field Values

loader

private final ResourceLoader loader

Constructor Detail

SystemIdResolver

public SystemIdResolver(ResourceLoader loader)

Method Detail

asEntityResolver

public org.xml.sax.EntityResolver asEntityResolver()

asURIResolver

public javax.xml.transform.URIResolver asURIResolver()

asXMLResolver

public javax.xml.stream.XMLResolver asXMLResolver()

resolveRelativeURI

java.net.URI resolveRelativeURI(java.lang.String baseURI,
                                java.lang.String systemId)
                         throws java.io.IOException,
                                java.net.URISyntaxException

Throws:

java.io.IOException

java.net.URISyntaxException

getExternalSubset

public org.xml.sax.InputSource getExternalSubset(java.lang.String name,
                                                 java.lang.String baseURI)

Specified by:

getExternalSubset in interface org.xml.sax.ext.EntityResolver2

resolveEntity

public org.xml.sax.InputSource resolveEntity(java.lang.String name,
                                             java.lang.String publicId,
                                             java.lang.String baseURI,
                                             java.lang.String systemId)
                                      throws java.io.IOException

Specified by:

resolveEntity in interface org.xml.sax.ext.EntityResolver2

Throws:

java.io.IOException

resolveEntity

public org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
                                             java.lang.String systemId)
                                      throws java.io.IOException

Specified by:

resolveEntity in interface org.xml.sax.EntityResolver

Throws:

java.io.IOException

createSystemIdFromResourceName

public static java.lang.String createSystemIdFromResourceName(java.lang.String name)