Java soapmessage soap xml javax

Getting Raw XML From SOAPMessage in Java

I’ve set up a SOAP WebServiceProvider in JAX-WS, but I’m having trouble figuring out how to get the raw XML from a SOAPMessage (or any Node) object. Here’s a sample of the code I’ve got right now, and where I’m trying to grab the XML:

@WebServiceProvider(wsdlLocation="SoapService.wsdl") @ServiceMode(value=Service.Mode.MESSAGE) public class SoapProvider implements Provider  < public SOAPMessage invoke(SOAPMessage msg) < // How do I get the raw XML here? >> 

Is there a simple way to get the XML of the original request? If there’s a way to get the raw XML by setting up a different type of Provider (such as Source), I’d be willing to do that, too.

9 Answers 9

You could try in this way.

SOAPMessage msg = messageContext.getMessage(); ByteArrayOutputStream out = new ByteArrayOutputStream(); msg.writeTo(out); String strMsg = new String(out.toByteArray()); 

Will it consume much memory with something like constructing DOM objects or the like? Or will it really give the raw string from the HTTP response without internally parsing the xml?

@artbristol : you can use String class other constructor i.e. String(out.toByteArray(),StandardCharsets.UTF_8) for handling character encoding

Sigh. 166 upvotes so far. Please don’t use this answer. You will mangle your ‘special characters’. You can’t use the String constructor idea suggested by Ashish, because you would need to specify the character encoding in the source code at compile time, but you don’t know it until runtime. Please use my answer.

If you have a SOAPMessage or SOAPMessageContext , you can use a Transformer , by converting it to a Source via DOMSource :

 final SOAPMessage message = messageContext.getMessage(); final StringWriter sw = new StringWriter(); try < TransformerFactory.newInstance().newTransformer().transform( new DOMSource(message.getSOAPPart()), new StreamResult(sw)); >catch (TransformerException e) < throw new RuntimeException(e); >// Now you have the XML as a String: System.out.println(sw.toString()); 

This will take the encoding into account, so your «special characters» won’t get mangled.

It turns out that one can get the raw XML by using Provider, in this way:

import java.io.ByteArrayOutputStream; import javax.xml.transform.Source; import javax.xml.transform.Transformer; import javax.xml.transform.TransformerFactory; import javax.xml.transform.stream.StreamResult; import javax.xml.ws.Provider; import javax.xml.ws.Service; import javax.xml.ws.ServiceMode; import javax.xml.ws.WebServiceProvider; @ServiceMode(value=Service.Mode.PAYLOAD) @WebServiceProvider() public class SoapProvider implements Provider  < public Source invoke(Source msg) < StreamResult sr = new StreamResult(); ByteArrayOutputStream out = new ByteArrayOutputStream(); sr.setOutputStream(out); try < Transformer trans = TransformerFactory.newInstance().newTransformer(); trans.transform(msg, sr); // Use out to your heart's desire. >catch (TransformerException e) < e.printStackTrace(); >return msg; > > 

I’ve ended up not needing this solution, so I haven’t actually tried this code myself — it might need some tweaking to get right. But I know this is the right path to go down to get the raw XML from a web service.

(I’m not sure how to make this work if you absolutely must have a SOAPMessage object, but then again, if you’re going to be handling the raw XML anyways, why would you use a higher-level object?)

Источник

Java soapmessage soap xml javax

In addition to the mandatory SOAPPart object, a SOAPMessage object may contain zero or more AttachmentPart objects, each of which contains application-specific data. The SOAPMessage interface provides methods for creating AttachmentPart objects and also for adding them to a SOAPMessage object. A party that has received a SOAPMessage object can examine its contents by retrieving individual attachment parts. Unlike the rest of a SOAP message, an attachment is not required to be in XML format and can therefore be anything from simple text to an image file. Consequently, any message content that is not in XML format must be in an AttachmentPart object. A MessageFactory object may create SOAPMessage objects with behavior that is specialized to a particular implementation or application of SAAJ. For instance, a MessageFactory object may produce SOAPMessage objects that conform to a particular Profile such as ebXML. In this case a MessageFactory object might produce SOAPMessage objects that are initialized with ebXML headers. In order to ensure backward source compatibility, methods that are added to this class after version 1.1 of the SAAJ specification are all concrete instead of abstract and they all have default implementations. Unless otherwise noted in the JavaDocs for those methods the default implementations simply throw an UnsupportedOperationException and the SAAJ implementation code must override them with methods that provide the specified behavior. Legacy client code does not have this restriction, however, so long as there is no claim made that it conforms to some later version of the specification than it was originally written for. A legacy class that extends the SOAPMessage class can be compiled and/or run against succeeding versions of the SAAJ API without modification. If such a class was correctly implemented then it will continue to behave correctly relative to the version of the specification against which it was written.

Field Summary

Constructor Summary

Method Summary

Creates an AttachmentPart object and populates it with the specified data of the specified content type.

Returns an AttachmentPart object that is associated with an attachment that is referenced by this SOAPElement or null if no such attachment exists.

Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion.

Methods inherited from class java.lang.Object

Field Detail

CHARACTER_SET_ENCODING

Specifies the character type encoding for the SOAP Message. Valid values include «utf-8» and «utf-16». See vendor documentation for additional supported values. The default is «utf-8».

WRITE_XML_DECLARATION

Specifies whether the SOAP Message will contain an XML declaration when it is sent. The only valid values are «true» and «false». The default is «false».

Constructor Detail

SOAPMessage

Method Detail

setContentDescription

getContentDescription

getSOAPPart

Gets the SOAP part of this SOAPMessage object. SOAPMessage object contains one or more attachments, the SOAP Part must be the first MIME body part in the message.

getSOAPBody

public SOAPBody getSOAPBody​() throws SOAPException

getSOAPHeader

public SOAPHeader getSOAPHeader​() throws SOAPException

removeAllAttachments

public abstract void removeAllAttachments​()

Removes all AttachmentPart objects that have been added to this SOAPMessage object. This method does not touch the SOAP part.

countAttachments

public abstract int countAttachments​()

Gets a count of the number of attachments in this message. This count does not include the SOAP part.

getAttachments

public abstract IteratorAttachmentPart> getAttachments​()

getAttachments

public abstract IteratorAttachmentPart> getAttachments​(MimeHeaders headers)

Retrieves all the AttachmentPart objects that have header entries that match the specified headers. Note that a returned attachment could have headers in addition to those specified.

removeAttachments

Removes all the AttachmentPart objects that have header entries that match the specified headers. Note that the removed attachment could have headers in addition to those specified.

getAttachment

public abstract AttachmentPart getAttachment​(SOAPElement element) throws SOAPException

Returns an AttachmentPart object that is associated with an attachment that is referenced by this SOAPElement or null if no such attachment exists. References can be made via an href attribute as described in SOAP Messages with Attachments, or via a single Text child node containing a URI as described in the WS-I Attachments Profile 1.0 for elements of schema type ref:swaRef. These two mechanisms must be supported. The support for references via href attribute also implies that this method should also be supported on an element that is an xop:Include element ( XOP). other reference mechanisms may be supported by individual implementations of this standard. Contact your vendor for details.

addAttachmentPart

Adds the given AttachmentPart object to this SOAPMessage object. An AttachmentPart object must be created before it can be added to a message.

createAttachmentPart

Creates a new empty AttachmentPart object. Note that the method addAttachmentPart must be called with this new AttachmentPart object as the parameter in order for it to become an attachment to this SOAPMessage object.

createAttachmentPart

public AttachmentPart createAttachmentPart​(DataHandler dataHandler)

getMimeHeaders

Returns all the transport-specific MIME headers for this SOAPMessage object in a transport-independent fashion.

createAttachmentPart

public AttachmentPart createAttachmentPart​(Object content, String contentType)

Creates an AttachmentPart object and populates it with the specified data of the specified content type. The type of the Object should correspond to the value given for the Content-Type .

saveChanges

Updates this SOAPMessage object with all the changes that have been made to it. This method is called automatically when writeTo(OutputStream) is called. However, if changes are made to a message that was received or to one that has already been sent, the method saveChanges needs to be called explicitly in order to save the changes. The method saveChanges also generates any changes that can be read back (for example, a MessageId in profiles that support a message id). All MIME headers in a message that is created for sending purposes are guaranteed to have valid values only after saveChanges has been called. In addition, this method marks the point at which the data from all constituent AttachmentPart objects are pulled into the message.

saveRequired

public abstract boolean saveRequired​()

writeTo

public abstract void writeTo​(OutputStream out) throws SOAPException, IOException

Writes this SOAPMessage object to the given output stream. The externalization format is as defined by the SOAP 1.1 with Attachments specification. If there are no attachments, just an XML stream is written out. For those messages that have attachments, writeTo writes a MIME-encoded byte stream. Note that this method does not write the transport-specific MIME Headers of the Message

setProperty

public void setProperty​(String property, Object value) throws SOAPException

Associates the specified value with the specified property. If there was already a value associated with this property, the old value is replaced. The valid property names include WRITE_XML_DECLARATION and CHARACTER_SET_ENCODING . All of these standard SAAJ properties are prefixed by «javax.xml.soap». Vendors may also add implementation specific properties. These properties must be prefixed with package names that are unique to the vendor. Setting the property WRITE_XML_DECLARATION to «true» will cause an XML Declaration to be written out at the start of the SOAP message. The default value of «false» suppresses this declaration. The property CHARACTER_SET_ENCODING defaults to the value «utf-8» which causes the SOAP message to be encoded using UTF-8. Setting CHARACTER_SET_ENCODING to «utf-16» causes the SOAP message to be encoded using UTF-16. Some implementations may allow encodings in addition to UTF-8 and UTF-16. Refer to your vendor’s documentation for details.

getProperty

public Object getProperty​(String property) throws SOAPException

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.

Источник