Package com.sun.xml.messaging.saaj.util.stax

Class SaajStaxWriter

java.lang.Object

com.sun.xml.messaging.saaj.util.stax.SaajStaxWriter

All Implemented Interfaces:

XMLStreamWriter

Direct Known Subclasses:

SaajStaxWriterEx

public class SaajStaxWriter
extends Object
implements XMLStreamWriter

SaajStaxWriter builds a SAAJ SOAPMessage by using XMLStreamWriter interface.

Defers creation of SOAPElement until all the aspects of the name of the element are known. In some cases, the namespace uri is indicated only by the writeNamespace(String, String) call. After opening an element (writeStartElement, writeEmptyElement methods), all attributes and namespace assignments are retained within SaajStaxWriter.DeferredElement object (deferredElement field). As soon as any other method than writeAttribute, writeNamespace, writeDefaultNamespace or setNamespace is called, the contents of deferredElement is transformed into new SOAPElement (which is appropriately inserted into the SOAPMessage under construction). This mechanism is necessary to fix JDK-8159058 issue.

Author:

shih-chang.chen@oracle.com

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	Body
protected jakarta.xml.soap.SOAPElement	currentElement
protected com.sun.xml.messaging.saaj.util.stax.SaajStaxWriter.DeferredElement	deferredElement
protected static String	Envelope
protected String	envURI
protected static String	Header
protected jakarta.xml.soap.SOAPMessage	soap
protected static String	xmlns

Constructor Summary

Constructors

Constructor	Description
SaajStaxWriter(jakarta.xml.soap.SOAPMessage msg, String uri)

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
protected jakarta.xml.soap.SOAPElement	getEnvelope()
NamespaceContext	getNamespaceContext()
String	getPrefix(String uri)
Object	getProperty(String name)
jakarta.xml.soap.SOAPMessage	getSOAPMessage()
void	setDefaultNamespace(String uri)
void	setNamespaceContext(NamespaceContext context)
void	setPrefix(String prefix, String uri)
void	writeAttribute(String ln, String val)
void	writeAttribute(String ns, String ln, String val)
void	writeAttribute(String prefix, String ns, String ln, String value)
void	writeCData(String data)
void	writeCharacters(char[] text, int start, int len)
void	writeCharacters(String text)
void	writeComment(String data)
void	writeDefaultNamespace(String uri)
void	writeDTD(String dtd)
void	writeEmptyElement(String ln)
void	writeEmptyElement(String uri, String ln)
void	writeEmptyElement(String prefix, String ln, String uri)
void	writeEndDocument()
void	writeEndElement()
void	writeEntityRef(String name)
void	writeNamespace(String prefix, String uri)
void	writeProcessingInstruction(String target)
void	writeProcessingInstruction(String target, String data)
void	writeStartDocument()
void	writeStartDocument(String version)
void	writeStartDocument(String encoding, String version)
void	writeStartElement(String localName)
void	writeStartElement(String ns, String ln)
void	writeStartElement(String prefix, String ln, String ns)

Methods inherited from class java.lang.Object

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

Field Detail

soap

protected jakarta.xml.soap.SOAPMessage soap

envURI

protected String envURI

currentElement

protected jakarta.xml.soap.SOAPElement currentElement

deferredElement

protected com.sun.xml.messaging.saaj.util.stax.SaajStaxWriter.DeferredElement deferredElement

Envelope

protected static final String Envelope

See Also:

Constant Field Values

Header

protected static final String Header

See Also:

Constant Field Values

Body

protected static final String Body

See Also:

Constant Field Values

xmlns

protected static final String xmlns

See Also:

Constant Field Values

Constructor Detail

SaajStaxWriter

public SaajStaxWriter(jakarta.xml.soap.SOAPMessage msg,
                      String uri)
               throws jakarta.xml.soap.SOAPException

Throws:

jakarta.xml.soap.SOAPException

Method Detail

getSOAPMessage

