Interface Soap12Header
- All Superinterfaces:
SoapElement
,SoapHeader
Subinterface of
SoapHeader
that exposes SOAP 1.2 functionality.- Since:
- 1.0.0
- Author:
- Arjen Poutsma
-
Method Summary
Modifier and TypeMethodDescriptionaddNotUnderstoodHeaderElement
(QName headerName) Adds a new NotUnderstoodSoapHeaderElement
this header.addUpgradeHeaderElement
(String[] supportedSoapUris) Adds a new UpgradeSoapHeaderElement
this header.examineHeaderElementsToProcess
(String[] roles, boolean isUltimateReceiver) Returns anIterator
over all theheader elements
that should be processed for the given roles.Methods inherited from interface org.springframework.ws.soap.SoapElement
addAttribute, addNamespaceDeclaration, getAllAttributes, getAttributeValue, getName, getSource, removeAttribute
Methods inherited from interface org.springframework.ws.soap.SoapHeader
addHeaderElement, examineAllHeaderElements, examineHeaderElements, examineMustUnderstandHeaderElements, getResult, removeHeaderElement
-
Method Details
-
addNotUnderstoodHeaderElement
Adds a new NotUnderstoodSoapHeaderElement
this header.- Parameters:
headerName
- the qualified name of the header that was not understood- Returns:
- the created
SoapHeaderElement
- Throws:
SoapHeaderException
- if the header cannot be created
-
addUpgradeHeaderElement
Adds a new UpgradeSoapHeaderElement
this header.- Parameters:
supportedSoapUris
- an array of the URIs of SOAP versions supported- Returns:
- the created
SoapHeaderElement
- Throws:
SoapHeaderException
- if the header cannot be created
-
examineHeaderElementsToProcess
Iterator<SoapHeaderElement> examineHeaderElementsToProcess(String[] roles, boolean isUltimateReceiver) throws SoapHeaderException Returns anIterator
over all theheader elements
that should be processed for the given roles. Headers target to the "next" role will always be included, and those targeted to "none" will never be included.- Parameters:
roles
- an array of roles to search forisUltimateReceiver
- whether to search for headers for the ultimate receiver- Returns:
- an iterator over all the header elements that contain the specified roles
- Throws:
SoapHeaderException
- if the headers cannot be returned- See Also:
-