public final class OutboundStreamHeader extends AbstractHeaderImpl
XMLStreamBuffer
.
This is optimized for outbound use, so it implements some of the methods lazily, in a slow way.
Modifier and Type | Class and Description |
---|---|
(package private) static class |
OutboundStreamHeader.Attribute
Keep the information about an attribute on the header element.
|
EMPTY_ATTS
Constructor and Description |
---|
OutboundStreamHeader(com.sun.xml.stream.buffer.XMLStreamBuffer infoset,
String nsUri,
String localName) |
Modifier and Type | Method and Description |
---|---|
String |
getAttribute(String nsUri,
String localName)
Gets the attribute value on the header element.
|
String |
getLocalPart()
Gets the local name of this header element.
|
String |
getNamespaceURI()
Gets the namespace URI of this header element.
|
javax.xml.stream.XMLStreamReader |
readHeader()
Reads the header as a
XMLStreamReader . |
void |
writeTo(ContentHandler contentHandler,
ErrorHandler errorHandler)
Writes out the header as SAX events.
|
void |
writeTo(javax.xml.soap.SOAPMessage saaj)
Writes out the header to the given SOAPMessage.
|
void |
writeTo(javax.xml.stream.XMLStreamWriter w)
Writes out the header as a fragment.
|
getAttribute, getRole, getStringContent, isIgnorable, isRelay, parseBool, readAsEPR, readAsJAXB, readAsJAXB, readAsJAXB, readAsJAXB
@NotNull public String getNamespaceURI()
Header
@NotNull public String getLocalPart()
Header
public String getAttribute(String nsUri, String localName)
Header
nsUri
- The namespace URI of the attribute. Can be empty.localName
- The local name of the attribute.Header
implementation
doesn't have to do anything.public javax.xml.stream.XMLStreamReader readHeader() throws javax.xml.stream.XMLStreamException
Header
XMLStreamReader
.
The returned parser points at the start element of this header.
(IOW, XMLStreamReader.getEventType()
would return
XMLStreamConstants.START_ELEMENT
.
For some Header
implementations, this operation
is a non-trivial operation. Therefore, use of this method
is discouraged unless the caller is interested in reading
the whole header.
Similarly, if the caller wants to use this method only to do
the API conversion (such as simply firing SAX events from
XMLStreamReader
), then the JAX-WS team requests
that you talk to us.
Message
s that come from tranport usually provides
a reasonably efficient implementation of this method.
javax.xml.stream.XMLStreamException
public void writeTo(javax.xml.stream.XMLStreamWriter w) throws javax.xml.stream.XMLStreamException
Header
javax.xml.stream.XMLStreamException
- if the operation fails for some reason. This leaves the
writer to an undefined state.public void writeTo(javax.xml.soap.SOAPMessage saaj) throws javax.xml.soap.SOAPException
Header
Sometimes a Message
needs to produce itself
as SOAPMessage
, in which case each header needs
to turn itself into a header.
javax.xml.soap.SOAPException
- if the operation fails for some reason. This leaves the
writer to an undefined state.public void writeTo(ContentHandler contentHandler, ErrorHandler errorHandler) throws SAXException
Header
Sometimes a Message
needs to produce SAX events,
and this method is necessary for headers to participate to it.
A header is responsible for producing the SAX events for its part, including startPrefixMapping and endPrefixMapping, but not startDocument/endDocument.
Note that SAX contract requires that any error that does NOT originate
from ContentHandler
(meaning any parsing error and etc) must
be first reported to ErrorHandler
. If the SAX event production
cannot be continued and the processing needs to abort, the code may
then throw the same SAXParseException
reported to ErrorHandler
.
contentHandler
- The ContentHandler
that receives SAX events.errorHandler
- The ErrorHandler
that receives parsing errors.SAXException
Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.