com.sun.xml.ws.message
Class ProblemActionHeader

java.lang.Object
  extended by com.sun.xml.ws.message.AbstractHeaderImpl
      extended by com.sun.xml.ws.message.ProblemActionHeader
All Implemented Interfaces:
Header

public class ProblemActionHeader
extends AbstractHeaderImpl

Header that represents <wsa:ProblemAction>


Field Summary
protected  String action
           
protected  AddressingVersion av
           
protected  String soapAction
           
 
Fields inherited from class com.sun.xml.ws.message.AbstractHeaderImpl
EMPTY_ATTS
 
Constructor Summary
ProblemActionHeader(String action, AddressingVersion av)
           
ProblemActionHeader(String action, String soapAction, AddressingVersion av)
           
 
Method Summary
 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 h, 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.
 
Methods inherited from class com.sun.xml.ws.message.AbstractHeaderImpl
getAttribute, getRole, getStringContent, isIgnorable, isRelay, parseBool, readAsEPR, readAsJAXB, readAsJAXB, readAsJAXB
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

action

@NotNull
protected String action

soapAction

protected String soapAction

av

@NotNull
protected AddressingVersion av
Constructor Detail

ProblemActionHeader

public ProblemActionHeader(@NotNull
                           String action,
                           @NotNull
                           AddressingVersion av)

ProblemActionHeader

public ProblemActionHeader(@NotNull
                           String action,
                           String soapAction,
                           @NotNull
                           AddressingVersion av)
Method Detail

getNamespaceURI

@NotNull
public String getNamespaceURI()
Description copied from interface: Header
Gets the namespace URI of this header element.

Returns:
this string must be interned.

getLocalPart

@NotNull
public String getLocalPart()
Description copied from interface: Header
Gets the local name of this header element.

Returns:
this string must be interned.

getAttribute

@Nullable
public String getAttribute(@NotNull
                                    String nsUri,
                                    @NotNull
                                    String localName)
Description copied from interface: Header
Gets the attribute value on the header element.

Parameters:
nsUri - The namespace URI of the attribute. Can be empty.
localName - The local name of the attribute.
Returns:
if the attribute is found, return the whitespace normalized value. (meaning no leading/trailing space, no consequtive whitespaces in-between.) Otherwise null. Note that the XML parsers are responsible for whitespace-normalizing attributes, so Header implementation doesn't have to do anything.

readHeader

public javax.xml.stream.XMLStreamReader readHeader()
                                            throws javax.xml.stream.XMLStreamException
Description copied from interface: Header
Reads the header as a XMLStreamReader.

The returned parser points at the start element of this header. (IOW, XMLStreamReader.getEventType() would return XMLStreamConstants.START_ELEMENT.

Performance Expectation

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.

Messages that come from tranport usually provides a reasonably efficient implementation of this method.

Returns:
must not null.
Throws:
javax.xml.stream.XMLStreamException

writeTo

public void writeTo(javax.xml.stream.XMLStreamWriter w)
             throws javax.xml.stream.XMLStreamException
Description copied from interface: Header
Writes out the header as a fragment.

Throws:
javax.xml.stream.XMLStreamException - if the operation fails for some reason. This leaves the writer to an undefined state.

writeTo

public void writeTo(javax.xml.soap.SOAPMessage saaj)
             throws javax.xml.soap.SOAPException
Description copied from interface: Header
Writes out the header to the given SOAPMessage.

Sometimes a Message needs to produce itself as SOAPMessage, in which case each header needs to turn itself into a header.

Throws:
javax.xml.soap.SOAPException - if the operation fails for some reason. This leaves the writer to an undefined state.

writeTo

public void writeTo(ContentHandler h,
                    ErrorHandler errorHandler)
             throws SAXException
Description copied from interface: Header
Writes out the header as SAX events.

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.

Parameters:
h - The ContentHandler that receives SAX events.
errorHandler - The ErrorHandler that receives parsing errors.
Throws:
SAXException