Class DOMCallbackLookup

  • All Implemented Interfaces:
    CallbackLookup

    public class DOMCallbackLookup
    extends Object
    implements CallbackLookup
    This class uses a DOM-based approach to locate Elements that are referenced via an Id.
    • Constructor Detail

      • DOMCallbackLookup

        public DOMCallbackLookup​(Document doc)
    • Method Detail

      • getElement

        public Element getElement​(String id,
                                  String valueType,
                                  boolean checkMultipleElements)
                           throws org.apache.wss4j.common.ext.WSSecurityException
        Get the DOM element that corresponds to the given id and ValueType reference. The Id can be a wsu:Id or else an Id attribute, or a SAML Id when the ValueType refers to a SAML Assertion.
        Specified by:
        getElement in interface CallbackLookup
        Parameters:
        id - The id of the element to locate
        valueType - The ValueType attribute of the element to locate (can be null)
        checkMultipleElements - If true then go through the entire tree and return null if there are multiple elements with the same Id
        Returns:
        the located element
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • getAndRegisterElement

        public Element getAndRegisterElement​(String id,
                                             String valueType,
                                             boolean checkMultipleElements,
                                             DOMCryptoContext context)
                                      throws org.apache.wss4j.common.ext.WSSecurityException
        Get the DOM element that corresponds to the given id and ValueType reference. The Id can be a wsu:Id or else an Id attribute, or a SAML Id when the ValueType refers to a SAML Assertion. The implementation is also responsible to register the retrieved Element on the DOMCryptoContext argument, so that the XML Signature implementation can find the Element.
        Specified by:
        getAndRegisterElement in interface CallbackLookup
        Parameters:
        id - The id of the element to locate
        valueType - The ValueType attribute of the element to locate (can be null)
        checkMultipleElements - If true then go through the entire tree and return null if there are multiple elements with the same Id
        context - The DOMCryptoContext to store the Element in
        Returns:
        the located element
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException
      • getElements

        public List<Element> getElements​(String localname,
                                         String namespace)
                                  throws org.apache.wss4j.common.ext.WSSecurityException
        Get the DOM element(s) that correspond to the given localname/namespace.
        Specified by:
        getElements in interface CallbackLookup
        Parameters:
        localname - The localname of the Element(s)
        namespace - The namespace of the Element(s)
        Returns:
        the located element(s)
        Throws:
        org.apache.wss4j.common.ext.WSSecurityException