All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.axiom.soap.impl.dom.SOAPEnvelopeImpl Maven / Gradle / Ivy

There is a newer version: 1.4.0
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.axiom.soap.impl.dom;

import org.apache.axiom.om.OMConstants;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMException;
import org.apache.axiom.om.OMNamespace;
import org.apache.axiom.om.OMNode;
import org.apache.axiom.om.OMXMLParserWrapper;
import org.apache.axiom.om.impl.MTOMXMLStreamWriter;
import org.apache.axiom.om.impl.dom.DocumentImpl;
import org.apache.axiom.om.impl.dom.NodeImpl;
import org.apache.axiom.om.impl.util.OMSerializerUtil;
import org.apache.axiom.soap.SOAP12Constants;
import org.apache.axiom.soap.SOAPBody;
import org.apache.axiom.soap.SOAPConstants;
import org.apache.axiom.soap.SOAPEnvelope;
import org.apache.axiom.soap.SOAPFactory;
import org.apache.axiom.soap.SOAPHeader;
import org.apache.axiom.soap.SOAPProcessingException;
import org.apache.axiom.soap.SOAPVersion;
import org.apache.axiom.soap.impl.dom.factory.DOMSOAPFactory;

import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;

public class SOAPEnvelopeImpl extends SOAPElement implements SOAPEnvelope,
        OMConstants {

    private static final QName HEADER_QNAME = new QName(SOAPConstants.HEADER_LOCAL_NAME);

    /** @param builder  */
    public SOAPEnvelopeImpl(OMXMLParserWrapper builder, SOAPFactory factory) {
        super(null, SOAPConstants.SOAPENVELOPE_LOCAL_NAME, builder, factory);
    }

    public SOAPEnvelopeImpl(DocumentImpl doc, OMXMLParserWrapper builder, SOAPFactory factory) {
        super(
                doc,
                SOAPConstants.SOAPENVELOPE_LOCAL_NAME,
                null,
                builder, factory);
    }

    /** @param ns  */
    public SOAPEnvelopeImpl(OMNamespace ns, SOAPFactory factory) {
        super(((DOMSOAPFactory) factory).getDocument(),
              SOAPConstants.SOAPENVELOPE_LOCAL_NAME, ns, factory);
        this.getOwnerDocument().appendChild(this);
    }

    public SOAPVersion getVersion() {
        return ((SOAPFactory)factory).getSOAPVersion();
    }

    /**
     * Returns the SOAPHeader object for this  SOAPEnvelope object.
     * 

* This SOAPHeader will just be a container for all the headers in the OMMessage *

* * @return the SOAPHeader object or null if there is none * @throws org.apache.axiom.om.OMException * if there is a problem obtaining the SOAPHeader object * @throws OMException */ public SOAPHeader getHeader() throws OMException { // Header must be the first child OMElement header = getFirstElement(); if (header == null || !(header instanceof SOAPHeader)) { return null; } return (SOAPHeader) header; } public void addChild(OMNode child) { if ((child instanceof OMElement) && !(child instanceof SOAPHeader || child instanceof SOAPBody)) { throw new SOAPProcessingException( "SOAP Envelope can not have children other than SOAP Header and Body", SOAP12Constants.FAULT_CODE_SENDER); } else { if (this.done && (child instanceof SOAPHeader)) { SOAPBody body = getBody(); if (body != null) { body.insertSiblingBefore(child); return; } } super.addChild(child); } } /** * Returns the SOAPBody object associated with this SOAPEnvelope * object. *

* This SOAPBody will just be a container for all the BodyElements in the OMMessage *

* * @return the SOAPBody object for this SOAPEnvelope object or * null if there is none * @throws org.apache.axiom.om.OMException * if there is a problem obtaining the SOAPBody object * @throws OMException */ public SOAPBody getBody() throws OMException { // check for the first element OMElement element = getFirstElement(); if (element != null) { if (SOAPConstants.BODY_LOCAL_NAME.equals(element.getLocalName())) { return (SOAPBody) element; } else { // if not second element SHOULD be the body OMNode node = element.getNextOMSibling(); while (node != null && node.getType() != OMNode.ELEMENT_NODE) { node = node.getNextOMSibling(); } element = (OMElement) node; if (node != null && SOAPConstants.BODY_LOCAL_NAME.equals(element .getLocalName())) { return (SOAPBody) element; } /* else { throw new OMException( "SOAPEnvelope must contain a body element which is either first or second child element of the SOAPEnvelope."); }*/ } } return null; } /** * Method detach * * @throws OMException */ public OMNode detach() throws OMException { throw new OMException("Root Element can not be detached"); } protected void checkParent(OMElement parent) throws SOAPProcessingException { // here do nothing as SOAPEnvelope doesn't have a parent !!! } protected void internalSerialize(XMLStreamWriter writer2, boolean cache) throws XMLStreamException { MTOMXMLStreamWriter writer = (MTOMXMLStreamWriter) writer2; if (!writer.isIgnoreXMLDeclaration()) { String charSetEncoding = writer.getCharSetEncoding(); String xmlVersion = writer.getXmlVersion(); writer.getXmlStreamWriter().writeStartDocument( charSetEncoding == null ? OMConstants.DEFAULT_CHAR_SET_ENCODING : charSetEncoding, xmlVersion == null ? OMConstants.DEFAULT_XML_VERSION : xmlVersion); } if (cache) { //in this case we don't care whether the elements are built or not //we just call the serializeAndConsume methods OMSerializerUtil.serializeStartpart(this, writer); //serialize children SOAPHeader header = getHeader(); if ((header != null) && (header.getFirstOMChild() != null)) { ((SOAPHeaderImpl) header).internalSerialize(writer); } SOAPBody body = getBody(); //REVIEW: getBody has statements to return null..Can it be null in any case? if (body != null) { ((org.apache.axiom.soap.impl.dom.SOAPBodyImpl) body).internalSerialize(writer); } OMSerializerUtil.serializeEndpart(writer); } else { //Now the caching is supposed to be off. However caching been switched off //has nothing to do if the element is already built! if (this.done || (this.builder == null)) { OMSerializerUtil.serializeStartpart(this, writer); OMElement header = getHeader(); if ((header != null) && (header.getFirstOMChild() != null)) { serializeInternally((NodeImpl) header, writer); } SOAPBody body = getBody(); if (body != null) { serializeInternally((NodeImpl) body, writer); } OMSerializerUtil.serializeEndpart(writer); } else { OMSerializerUtil.serializeByPullStream(this, writer, cache); } } } private void serializeInternally(NodeImpl child, MTOMXMLStreamWriter writer) throws XMLStreamException { if ((!(child instanceof OMElement)) || child.isComplete() || child.builder == null) { child.internalSerializeAndConsume(writer); } else { OMElement element = (OMElement) child; element.getBuilder().setCache(false); OMSerializerUtil.serializeByPullStream(element, writer, false); } // child = (NodeImpl) child.getNextOMSibling(); } public OMNode getNextOMSibling() throws OMException { if (this.ownerNode != null && !this.ownerNode.isComplete()) { this.ownerNode.setComplete(true); } return null; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy