Package net.sf.saxon.lib

Class ResourceRequest

  • public class ResourceRequest
extends java.lang.Object
    A bundle of information made available when requesting resource resolution. Any of these properties may be absent.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ANY_NATURE  
      static java.lang.String ANY_PURPOSE  
      java.lang.String baseUri
      The base URI that was used to resolve any relative URI, if known.
      static java.lang.String BINARY_NATURE  
      static java.lang.String DTD_NATURE  
      java.lang.String entityName
      The name of the requested resource, used when resolving entity references
      static java.lang.String EXTERNAL_ENTITY_NATURE  
      java.lang.String nature
      The Nature of the resource, as defined in the RDDL specifications (based on the role attribute in XLink).
      java.lang.String publicId
      The public ID of the requested resource, where applicable
      java.lang.String purpose
      The Purpose of the request, as defined in the RDDL specifications (based on the arcrole attribute in XLink).
      java.lang.String relativeUri
      The relative URI that was actually requested, where applicable.
      java.lang.String requestedEncoding
      If the encoding is specified out of band, it can be provided here.
      static java.lang.String SCHEMA_NATURE  
      boolean streamable
      This boolean flag is set to true when the URI identifies a document where streamed processing is required.
      static java.lang.String TEXT_NATURE  
      java.lang.String uri
      The URI to be dereferenced.
      boolean uriIsNamespace
      This boolean flag is set to true when the URI takes the form of a namespace URI (rather than a location hint).
      static java.lang.String VALIDATION_PURPOSE  
      static java.lang.String XML_NATURE  
      static java.lang.String XQUERY_NATURE  
      static java.lang.String XSD_NATURE  
      static java.lang.String XSLT_NATURE  

    • Constructor Summary

      Constructors 
      Constructor Description
      ResourceRequest()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ResourceRequest copy()
      Make a copy of a resource request (so that it can be modified without changing the original)
      javax.xml.transform.Source resolve​(ResourceResolver... resolvers)
      Resolve the request by passing it to one or more resource resolvers.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • EXTERNAL_ENTITY_NATURE

        public static final java.lang.String EXTERNAL_ENTITY_NATURE
        See Also:
        Constant Field Values

      • ANY_PURPOSE

        public static final java.lang.String ANY_PURPOSE

      • VALIDATION_PURPOSE

        public static final java.lang.String VALIDATION_PURPOSE
        See Also:
        Constant Field Values

      • ANY_NATURE

        public static final java.lang.String ANY_NATURE

      • uri

        public java.lang.String uri
        The URI to be dereferenced. If the request was for a relative URI reference, this will be the absolute URI after resolving against the base URI if known; if no base URI is known, it will be the URI as requested.

      • baseUri

        public java.lang.String baseUri
        The base URI that was used to resolve any relative URI, if known.

      • relativeUri

        public java.lang.String relativeUri
        The relative URI that was actually requested, where applicable.

      • publicId

        public java.lang.String publicId
        The public ID of the requested resource, where applicable

      • entityName

        public java.lang.String entityName
        The name of the requested resource, used when resolving entity references

      • nature

        public java.lang.String nature
        The Nature of the resource, as defined in the RDDL specifications (based on the role attribute in XLink). Some of the allowed values are provided as constants, for example TEXT_NATURE, XSLT_NATURE, XQUERY_NATURE.

      • purpose

        public java.lang.String purpose
        The Purpose of the request, as defined in the RDDL specifications (based on the arcrole attribute in XLink).

      • uriIsNamespace

        public boolean uriIsNamespace
        This boolean flag is set to true when the URI takes the form of a namespace URI (rather than a location hint). Specifically, it is set when resolving an import module declaration in XQuery when only the module namespace is known, and when resolving an xsl:import, or an XML Schema import in XSLT or XQuery, if only the target namespace of the required schema document is known.

      • streamable

        public boolean streamable
        This boolean flag is set to true when the URI identifies a document where streamed processing is required. In this case the result must be a StreamSource or SAXSource

      • requestedEncoding

        public java.lang.String requestedEncoding
        If the encoding is specified out of band, it can be provided here. Requesting an encoding doesn't gaurantee that it'll be used. For example, HTTP headers might override it.

    • Constructor Detail

      • ResourceRequest

        public ResourceRequest()

    • Method Detail

      • copy

        public ResourceRequest copy()
        Make a copy of a resource request (so that it can be modified without changing the original)
        Returns:
        a copy of the request

      • resolve

        public javax.xml.transform.Source resolve​(ResourceResolver... resolvers)
                                   throws XPathException
        Resolve the request by passing it to one or more resource resolvers. The resolvers are tried in turn until one of them returns a non-null result; if the final result is null, this method returns null
        Parameters:
        resolvers - the resource resolvers to be used
        Returns:
        the result from the first resolver that returns a non-null result; or null if none of them does so.
        Throws:
        XPathException