Top Description Fields Constructors Methods
jakarta.xml.soap

public Class SAAJResult

extends DOMResult
Class Inheritance
Imports
javax.xml.transform.dom.DOMResult

Acts as a holder for the results of a JAXP transformation or a JAXB marshalling, in the form of a SAAJ tree. These results should be accessed by using the getResult() method. The DOMResult#getNode() method should be avoided in almost all cases.
Author
XWS-Security Development Team
Since
1.6, SAAJ 1.3

Field Summary

Inherited from javax.xml.transform.dom.DOMResult:
FEATURE

Constructor Summary

AccessConstructor and Description
public
SAAJResult()

Creates a SAAJResult that will present results in the form of a SAAJ tree that supports the default (SOAP 1.1) protocol.

public
SAAJResult(String
the name of the SOAP protocol that the resulting SAAJ tree should support
protocol
)

Creates a SAAJResult that will present results in the form of a SAAJ tree that supports the specified protocol.

public
SAAJResult(SOAPMessage
the message whose SOAPPart will be populated as a result of some transformation or marshalling operation
message
)

Creates a SAAJResult that will write the results into the SOAPPart of the supplied SOAPMessage.

public
SAAJResult(SOAPElement
the root to which the results will be appended
rootNode
)

Creates a SAAJResult that will write the results as a child node of the SOAPElement specified.

Method Summary

Modifier and TypeMethod and Description
public Node

Returns:

the resulting Tree that was created under the specified root Node.
getResult
()

Inherited from javax.xml.transform.dom.DOMResult:
getNextSiblinggetNodegetSystemIdsetNextSiblingsetNodesetSystemId

Constructor Detail

SAAJResultback to summary
public SAAJResult() throws SOAPException

Creates a SAAJResult that will present results in the form of a SAAJ tree that supports the default (SOAP 1.1) protocol.

This kind of SAAJResult is meant for use in situations where the results will be used as a parameter to a method that takes a parameter whose type, such as SOAPElement, is drawn from the SAAJ API. When used in a transformation, the results are populated into the SOAPPart of a SOAPMessage that is created internally. The SOAPPart returned by DOMResult#getNode() is not guaranteed to be well-formed.

Exceptions
SOAPException:
if there is a problem creating a SOAPMessage
Since
1.6, SAAJ 1.3
SAAJResultback to summary
public SAAJResult(String protocol) throws SOAPException

Creates a SAAJResult that will present results in the form of a SAAJ tree that supports the specified protocol. The DYNAMIC_SOAP_PROTOCOL is ambiguous in this context and will cause this constructor to throw an UnsupportedOperationException.

This kind of SAAJResult is meant for use in situations where the results will be used as a parameter to a method that takes a parameter whose type, such as SOAPElement, is drawn from the SAAJ API. When used in a transformation the results are populated into the SOAPPart of a SOAPMessage that is created internally. The SOAPPart returned by DOMResult#getNode() is not guaranteed to be well-formed.

Parameters
protocol:String

the name of the SOAP protocol that the resulting SAAJ tree should support

Exceptions
SOAPException:
if a SOAPMessage supporting the specified protocol cannot be created
Since
1.6, SAAJ 1.3
SAAJResultback to summary
public SAAJResult(SOAPMessage message)

Creates a SAAJResult that will write the results into the SOAPPart of the supplied SOAPMessage. In the normal case these results will be written using DOM APIs and, as a result, the finished SOAPPart will not be guaranteed to be well-formed unless the data used to create it is also well formed. When used in a transformation the validity of the SOAPMessage after the transformation can be guaranteed only by means outside SAAJ specification.

Parameters
message:SOAPMessage

the message whose SOAPPart will be populated as a result of some transformation or marshalling operation

Since
1.6, SAAJ 1.3
SAAJResultback to summary
public SAAJResult(SOAPElement rootNode)

Creates a SAAJResult that will write the results as a child node of the SOAPElement specified. In the normal case these results will be written using DOM APIs and as a result may invalidate the structure of the SAAJ tree. This kind of SAAJResult should only be used when the validity of the incoming data can be guaranteed by means outside of the SAAJ specification.

Parameters
rootNode:SOAPElement

the root to which the results will be appended

Since
1.6, SAAJ 1.3

Method Detail

getResultback to summary
public Node getResult()
Returns:Node

the resulting Tree that was created under the specified root Node.

Since
1.6, SAAJ 1.3