org.jvnet.staxex.util
Class SaajStaxWriterEx

java.lang.Object
  org.jvnet.staxex.util.SaajStaxWriter
      org.jvnet.staxex.util.SaajStaxWriterEx

All Implemented Interfaces:

javax.xml.stream.XMLStreamWriter, MtomStreamWriter, XMLStreamWriterEx

public class SaajStaxWriterEx
extends SaajStaxWriter
implements XMLStreamWriterEx, MtomStreamWriter

SaajStaxWriterEx converts XMLStreamWriterEx calls to build an orasaaj SOAPMessage with BinaryTextImpl.

Author:

shih-chang.chen@oracle.com

Field Summary

protected static java.lang.String	href
protected static java.lang.String	Include
protected static java.lang.String	xopNS

Fields inherited from class org.jvnet.staxex.util.SaajStaxWriter

Body, currentElement, Envelope, envURI, Header, soap, xmlns

Constructor Summary

SaajStaxWriterEx(javax.xml.soap.SOAPMessage msg, java.lang.String uri)

Method Summary

javax.xml.bind.attachment.AttachmentMarshaller	getAttachmentMarshaller()
NamespaceContextEx	getNamespaceContext()
void	writeAttribute(java.lang.String prefix, java.lang.String ns, java.lang.String ln, java.lang.String value)
void	writeBinary(byte[] data, int offset, int length, java.lang.String contentType) Write the binary data.
void	writeBinary(javax.activation.DataHandler data) Writes the binary data.
java.io.OutputStream	writeBinary(java.lang.String arg0) Writes the binary data.
void	writeEndElement()
void	writePCDATA(java.lang.CharSequence arg0) Writes like XMLStreamWriter.writeCharacters(String) but hides actual data format.
void	writeStartElement(java.lang.String prefix, java.lang.String ln, java.lang.String ns)

Methods inherited from class org.jvnet.staxex.util.SaajStaxWriter

close, flush, getEnvelope, getPrefix, getProperty, getSOAPMessage, setDefaultNamespace, setNamespaceContext, setPrefix, writeAttribute, writeAttribute, writeCData, writeCharacters, writeCharacters, writeComment, writeDefaultNamespace, writeDTD, writeEmptyElement, writeEmptyElement, writeEmptyElement, writeEndDocument, writeEntityRef, writeNamespace, writeProcessingInstruction, writeProcessingInstruction, writeStartDocument, writeStartDocument, writeStartDocument, writeStartElement, writeStartElement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.xml.stream.XMLStreamWriter

close, flush, getPrefix, getProperty, setDefaultNamespace, setNamespaceContext, setPrefix, writeAttribute, writeAttribute, writeCData, writeCharacters, writeCharacters, writeComment, writeDefaultNamespace, writeDTD, writeEmptyElement, writeEmptyElement, writeEmptyElement, writeEndDocument, writeEntityRef, writeNamespace, writeProcessingInstruction, writeProcessingInstruction, writeStartDocument, writeStartDocument, writeStartDocument, writeStartElement, writeStartElement

Field Detail

xopNS

protected static final java.lang.String xopNS

See Also:

Constant Field Values

Include

protected static final java.lang.String Include

See Also:

Constant Field Values

href

protected static final java.lang.String href

See Also:

Constant Field Values

Constructor Detail

SaajStaxWriterEx

public SaajStaxWriterEx(javax.xml.soap.SOAPMessage msg,
                        java.lang.String uri)
                 throws javax.xml.soap.SOAPException

Throws:

javax.xml.soap.SOAPException

Method Detail

writeStartElement

public void writeStartElement(java.lang.String prefix,
                              java.lang.String ln,
                              java.lang.String ns)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeStartElement in class SaajStaxWriter

Throws:

javax.xml.stream.XMLStreamException

writeEndElement

public void writeEndElement()
                     throws javax.xml.stream.XMLStreamException

Specified by:

writeEndElement in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeEndElement in class SaajStaxWriter

