org.springframework.ws.soap.saaj
Interface SaajImplementation

All Known Implementing Classes:

Saaj11Implementation, Saaj12Implementation, Saaj13Implementation

public interface SaajImplementation

Forms a bridge between the SOAP class hierarchy and a specific version of SAAJ.

Since:

1.0.0

Author:

Arjen Poutsma

Method Summary

AttachmentPart	addAttachmentPart(SOAPMessage message, DataHandler dataHandler) Adds an attachment to the given message.
void	addAttribute(SOAPElement element, QName name, String value) Adds an attribute to the specified element.
DetailEntry	addDetailEntry(Detail detail, QName name) Adds a detail entry to the given detail.
SOAPFault	addFault(SOAPBody body, QName faultCode, String faultString, Locale locale) Adds a fault to the given body.
Detail	addFaultDetail(SOAPFault fault) Adds a fault detail for the given fault.
SOAPHeaderElement	addHeaderElement(SOAPHeader header, QName name) Adds a header element to the given header.
SOAPHeaderElement	addNotUnderstoodHeaderElement(SOAPHeader header, QName name) Adds a not understood header element to the given header.
void	addTextNode(DetailEntry detailEntry, String text)
SOAPHeaderElement	addUpgradeHeaderElement(SOAPHeader header, String[] supportedSoapUris) Adds a upgrade header element to the given header.
void	appendFaultSubcode(SOAPFault fault, QName subcode) Adds a fault sub code.
Iterator	examineAllHeaderElements(SOAPHeader header) Returns all header elements.
Iterator	examineMustUnderstandHeaderElements(SOAPHeader header, String actorOrRole) Returns all header elements for which the must understand attribute is true, given the actor or role.
String	getActorOrRole(SOAPHeaderElement headerElement) Returns the SOAP 1.1 actor or SOAP 1.2 role attribute for the given header element.
Iterator	getAllAttibutes(SOAPElement element) Returns all attributes as an iterator of QNames
Iterator	getAttachment(SOAPMessage message, MimeHeaders mimeHeaders) Returns an iteration over all attachments in the message with the given headers.
Iterator	getAttachments(SOAPMessage message) Returns an iteration over all attachments in the message.
String	getAttributeValue(SOAPElement element, QName name) Returns the attribute value *
SOAPBody	getBody(SOAPEnvelope envelope) Returns the body of the given envelope.
Iterator	getDetailEntries(Detail detail) Returns an iteration over all detail entries.
SOAPEnvelope	getEnvelope(SOAPMessage message) Returns the envelope of the given message.
SOAPFault	getFault(SOAPBody body) Returns the fault for the given body, if any.
String	getFaultActor(SOAPFault fault) Returns the actor for the given fault.
QName	getFaultCode(SOAPFault fault) Returns the fault code for the given fault.
Detail	getFaultDetail(SOAPFault fault) Returns the fault detail for the given fault.
String	getFaultNode(SOAPFault fault) Returns the fault node.
String	getFaultReasonText(SOAPFault fault, Locale locale) Returns the fault reason text.
String	getFaultRole(SOAPFault fault) Returns the fault role.
String	getFaultString(SOAPFault fault) Returns the fault string for the given fault.
Locale	getFaultStringLocale(SOAPFault fault) Returns the fault string language for the given fault.
Iterator	getFaultSubcodes(SOAPFault fault) Returns the fault sub code.
SOAPElement	getFirstBodyElement(SOAPBody body) Returns the first child element of the given body.
SOAPHeader	getHeader(SOAPEnvelope envelope) Returns the header of the given envelope.
MimeHeaders	getMimeHeaders(SOAPMessage message) Returns the MIME headers of the message.
boolean	getMustUnderstand(SOAPHeaderElement headerElement) Gets the must understand attribute for the given header element.
QName	getName(SOAPElement element) Returns the name of the given element.
Result	getResult(SOAPElement element) Returns the writable Result of the given element.
Source	getSource(SOAPElement element) Returns the readable Source of the given element.
String	getText(SOAPElement element) Returns the text of the given element
boolean	hasFault(SOAPBody body) Returns true if the body has a fault, false otherwise.
void	removeAttribute(SOAPElement element, QName name) Removes an attribute from the specified element.
void	removeContents(SOAPElement element) Removes the contents (i.e. children) of the element.
void	setActorOrRole(SOAPHeaderElement headerElement, String actorOrRole) Sets the SOAP 1.1 actor or SOAP 1.2 role attribute for the given header element.
void	setFaultActor(SOAPFault fault, String actorOrRole) Sets the actor for the given fault.
void	setFaultNode(SOAPFault fault, String uri) Sets the fault node.
void	setFaultReasonText(SOAPFault fault, Locale locale, String text) Sets the fault reason text.
void	setFaultRole(SOAPFault fault, String role) Sets the fault role.
void	setMustUnderstand(SOAPHeaderElement headerElement, boolean mustUnderstand) Sets the must understand attribute for the given header element.
void	setText(SOAPElement element, String content) Returns the text of the given element
void	writeTo(SOAPMessage message, OutputStream outputStream) Writes the given message to the given stream.

Method Detail

getName

QName getName(SOAPElement element)

Returns the name of the given element.

getSource

Source getSource(SOAPElement element)

Returns the readable Source of the given element.

getResult

Result getResult(SOAPElement element)

Returns the writable Result of the given element.

getText

String getText(SOAPElement element)

Returns the text of the given element

setText

void setText(SOAPElement element,
             String content)
             throws SOAPException

Returns the text of the given element

Throws:

SOAPException

addAttribute

void addAttribute(SOAPElement element,
                  QName name,
                  String value)
                  throws SOAPException

Adds an attribute to the specified element.

Throws:

SOAPException

removeAttribute

void removeAttribute(SOAPElement element,
                     QName name)
                     throws SOAPException

Removes an attribute from the specified element.

Throws:

SOAPException

getAttributeValue

String getAttributeValue(SOAPElement element,
                         QName name)
                         throws SOAPException

Returns the attribute value *

Throws:

SOAPException

getAllAttibutes

Iterator getAllAttibutes(SOAPElement element)

Returns all attributes as an iterator of QNames. *

getEnvelope

SOAPEnvelope getEnvelope(SOAPMessage message)
                         throws SOAPException

Returns the envelope of the given message.

Throws:

SOAPException

getHeader

SOAPHeader getHeader(SOAPEnvelope envelope)
                     throws SOAPException

Returns the header of the given envelope.

Throws:

SOAPException

getBody

SOAPBody getBody(SOAPEnvelope envelope)
                 throws SOAPException

Returns the body of the given envelope.

Throws:

SOAPException

addHeaderElement

SOAPHeaderElement addHeaderElement(SOAPHeader header,
                                   QName name)
                                   throws SOAPException

Adds a header element to the given header.

Throws:

SOAPException

examineAllHeaderElements

Iterator examineAllHeaderElements(SOAPHeader header)

Returns all header elements.

examineMustUnderstandHeaderElements

Iterator examineMustUnderstandHeaderElements(SOAPHeader header,
                                             String actorOrRole)

Returns all header elements for which the must understand attribute is true, given the actor or role.

getActorOrRole

String getActorOrRole(SOAPHeaderElement headerElement)

Returns the SOAP 1.1 actor or SOAP 1.2 role attribute for the given header element.

setActorOrRole

void setActorOrRole(SOAPHeaderElement headerElement,
                    String actorOrRole)

Sets the SOAP 1.1 actor or SOAP 1.2 role attribute for the given header element.

getMustUnderstand

boolean getMustUnderstand(SOAPHeaderElement headerElement)

Gets the must understand attribute for the given header element.

setMustUnderstand

void setMustUnderstand(SOAPHeaderElement headerElement,
                       boolean mustUnderstand)

Sets the must understand attribute for the given header element.

hasFault

boolean hasFault(SOAPBody body)

Returns true if the body has a fault, false otherwise.

getFault

SOAPFault getFault(SOAPBody body)

