FileDocCategorySizeDatePackage
SAAJResult.javaAPI DocJava SE 6 API5483Tue Jun 10 00:27:10 BST 2008javax.xml.soap

SAAJResult

public class SAAJResult extends 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 {@link #getResult()} method. The {@link DOMResult#getNode()} method should be avoided in almost all cases.
author
XWS-Security Development Team
since
SAAJ 1.3

Fields Summary
Constructors Summary
public SAAJResult()
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 {@link DOMResult#getNode()} is not guaranteed to be well-formed.

throws
SOAPException if there is a problem creating a SOAPMessage
since
SAAJ 1.3

        this(MessageFactory.newInstance().createMessage());
public SAAJResult(String protocol)
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 {@link DOMResult#getNode()} is not guaranteed to be well-formed.

param
protocol - the name of the SOAP protocol that the resulting SAAJ tree should support
throws
SOAPException if a SOAPMessage supporting the specified protocol cannot be created
since
SAAJ 1.3

        this(MessageFactory.newInstance(protocol).createMessage());
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.

param
message - the message whose SOAPPart will be populated as a result of some transformation or marshalling operation
since
SAAJ 1.3

        super(message.getSOAPPart());
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.

param
rootNode - the root to which the results will be appended
since
SAAJ 1.3

        super(rootNode);
Methods Summary
public javax.xml.soap.NodegetResult()

return
the resulting Tree that was created under the specified root Node.
since
SAAJ 1.3

        return (javax.xml.soap.Node)super.getNode().getFirstChild();