public jakarta.xml.soap.SOAPMessage getSOAPMessage()

getEnvelope

protected jakarta.xml.soap.SOAPElement getEnvelope()
                                            throws jakarta.xml.soap.SOAPException

Throws:

jakarta.xml.soap.SOAPException

writeStartElement

public void writeStartElement(String localName)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String ns,
                              String ln)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String prefix,
                              String ln,
                              String ns)
                       throws XMLStreamException

Specified by:

writeStartElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String uri,
                              String ln)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String prefix,
                              String ln,
                              String uri)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String ln)
                       throws XMLStreamException

Specified by:

writeEmptyElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEndElement

public void writeEndElement()
                     throws XMLStreamException

Specified by:

writeEndElement in interface XMLStreamWriter

Throws:

XMLStreamException

writeEndDocument

public void writeEndDocument()
                      throws XMLStreamException

Specified by:

writeEndDocument in interface XMLStreamWriter

Throws:

XMLStreamException

close

public void close()
           throws XMLStreamException

Specified by:

close in interface XMLStreamWriter

Throws:

XMLStreamException

flush

public void flush()
           throws XMLStreamException

Specified by:

flush in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String ln,
                           String val)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String prefix,
                           String ns,
                           String ln,
                           String value)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeAttribute

public void writeAttribute(String ns,
                           String ln,
                           String val)
                    throws XMLStreamException

Specified by:

writeAttribute in interface XMLStreamWriter

Throws:

XMLStreamException

writeNamespace

public void writeNamespace(String prefix,
                           String uri)
                    throws XMLStreamException

Specified by:

writeNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

writeDefaultNamespace

public void writeDefaultNamespace(String uri)
                           throws XMLStreamException

Specified by:

writeDefaultNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

writeComment

public void writeComment(String data)
                  throws XMLStreamException

Specified by:

writeComment in interface XMLStreamWriter

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(String target)
                                throws XMLStreamException

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Throws:

XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(String target,
                                       String data)
                                throws XMLStreamException

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Throws:

XMLStreamException

writeCData

public void writeCData(String data)
                throws XMLStreamException

Specified by:

writeCData in interface XMLStreamWriter

Throws:

XMLStreamException

writeDTD

public void writeDTD(String dtd)
              throws XMLStreamException

Specified by:

writeDTD in interface XMLStreamWriter

Throws:

XMLStreamException

writeEntityRef

public void writeEntityRef(String name)
                    throws XMLStreamException

Specified by:

writeEntityRef in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument()
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(String version)
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeStartDocument

public void writeStartDocument(String encoding,
                               String version)
                        throws XMLStreamException

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(String text)
                     throws XMLStreamException

Specified by:

writeCharacters in interface XMLStreamWriter

Throws:

XMLStreamException

writeCharacters

public void writeCharacters(char[] text,
                            int start,
                            int len)
                     throws XMLStreamException

Specified by:

writeCharacters in interface XMLStreamWriter

Throws:

XMLStreamException

getPrefix

public String getPrefix(String uri)
                 throws XMLStreamException

Specified by:

getPrefix in interface XMLStreamWriter

Throws:

XMLStreamException

setPrefix

public void setPrefix(String prefix,
                      String uri)
               throws XMLStreamException

Specified by:

setPrefix in interface XMLStreamWriter

Throws:

XMLStreamException

setDefaultNamespace

public void setDefaultNamespace(String uri)
                         throws XMLStreamException

Specified by:

setDefaultNamespace in interface XMLStreamWriter

Throws:

XMLStreamException

setNamespaceContext

public void setNamespaceContext(NamespaceContext context)
                         throws XMLStreamException

Specified by:

setNamespaceContext in interface XMLStreamWriter

Throws:

XMLStreamException

getProperty

public Object getProperty(String name)
                   throws IllegalArgumentException

Specified by:

getProperty in interface XMLStreamWriter

Throws:

IllegalArgumentException

getNamespaceContext

public NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface XMLStreamWriter