org.apache.axiom.soap.impl.llom.SOAPEnvelopeImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of axiom-impl Show documentation
Show all versions of axiom-impl Show documentation
The default implementation of the Axiom API.
/*
* 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.llom;
import javax.xml.namespace.QName;
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.OMOutputFormat;
import org.apache.axiom.om.OMXMLParserWrapper;
import org.apache.axiom.om.impl.builder.StAXBuilder;
import org.apache.axiom.om.impl.common.serializer.push.OutputException;
import org.apache.axiom.om.impl.common.serializer.push.Serializer;
import org.apache.axiom.soap.SOAP11Constants;
import org.apache.axiom.soap.SOAP12Constants;
import org.apache.axiom.soap.SOAPBody;
import org.apache.axiom.soap.SOAPConstants;
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.builder.StAXSOAPModelBuilder;
import org.apache.axiom.soap.impl.intf.AxiomSOAPEnvelope;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/** Class SOAPEnvelopeImpl */
public abstract class SOAPEnvelopeImpl extends SOAPElement
implements AxiomSOAPEnvelope, OMConstants {
private static final Log log = LogFactory.getLog(SOAPEnvelopeImpl.class);
public SOAPVersion getVersion() {
return ((SOAPFactory)getOMFactory()).getSOAPVersion();
}
public SOAPHeader getHeader() {
// The soap header is the first element in the envelope.
OMElement e = getFirstElement();
if (e instanceof SOAPHeader) {
return (SOAPHeader)e;
}
return null;
}
public SOAPHeader getOrCreateHeader() {
SOAPHeader header = getHeader();
return header != null ? header : ((SOAPFactory)getOMFactory()).createSOAPHeader(this);
}
/**
* Add a SOAPHeader or SOAPBody object
* @param child an OMNode to add - must be either a SOAPHeader or a SOAPBody
*/
public void addChild(OMNode child, boolean fromBuilder) {
internalCheckChild(child);
if (child instanceof SOAPHeader) {
// The SOAPHeader is added before the SOAPBody
// We must be sensitive to the state of the parser. It is possible that the
// has not been processed yet.
if (getState() == COMPLETE) {
// Parsing is complete, therefore it is safe to
// call getBody.
SOAPBody body = getBody();
if (body != null) {
body.insertSiblingBefore(child);
return;
}
} else {
// Flow to here indicates that we are still expanding the
// envelope. The body or body contents may not be
// parsed yet. We can't use getBody() yet...it will
// cause a failure. So instead, carefully find the
// body and insert the header. If the body is not found,
// this indicates that it has not been parsed yet...and
// the code will fall through to the super.addChild.
OMNode node = (OMNode)coreGetLastKnownChild();
while (node != null) {
if (node instanceof SOAPBody) {
node.insertSiblingBefore(child);
return;
}
node = node.getPreviousOMSibling();
}
}
}
super.addChild(child, fromBuilder);
}
/**
* 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 OMException if there is a problem obtaining the SOAPBody object
*/
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();
}
if (node == null) {
// The envelope only contains a header
return null;
} else if (SOAPConstants.BODY_LOCAL_NAME.equals(((OMElement)node).getLocalName())) {
return (SOAPBody)node;
} else {
throw new OMException("SOAPEnvelope must contain a body element " +
"which is either first or second child element of the SOAPEnvelope.");
}
}
}
return null;
}
public void checkParent(OMElement parent) throws SOAPProcessingException {
// here do nothing as SOAPEnvelope doesn't have a parent !!!
}
public void internalSerialize(Serializer serializer, OMOutputFormat format, boolean cache)
throws OutputException {
if (!format.isIgnoreXMLDeclaration()) {
String charSetEncoding = format.getCharSetEncoding();
String xmlVersion = format.getXmlVersion();
serializer.writeStartDocument(
charSetEncoding == null ? OMConstants.DEFAULT_CHAR_SET_ENCODING
: charSetEncoding,
xmlVersion == null ? OMConstants.DEFAULT_XML_VERSION : xmlVersion);
}
super.internalSerialize(serializer, format, cache);
serializer.writeEndDocument();
if (!cache) {
// let's try to close the builder/parser here since we are now done with the
// non-caching code block serializing the top-level SOAPEnvelope element
// TODO: should use 'instance of OMXMLParserWrapper' instead? StAXBuilder is more generic
OMXMLParserWrapper builder = getBuilder();
if ((builder != null) && (builder instanceof StAXBuilder)) {
try {
if (log.isDebugEnabled()) {
log.debug("closing builder: " + builder);
}
StAXBuilder staxBuilder = (StAXBuilder) builder;
staxBuilder.close();
} catch (Exception e) {
if (log.isDebugEnabled()) {
log.error("Could not close builder or parser due to: ", e);
}
}
} else {
if (log.isDebugEnabled()) {
log.debug("Could not close builder or parser due to:");
if (builder == null) {
log.debug("builder is null");
}
if ((builder != null) && !(builder instanceof StAXBuilder)) {
log.debug("builder is not instance of " + StAXBuilder.class.getName());
}
}
}
}
}
public boolean hasFault() {
QName payloadQName = this.getPayloadQName_Optimized();
if (payloadQName != null) {
if (SOAPConstants.SOAPFAULT_LOCAL_NAME.equals(payloadQName.getLocalPart())) {
String ns = payloadQName.getNamespaceURI();
return SOAP11Constants.SOAP_ENVELOPE_NAMESPACE_URI.equals(ns) ||
SOAP12Constants.SOAP_ENVELOPE_NAMESPACE_URI.equals(ns);
}
}
// Fallback: Get the body and get the fault information from the body
SOAPBody body = this.getBody();
return (body == null) ? false : body.hasFault();
}
public String getSOAPBodyFirstElementLocalName() {
QName payloadQName = this.getPayloadQName_Optimized();
if (payloadQName != null) {
return payloadQName.getLocalPart();
}
SOAPBody body = this.getBody();
return (body == null) ? null : body.getFirstElementLocalName();
}
public OMNamespace getSOAPBodyFirstElementNS() {
QName payloadQName = this.getPayloadQName_Optimized();
if (payloadQName != null) {
return getOMFactory().createOMNamespace(payloadQName.getNamespaceURI(),
payloadQName.getPrefix());
}
SOAPBody body = this.getBody();
return (body == null) ? null : body.getFirstElementNS();
}
/**
* Use a parser property to fetch the first element in the body.
* Returns null if this optimized property is not set or not available.
* @return The qname of the first element in the body or null
*/
private QName getPayloadQName_Optimized() {
// The parser may expose a SOAPBODY_FIRST_CHILD_ELEMENT_QNAME property
// Use that QName to determine if there is a fault
OMXMLParserWrapper builder = this.getBuilder();
if (builder instanceof StAXSOAPModelBuilder) {
try {
QName payloadQName = (QName) ((StAXSOAPModelBuilder) builder).
getReaderProperty(SOAPConstants.SOAPBODY_FIRST_CHILD_ELEMENT_QNAME);
return payloadQName;
} catch (Throwable e) {
// The parser may not support this property.
// In such cases, processing continues below in the fallback approach
}
}
return null;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy