Class URIResolver


  • public class URIResolver
    extends org.apache.xml.security.utils.resolver.ResourceResolverSpi
    This resolver is used for resolving URIs. Resolves URLs that refers to attachments that has a (1) Content-ID or a (2) Content-Location MIME header. In case of Content-Location, the URL may require resolution to determine the referenced attachment [RFC2557]. Also resolves (3) URL's that are Ids on XML elements within the SOAPMessage.
    Author:
    XWS-Security Team
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static Logger log  
      • Fields inherited from class org.apache.xml.security.utils.resolver.ResourceResolverSpi

        properties, secureValidation
    • Constructor Summary

      Constructors 
      Constructor Description
      URIResolver()  
      URIResolver​(jakarta.xml.soap.SOAPMessage soapMsg)  
    • Field Detail

      • log

        protected static final Logger log
    • Constructor Detail

      • URIResolver

        public URIResolver()
      • URIResolver

        public URIResolver​(jakarta.xml.soap.SOAPMessage soapMsg)
    • Method Detail

      • setSOAPMessage

        public void setSOAPMessage​(jakarta.xml.soap.SOAPMessage soapMsg)
      • getResolverName

        public static String getResolverName()
        Method getResolverName
        Returns:
        The resolver implementation class name
      • engineResolve

        public org.apache.xml.security.signature.XMLSignatureInput engineResolve​(Attr uri,
                                                                                 String baseURI)
                                                                          throws org.apache.xml.security.utils.resolver.ResourceResolverException
        Method engineResolve
        Overrides:
        engineResolve in class org.apache.xml.security.utils.resolver.ResourceResolverSpi
        Parameters:
        uri -
        baseURI -
        Returns:
        XMLSignatureInput
        Throws:
        org.apache.xml.security.utils.resolver.ResourceResolverException
      • engineCanResolve

        public boolean engineCanResolve​(Attr uri,
                                        String baseURI)
        Method engineCanResolve
        Overrides:
        engineCanResolve in class org.apache.xml.security.utils.resolver.ResourceResolverSpi
        Parameters:
        uri -
        baseURI -
        Returns:
        true if uri node can be resolved, false otherwise
      • engineResolveURI

        public org.apache.xml.security.signature.XMLSignatureInput engineResolveURI​(org.apache.xml.security.utils.resolver.ResourceResolverContext rrc)
                                                                             throws org.apache.xml.security.utils.resolver.ResourceResolverException
        Description copied from class: org.apache.xml.security.utils.resolver.ResourceResolverSpi
        This is the workhorse method used to resolve resources.
        Overrides:
        engineResolveURI in class org.apache.xml.security.utils.resolver.ResourceResolverSpi
        Parameters:
        rrc - Context to use to resolve resources.
        Returns:
        the resource wrapped around a XMLSignatureInput
        Throws:
        org.apache.xml.security.utils.resolver.ResourceResolverException
      • engineCanResolveURI

        public boolean engineCanResolveURI​(org.apache.xml.security.utils.resolver.ResourceResolverContext rrc)
        Description copied from class: org.apache.xml.security.utils.resolver.ResourceResolverSpi
        This method helps the ResourceResolver to decide whether a ResourceResolverSpi is able to perform the requested action.

        New clients should override this method, and not override ResourceResolverSpi.engineCanResolve(Attr, String)

        Overrides:
        engineCanResolveURI in class org.apache.xml.security.utils.resolver.ResourceResolverSpi
        Parameters:
        rrc - Context in which to do resolution.
        Returns:
        true if the engine can resolve the uri