Returns the fault for the given body, if any.

addFault

SOAPFault addFault(SOAPBody body,
                   QName faultCode,
                   String faultString,
                   Locale locale)
                   throws SOAPException

Adds a fault to the given body.

Throws:

SOAPException

getFaultCode

QName getFaultCode(SOAPFault fault)

Returns the fault code for the given fault.

getFaultActor

String getFaultActor(SOAPFault fault)

Returns the actor for the given fault.

setFaultActor

void setFaultActor(SOAPFault fault,
                   String actorOrRole)
                   throws SOAPException

Sets the actor for the given fault.

Throws:

SOAPException

getFaultString

String getFaultString(SOAPFault fault)

Returns the fault string for the given fault.

getFaultStringLocale

Locale getFaultStringLocale(SOAPFault fault)

Returns the fault string language for the given fault.

addDetailEntry

DetailEntry addDetailEntry(Detail detail,
                           QName name)
                           throws SOAPException

Adds a detail entry to the given detail.

Throws:

SOAPException

getFaultDetail

Detail getFaultDetail(SOAPFault fault)

Returns the fault detail for the given fault.

addFaultDetail

Detail addFaultDetail(SOAPFault fault)
                      throws SOAPException

Adds a fault detail for the given fault.

Throws:

SOAPException

addTextNode

void addTextNode(DetailEntry detailEntry,
                 String text)
                 throws SOAPException

Throws:

SOAPException

getDetailEntries

Iterator getDetailEntries(Detail detail)

Returns an iteration over all detail entries.

getFirstBodyElement

SOAPElement getFirstBodyElement(SOAPBody body)

Returns the first child element of the given body.

removeContents

void removeContents(SOAPElement element)

Removes the contents (i.e. children) of the element.

writeTo

void writeTo(SOAPMessage message,
             OutputStream outputStream)
             throws SOAPException,
                    IOException

Writes the given message to the given stream.

Throws:

SOAPException

IOException

getMimeHeaders

MimeHeaders getMimeHeaders(SOAPMessage message)

Returns the MIME headers of the message.

getAttachments

Iterator getAttachments(SOAPMessage message)

Returns an iteration over all attachments in the message.

getAttachment

Iterator getAttachment(SOAPMessage message,
                       MimeHeaders mimeHeaders)

Returns an iteration over all attachments in the message with the given headers.

addAttachmentPart

AttachmentPart addAttachmentPart(SOAPMessage message,
                                 DataHandler dataHandler)

Adds an attachment to the given message.

addNotUnderstoodHeaderElement

SOAPHeaderElement addNotUnderstoodHeaderElement(SOAPHeader header,
                                                QName name)
                                                throws SOAPException

Adds a not understood header element to the given header.

Throws:

SOAPException

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(SOAPHeader header,
                                          String[] supportedSoapUris)
                                          throws SOAPException

Adds a upgrade header element to the given header.

Throws:

SOAPException

getFaultRole

String getFaultRole(SOAPFault fault)

Returns the fault role.

setFaultRole

void setFaultRole(SOAPFault fault,
                  String role)
                  throws SOAPException

Sets the fault role.

Throws:

SOAPException

getFaultSubcodes

Iterator getFaultSubcodes(SOAPFault fault)

Returns the fault sub code.

appendFaultSubcode

void appendFaultSubcode(SOAPFault fault,
                        QName subcode)
                        throws SOAPException

Adds a fault sub code.

Throws:

SOAPException

getFaultNode

String getFaultNode(SOAPFault fault)

Returns the fault node.

setFaultNode

void setFaultNode(SOAPFault fault,
                  String uri)
                  throws SOAPException

Sets the fault node.

Throws:

SOAPException

getFaultReasonText

String getFaultReasonText(SOAPFault fault,
                          Locale locale)
                          throws SOAPException

Returns the fault reason text.

Throws:

SOAPException

setFaultReasonText

void setFaultReasonText(SOAPFault fault,
                        Locale locale,
                        String text)
                        throws SOAPException

Sets the fault reason text.

Throws:

SOAPException