Throws:

javax.xml.stream.XMLStreamException

writeAttribute

public void writeAttribute(java.lang.String prefix,
                           java.lang.String ns,
                           java.lang.String ln,
                           java.lang.String value)
                    throws javax.xml.stream.XMLStreamException

Specified by:

writeAttribute in interface javax.xml.stream.XMLStreamWriter

Overrides:

writeAttribute in class SaajStaxWriter

Throws:

javax.xml.stream.XMLStreamException

getNamespaceContext

public NamespaceContextEx getNamespaceContext()

Description copied from interface: XMLStreamWriterEx

Specified by:

getNamespaceContext in interface javax.xml.stream.XMLStreamWriter

Specified by:

getNamespaceContext in interface XMLStreamWriterEx

Overrides:

getNamespaceContext in class SaajStaxWriter

writeBinary

public void writeBinary(javax.activation.DataHandler data)
                 throws javax.xml.stream.XMLStreamException

Description copied from interface: XMLStreamWriterEx

Writes the binary data.

This method works like the XMLStreamWriterEx.writeBinary(byte[], int, int, String) method, except that it takes the binary data in the form of DataHandler, which contains a MIME type (DataHandler.getContentType() as well as the payload DataHandler.getInputStream().

Specified by:

writeBinary in interface XMLStreamWriterEx

Parameters:

data - always non-null. After this method call, the callee owns the data handler.

Throws:

javax.xml.stream.XMLStreamException

writeBinary

public java.io.OutputStream writeBinary(java.lang.String arg0)
                                 throws javax.xml.stream.XMLStreamException

Description copied from interface: XMLStreamWriterEx

Writes the binary data.

This version of the writeBinary method allows the caller to produce the binary data by writing it to OutputStream.

It is the caller's responsibility to write and close a stream before it invokes any other methods on XMLStreamWriter. TODO: experimental. appreciate feedback

Specified by:

writeBinary in interface XMLStreamWriterEx

Parameters:

arg0 - See the content-type parameter of XMLStreamWriterEx.writeBinary(byte[], int, int, String). Must not be null.

Returns:

always return a non-null OutputStream.

Throws:

javax.xml.stream.XMLStreamException

writeBinary

public void writeBinary(byte[] data,
                        int offset,
                        int length,
                        java.lang.String contentType)
                 throws javax.xml.stream.XMLStreamException

Description copied from interface: XMLStreamWriterEx

Write the binary data.

Conceptually (infoset-wise), this produces the base64-encoded binary data on the output. But this allows implementations like FastInfoset or XOP to do the smart thing.

The use of this method has some restriction to support XOP. Namely, this method must be invoked as a sole content of an element.

(data,start,len) triplet identifies the binary data to be written. After the method invocation, the callee owns the buffer.

Specified by:

writeBinary in interface XMLStreamWriterEx

contentType - this mandatory parameter identifies the MIME type of the binary data. If the MIME type isn't known by the caller, "application/octet-stream" can be always used to indicate "I don't know." Never null.

Throws:

javax.xml.stream.XMLStreamException

writePCDATA

public void writePCDATA(java.lang.CharSequence arg0)
                 throws javax.xml.stream.XMLStreamException

Description copied from interface: XMLStreamWriterEx

Writes like XMLStreamWriter.writeCharacters(String) but hides actual data format.

Specified by:

writePCDATA in interface XMLStreamWriterEx

Parameters:

arg0 - The CharSequence that represents the character infoset items to be written.

The CharSequence is normally a String, but can be any other CharSequence implementation. For binary data, however, use of Base64Data is recommended (so that the consumer interested in seeing it as binary data may take advantage of mor efficient data representation.)

Throws:

javax.xml.stream.XMLStreamException

getAttachmentMarshaller

public javax.xml.bind.attachment.AttachmentMarshaller getAttachmentMarshaller()

Specified by:

getAttachmentMarshaller in interface MtomStreamWriter