org.apache.wss4j.dom.callback

Interface CallbackLookup

All Known Implementing Classes:

CXFCallbackLookup, DOMCallbackLookup

public interface CallbackLookup

This interface defines a pluggable way of locating Elements that are referenced via an Id.

Method Summary

Modifier and Type	Method and Description
Element	getAndRegisterElement(String id, String valueType, boolean checkMultipleElements, DOMCryptoContext context) Get the DOM element that corresponds to the given id and ValueType reference.
Element	getElement(String id, String valueType, boolean checkMultipleElements) Get the DOM element that corresponds to the given id and ValueType reference.
List<Element>	getElements(String localname, String namespace) Get the DOM element(s) that correspond to the given localname/namespace.
Element	getSOAPBody() Get the SOAP Body

Method Detail

getElement

Element getElement(String id,
                   String valueType,
                   boolean checkMultipleElements)
            throws 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.

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:

WSSecurityException

getAndRegisterElement

Element getAndRegisterElement(String id,
                              String valueType,
                              boolean checkMultipleElements,
                              DOMCryptoContext context)
                       throws 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.

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:

WSSecurityException

getElements

List<Element> getElements(String localname,
                          String namespace)
                   throws WSSecurityException

Get the DOM element(s) that correspond to the given localname/namespace.

Parameters:

localname - The localname of the Element(s)

namespace - The namespace of the Element(s)

Returns:

the located element(s)

Throws:

WSSecurityException

getSOAPBody

Element getSOAPBody()

Get the SOAP Body