1 /*
   2  * Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.messaging.saaj.soap.impl;
  27 
  28 import java.util.Iterator;
  29 import java.util.Locale;
  30 import java.util.logging.Level;
  31 
  32 import javax.xml.namespace.QName;
  33 import javax.xml.soap.*;
  34 import javax.xml.stream.XMLStreamException;
  35 import javax.xml.stream.XMLStreamReader;
  36 import javax.xml.parsers.DocumentBuilder;
  37 import javax.xml.parsers.DocumentBuilderFactory;
  38 
  39 import com.sun.xml.internal.messaging.saaj.util.SAAJUtil;
  40 import org.w3c.dom.*;
  41 import org.w3c.dom.Node;
  42 
  43 import com.sun.xml.internal.messaging.saaj.SOAPExceptionImpl;
  44 import com.sun.xml.internal.messaging.saaj.soap.SOAPDocument;
  45 import com.sun.xml.internal.messaging.saaj.soap.SOAPDocumentImpl;
  46 import com.sun.xml.internal.messaging.saaj.soap.StaxBridge;
  47 import com.sun.xml.internal.messaging.saaj.soap.name.NameImpl;












  48 
  49 /**
  50  * The implementation of SOAP-ENV:BODY or the SOAPBody abstraction.
  51  *
  52  * @author Anil Vijendran (anil@sun.com)
  53  */
  54 public abstract class BodyImpl extends ElementImpl implements SOAPBody {
  55     private SOAPFault fault;
  56 //  private XMLStreamReaderToXMLStreamWriter staxBridge;
  57     private StaxBridge staxBridge;
  58     private boolean payloadStreamRead = false;
  59 
  60     protected BodyImpl(SOAPDocumentImpl ownerDoc, NameImpl bodyName) {
  61         super(ownerDoc, bodyName);
  62     }
  63 
  64     public BodyImpl(SOAPDocumentImpl ownerDoc, Element domElement) {
  65         super(ownerDoc, domElement);
  66     }
  67 
  68     protected abstract NameImpl getFaultName(String name);
  69     protected abstract boolean isFault(SOAPElement child);
  70     protected abstract SOAPBodyElement createBodyElement(Name name);
  71     protected abstract SOAPBodyElement createBodyElement(QName name);
  72     protected abstract SOAPFault createFaultElement();
  73     protected abstract QName getDefaultFaultCode();
  74 

  75     public SOAPFault addFault() throws SOAPException {
  76         if (hasFault()) {
  77             log.severe("SAAJ0110.impl.fault.already.exists");
  78             throw new SOAPExceptionImpl("Error: Fault already exists");
  79         }
  80 
  81         fault = createFaultElement();
  82 
  83         addNode(fault);
  84 
  85         fault.setFaultCode(getDefaultFaultCode());
  86         fault.setFaultString("Fault string, and possibly fault code, not set");
  87 
  88         return fault;
  89     }
  90 

  91     public SOAPFault addFault(
  92         Name faultCode,
  93         String faultString,
  94         Locale locale)
  95         throws SOAPException {
  96 
  97         SOAPFault fault = addFault();
  98         fault.setFaultCode(faultCode);
  99         fault.setFaultString(faultString, locale);
 100         return fault;
 101     }
 102 

 103    public SOAPFault addFault(
 104         QName faultCode,
 105         String faultString,
 106         Locale locale)
 107         throws SOAPException {
 108 
 109         SOAPFault fault = addFault();
 110         fault.setFaultCode(faultCode);
 111         fault.setFaultString(faultString, locale);
 112         return fault;
 113     }
 114 

 115     public SOAPFault addFault(Name faultCode, String faultString)
 116         throws SOAPException {
 117 
 118         SOAPFault fault = addFault();
 119         fault.setFaultCode(faultCode);
 120         fault.setFaultString(faultString);
 121         return fault;
 122     }
 123 

 124     public SOAPFault addFault(QName faultCode, String faultString)
 125         throws SOAPException {
 126 
 127         SOAPFault fault = addFault();
 128         fault.setFaultCode(faultCode);
 129         fault.setFaultString(faultString);
 130         return fault;
 131     }
 132 
 133     void initializeFault() {
 134         FaultImpl flt = (FaultImpl) findFault();
 135         fault = flt;
 136     }
 137 
 138     protected SOAPElement findFault() {
 139         Iterator<Node> eachChild = getChildElementNodes();
 140         while (eachChild.hasNext()) {
 141             SOAPElement child = (SOAPElement) eachChild.next();
 142             if (isFault(child)) {
 143                 return child;
 144             }
 145         }
 146 
 147         return null;
 148     }
 149 

 150     public boolean hasFault() {
 151         QName payloadQName = getPayloadQName();
 152         return getFaultQName().equals(payloadQName);
 153     }
 154 
 155     private Object getFaultQName() {
 156         return new QName(getNamespaceURI(), "Fault");
 157     }
 158 

 159     public SOAPFault getFault() {
 160         if (hasFault()) {
 161             if (fault == null) {
 162                 //initialize fault member
 163                 fault = (SOAPFault) getSoapDocument().find(getFirstChildElement());
 164             }
 165             return fault;
 166         }
 167         return null;
 168     }
 169 

 170     public SOAPBodyElement addBodyElement(Name name) throws SOAPException {
 171         SOAPBodyElement newBodyElement =
 172             (SOAPBodyElement) ElementFactory.createNamedElement(
 173                 ((SOAPDocument) getOwnerDocument()).getDocument(),
 174                 name.getLocalName(),
 175                 name.getPrefix(),
 176                 name.getURI());
 177         if (newBodyElement == null) {
 178             newBodyElement = createBodyElement(name);
 179         }
 180         addNode(newBodyElement);
 181         return newBodyElement;
 182     }
 183 

 184     public SOAPBodyElement addBodyElement(QName qname) throws SOAPException {
 185         SOAPBodyElement newBodyElement =
 186             (SOAPBodyElement) ElementFactory.createNamedElement(
 187                 ((SOAPDocument) getOwnerDocument()).getDocument(),
 188                 qname.getLocalPart(),
 189                 qname.getPrefix(),
 190                 qname.getNamespaceURI());
 191         if (newBodyElement == null) {
 192             newBodyElement = createBodyElement(qname);
 193         }
 194         addNode(newBodyElement);
 195         return newBodyElement;
 196     }
 197 

 198     public void setParentElement(SOAPElement element) throws SOAPException {
 199 
 200         if (!(element instanceof SOAPEnvelope)) {
 201             log.severe("SAAJ0111.impl.body.parent.must.be.envelope");
 202             throw new SOAPException("Parent of SOAPBody has to be a SOAPEnvelope");
 203         }
 204         super.setParentElement(element);
 205     }
 206 

 207     protected SOAPElement addElement(Name name) throws SOAPException {
 208         return addBodyElement(name);
 209     }
 210 

 211     protected SOAPElement addElement(QName name) throws SOAPException {
 212         return addBodyElement(name);
 213     }
 214 
 215     //    public Node insertBefore(Node newElement, Node ref) throws DOMException {
 216     //        if (!(newElement instanceof SOAPBodyElement) && (newElement instanceof SOAPElement)) {
 217     //            newElement = new ElementWrapper((ElementImpl) newElement);
 218     //        }
 219     //        return super.insertBefore(newElement, ref);
 220     //    }
 221     //
 222     //    public Node replaceChild(Node newElement, Node ref) throws DOMException {
 223     //        if (!(newElement instanceof SOAPBodyElement) && (newElement instanceof SOAPElement)) {
 224     //            newElement = new ElementWrapper((ElementImpl) newElement);
 225     //        }
 226     //        return super.replaceChild(newElement, ref);
 227     //    }
 228 

 229     public SOAPBodyElement addDocument(Document document)
 230         throws SOAPException {
 231         /*
 232 
 233                 Element rootNode =
 234                     document.getDocumentElement();
 235                 // Causes all deferred nodes to be inflated
 236                 rootNode.normalize();
 237                 adoptElement(rootNode);
 238                 SOAPBodyElement bodyElement = (SOAPBodyElement) convertToSoapElement(rootNode);
 239                 addNode(bodyElement);
 240                 return bodyElement;
 241         */
 242         ///*
 243         SOAPBodyElement newBodyElement = null;
 244         DocumentFragment docFrag = document.createDocumentFragment();
 245         Element rootElement = document.getDocumentElement();
 246         if(rootElement != null) {
 247             docFrag.appendChild(rootElement);
 248 
 249             Document ownerDoc = getOwnerDocument();
 250             // This copies the whole tree which could be very big so it's slow.
 251             // However, it does have the advantage of actually working.
 252             org.w3c.dom.Node replacingNode = ownerDoc.importNode(docFrag, true);
 253             // Adding replacingNode at the last of the children list of body
 254             addNode(replacingNode);
 255             Iterator<Node> i =
 256                 getChildElements(NameImpl.copyElementName(rootElement));
 257             // Return the child element with the required name which is at the
 258             // end of the list
 259             while(i.hasNext())
 260                 newBodyElement = (SOAPBodyElement) i.next();
 261         }
 262         return newBodyElement;
 263         //*/
 264     }
 265 

 266     protected SOAPElement convertToSoapElement(Element element) {
 267         final Node soapNode = getSoapDocument().findIfPresent(element);
 268         if ((soapNode instanceof SOAPBodyElement) &&
 269             //this check is required because ElementImpl currently
 270             // implements SOAPBodyElement
 271             !(soapNode.getClass().equals(ElementImpl.class))) {
 272             return (SOAPElement) soapNode;
 273         } else {
 274             return replaceElementWithSOAPElement(
 275                 element,
 276                 (ElementImpl) createBodyElement(NameImpl
 277                     .copyElementName(element)));
 278         }
 279     }
 280 

 281     public SOAPElement setElementQName(QName newName) throws SOAPException {
 282         log.log(Level.SEVERE,
 283                 "SAAJ0146.impl.invalid.name.change.requested",
 284                 new Object[] {elementQName.getLocalPart(),
 285                               newName.getLocalPart()});
 286         throw new SOAPException("Cannot change name for "
 287                                 + elementQName.getLocalPart() + " to "
 288                                 + newName.getLocalPart());
 289     }
 290 

 291     public Document extractContentAsDocument() throws SOAPException {
 292 
 293         Iterator<Node> eachChild = getChildElements();
 294         javax.xml.soap.Node firstBodyElement = null;
 295 
 296         while (eachChild.hasNext() &&
 297                !(firstBodyElement instanceof SOAPElement))
 298             firstBodyElement = (javax.xml.soap.Node) eachChild.next();
 299 
 300         boolean exactlyOneChildElement = true;
 301         if (firstBodyElement == null)
 302             exactlyOneChildElement = false;
 303         else {
 304             for (org.w3c.dom.Node node = firstBodyElement.getNextSibling();
 305                  node != null;
 306                  node = node.getNextSibling()) {
 307 
 308                 if (node instanceof Element) {
 309                     exactlyOneChildElement = false;
 310                     break;
 311                 }
 312             }
 313         }
 314 
 315         if(!exactlyOneChildElement) {
 316             log.log(Level.SEVERE,
 317                     "SAAJ0250.impl.body.should.have.exactly.one.child");
 318             throw new SOAPException("Cannot extract Document from body");
 319         }
 320 
 321         Document document = null;
 322         try {
 323             DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance("com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl", SAAJUtil.getSystemClassLoader());
 324             factory.setNamespaceAware(true);
 325             DocumentBuilder builder = factory.newDocumentBuilder();
 326             document = builder.newDocument();
 327 
 328             Element rootElement = (Element) document.importNode(
 329                                                 firstBodyElement,
 330                                                 true);
 331 
 332             document.appendChild(rootElement);
 333 
 334         } catch(Exception e) {
 335             log.log(Level.SEVERE,
 336                     "SAAJ0251.impl.cannot.extract.document.from.body");
 337             throw new SOAPExceptionImpl(
 338                 "Unable to extract Document from body", e);
 339         }
 340 
 341         firstBodyElement.detachNode();
 342 
 343         return document;
 344     }
 345 
 346     private void materializePayloadWrapException() {
 347         try {
 348             materializePayload();
 349         } catch (SOAPException e) {
 350             throw new RuntimeException(e);
 351         }
 352     }
 353     private void materializePayload() throws SOAPException {
 354         if (staxBridge != null) {
 355             if (payloadStreamRead) {
 356                 //the payload has already been read via stream reader and the
 357                 //stream has been exhausted already. Throw an
 358                 //exception since we are now trying to materialize as DOM and
 359                 //there is no stream left to read
 360                 throw new SOAPException("SOAPBody payload stream has been fully read - cannot materialize as DOM!");
 361             }
 362             try {
 363                 staxBridge.bridgePayload();
 364                 staxBridge = null;
 365                 payloadStreamRead = true;
 366             } catch (XMLStreamException e) {
 367                 throw new SOAPException(e);
 368             }
 369         }
 370     }
 371 
 372     @Override
 373     public boolean hasChildNodes() {
 374         boolean hasChildren = super.hasChildNodes();
 375         //to answer this question we need to know _whether_ we have at least one child
 376         //So no need to materialize body if we already know we have a header child
 377         if (!hasChildren) {
 378             materializePayloadWrapException();
 379         }
 380         return super.hasChildNodes();
 381     }
 382 
 383     @Override
 384     public NodeList getChildNodes() {
 385         materializePayloadWrapException();
 386         return super.getChildNodes();
 387     }
 388 
 389     @Override
 390     public Node getFirstChild() {
 391         Node child = super.getFirstChild();
 392         if (child == null) {
 393             materializePayloadWrapException();
 394         }
 395         return super.getFirstChild();
 396     }
 397 
 398     public Node getFirstChildNoMaterialize() {
 399         return super.getFirstChild();
 400     }
 401 
 402     @Override
 403     public Node getLastChild() {
 404         materializePayloadWrapException();
 405         return super.getLastChild();
 406     }
 407 
 408     XMLStreamReader getPayloadReader() {
 409         return staxBridge.getPayloadReader();
 410     }
 411 
 412     void setStaxBridge(StaxBridge bridge) {
 413         this.staxBridge = bridge;
 414     }
 415 
 416     StaxBridge getStaxBridge() {
 417         return staxBridge;
 418     }
 419 
 420     void setPayloadStreamRead() {
 421         this.payloadStreamRead = true;
 422     }
 423 
 424     QName getPayloadQName() {
 425         if (staxBridge != null) {
 426                 return staxBridge.getPayloadQName();
 427         } else {
 428             //not lazy - Just get first child element and return its name
 429             Element elem = getFirstChildElement();
 430             if (elem != null) {
 431                 String ns = elem.getNamespaceURI();
 432                 String pref = elem.getPrefix();
 433                 String local = elem.getLocalName();
 434                 if (pref != null) return new QName(ns, local, pref);
 435                 if (ns != null) return new QName(ns, local);
 436                 return new QName(local);
 437             }
 438         }
 439         return null;
 440     }
 441 
 442     String getPayloadAttributeValue(String attName) {
 443         if (staxBridge != null) {
 444             return staxBridge.getPayloadAttributeValue(attName);
 445         } else {
 446             //not lazy -Just get first child element and return its attribute
 447             Element elem = getFirstChildElement();
 448             if (elem != null) {
 449                 return elem.getAttribute(getLocalName());
 450             }
 451         }
 452         return null;
 453     }
 454 
 455     String getPayloadAttributeValue(QName attNAme) {
 456         if (staxBridge != null) {
 457             return staxBridge.getPayloadAttributeValue(attNAme);
 458         } else {
 459             //not lazy -Just get first child element and return its attribute
 460             Element elem = getFirstChildElement();
 461             if (elem != null) {
 462                 return elem.getAttributeNS(attNAme.getNamespaceURI(), attNAme.getLocalPart());
 463             }
 464         }
 465         return null;
 466     }
 467 
 468     public boolean isLazy() {
 469         return (staxBridge != null && !payloadStreamRead);
 470     }
 471 
 472 }
--- EOF ---