Package org.springframework.ws.soap
Interface SoapElement
- All Known Subinterfaces:
Soap11Body
,Soap11Fault
,Soap11Header
,Soap12Body
,Soap12Fault
,Soap12Header
,SoapBody
,SoapEnvelope
,SoapFault
,SoapFaultDetail
,SoapFaultDetailElement
,SoapHeader
,SoapHeaderElement
public interface SoapElement
The base interface for all elements that are contained in a SOAP message.
- Since:
- 1.0.0
- Author:
- Arjen Poutsma
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttribute
(QName name, String value) Adds an attribute with the specified qualified name and value to this element.void
addNamespaceDeclaration
(String prefix, String namespaceUri) Adds a namespace declaration with the specified prefix and URI to this element.Returns anIterator
over all of the attributes in element asqualified names
.getAttributeValue
(QName name) Returns the value of the attribute with the specified qualified name.getName()
Returns the qualified name of this element.Returns theSource
of this element.void
removeAttribute
(QName name) Removes the attribute with the specified name.
-
Method Details
-
getName
QName getName()Returns the qualified name of this element.- Returns:
- the qualified name of this element
-
getSource
Source getSource()Returns theSource
of this element. This includes the element itself, i.e.SoapEnvelope.getSource()
will include theEnvelope
tag.- Returns:
- the
Source
of this element
-
addAttribute
Adds an attribute with the specified qualified name and value to this element.- Parameters:
name
- the qualified name of the attributevalue
- the value of the attribute
-
removeAttribute
Removes the attribute with the specified name.- Parameters:
name
- the qualified name of the attribute to remove
-
getAttributeValue
Returns the value of the attribute with the specified qualified name.- Parameters:
name
- the qualified name- Returns:
- the value, or
null
if there is no such attribute
-
getAllAttributes
Returns anIterator
over all of the attributes in element asqualified names
.- Returns:
- an iterator over all the attribute names
-
addNamespaceDeclaration
Adds a namespace declaration with the specified prefix and URI to this element.- Parameters:
prefix
- the namespace prefix. Can be empty or null to declare the default namespacenamespaceUri
- the namespace uri- Throws:
SoapElementException
- in case of errors
-