Class StandardEntityResolver
- All Implemented Interfaces:
EntityResolver
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic InputSource
fetch
(String filename, Configuration config) Get the source from a given file.protected InputSource
getResource
(String resourceName, Configuration config) Get a resource from the classpath.static void
Register a DTD or other entity to be resolved by this entity resolverresolveEntity
(String publicId, String systemId) Allow the application to resolve external entities.void
setConfiguration
(Configuration config) Set configuration details.
-
Field Details
-
config
-
-
Constructor Details
-
StandardEntityResolver
-
-
Method Details
-
register
Register a DTD or other entity to be resolved by this entity resolver- Parameters:
publicId
- the public identifier of the DTD or entitysystemId
- the system identifier of the DTD or entity. For domains that are known to redirect http: to https:, either scheme is accepted.fileName
- the fileName of the Saxon local copy of the resource, relative to the data directory in the JAR file
-
setConfiguration
Set configuration details. This is used to control tracing of accesses to files- Parameters:
config
- the Saxon configuration
-
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.
- Specified by:
resolveEntity
in interfaceEntityResolver
- Parameters:
publicId
- The public identifier of the external entity being referenced, or null if none was supplied.systemId
- The system identifier of the external entity being referenced.- 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.
- Throws:
SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
-
fetch
Get the source from a given file.- Parameters:
filename
- the name of the fileconfig
- the Saxon Configuration- Returns:
- an InputSource representing the contents of the file.
-
getResource
Get a resource from the classpath. This method is called if the URI uses the (Spring-defined) "classpath" URI scheme. It attempts to locate the resource on the classpath and returns an InputSource containing the relevant InputStream. If the inputstream cannot be located, it returns null. A subclass that does not want classpath URIs to be resolved in this way should override this method to return null unconditionally.- Parameters:
resourceName
- the resource to be fetched from the classpathconfig
- the Saxon Configuration object- Returns:
- an InputSource representing the named resource (fetched from the classpath) or null if no resource is available.
-