javax.xml.soap.SAAJResult Maven / Gradle / Ivy
Show all versions of javaee-api Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.soap;
import 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 {@link #getResult()} method. The {@link DOMResult#getNode()}
* method should be avoided in almost all cases.
*
* @author XWS-Security Development Team
*
* @since SAAJ 1.3
*/
public class SAAJResult extends DOMResult {
/**
* 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
*/
public SAAJResult() throws SOAPException {
this(MessageFactory.newInstance().createMessage());
}
/**
* 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
*/
public SAAJResult(String protocol) throws SOAPException {
this(MessageFactory.newInstance(protocol).createMessage());
}
/**
* 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
*/
public SAAJResult(SOAPMessage message) {
super(message.getSOAPPart());
}
/**
* 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
*/
public SAAJResult(SOAPElement rootNode) {
super(rootNode);
}
/**
* @return the resulting Tree that was created under the specified root Node.
* @since SAAJ 1.3
*/
public javax.xml.soap.Node getResult() {
return (javax.xml.soap.Node)super.getNode().getFirstChild();
}
}