Module com.sun.xml.ws
Package com.sun.xml.ws.message

Class AbstractHeaderImpl

java.lang.Object
com.sun.xml.ws.message.AbstractHeaderImpl
All Implemented Interfaces:
Header
Direct Known Subclasses:
DOMHeader, FaultDetailHeader, JAXBHeader, OutboundStreamHeader, ProblemActionHeader, StreamHeader, StringHeader
public abstract class AbstractHeaderImpl extends Object implements Header
Partial default implementation of Header.

This is meant to be a convenient base class for Header-derived classes.

Author:
Kohsuke Kawaguchi

  • Field Details

  • Constructor Details

    • AbstractHeaderImpl

      protected AbstractHeaderImpl()

  • Method Details

    • readAsJAXB

      public <T> T readAsJAXB(jakarta.xml.bind.Unmarshaller unmarshaller) throws jakarta.xml.bind.JAXBException
      Description copied from interface: Header
      Reads the header as a JAXB object by using the given unmarshaller.
      Specified by:
      readAsJAXB in interface Header
      Throws:
      jakarta.xml.bind.JAXBException

    • readAsJAXB

      public <T> T readAsJAXB(XMLBridge<T> bridge) throws jakarta.xml.bind.JAXBException
      Description copied from interface: Header
      Reads the header as a data-bond object
      Specified by:
      readAsJAXB in interface Header
      Throws:
      jakarta.xml.bind.JAXBException

    • readAsEPR

      public WSEndpointReference readAsEPR(AddressingVersion expected) throws XMLStreamException
      Default implementation that copies the infoset. Not terribly efficient.
      Specified by:
      readAsEPR in interface Header
      Parameters:
      expected - The version of the addressing used to parse the EPR. If the actual infoset and this doesn't agree, then you'll get an WebServiceException stating that fact.
      Returns:
      On a successful return, this method never returns null.
      Throws:
      XMLStreamException

    • isIgnorable

      public boolean isIgnorable(@NotNull SOAPVersion soapVersion, @NotNull Set<String> roles)
      Description copied from interface: Header
      Checks if this header is ignorable for us (IOW, make sure that this header has a problematic "mustUnderstand" header value that we have to reject.)

      This method is used as a part of the mustUnderstanx processing. At the end of the processing, the JAX-WS identifies a list of Headers that were not understood. This method is invoked on those Headers, to verify that we don't need to report an error for it.

      specifically, this method has to perform the following tasks:

      • If this header does not have mustUnderstand as "1" nor "true", then this method must return true.
      • Otherwise, check the role attribute (for SOAP 1.2) or the actor attribute (for SOAP 1.1). When those attributes are absent, the default values have to be assumed. See Header.getRole(SOAPVersion) for how the values are defaulted. Now, see if the roles set contains the value. If so, this method must return false (indicating that an error is in order.)
      • Otherwise return true (since we don't play the role this header is intended for.)
      Specified by:
      isIgnorable in interface Header
      Parameters:
      soapVersion - The caller specifies the SOAP version that the pipeline is working against. Often each Header implementation already knows the SOAP version anyway, but this allows some Headers to avoid keeping it. That's why this redundant parameter is passed in.
      roles - The set of role values that the current JAX-WS pipeline is assuming. Note that SOAP 1.1 and SOAP 1.2 use different strings for the same role, and the caller is responsible for supplying a proper value depending on the active SOAP version in use.
      Returns:
      true if no error needs to be reported. False if an error needs to be raised. See the method javadoc for more discussion.

    • getRole

      @NotNull public String getRole(@NotNull SOAPVersion soapVersion)
      Description copied from interface: Header
      Gets the value of the soap:role attribute (or soap:actor for SOAP 1.1).

      If the attribute is omitted, the value defaults to SOAPVersion.implicitRole.

      Specified by:
      getRole in interface Header
      Parameters:
      soapVersion - The caller specifies the SOAP version that the pipeline is working against. Often each Header implementation already knows the SOAP version anyway, but this allows some Headers to avoid keeping it. That's why this redundant parameter is passed in.
      Returns:
      never null. This string need not be interned.

    • isRelay

      public boolean isRelay()
      Description copied from interface: Header
      True if this header is to be relayed if not processed. For SOAP 1.1 messages, this method always return false.

      IOW, this method returns true if there's @soap:relay='true' is present.

      Implementation Note

      The implementation needs to check for both "true" and "1", but because attribute values are normalized, it doesn't have to consider " true", " 1 ", and so on.

      Specified by:
      isRelay in interface Header
      Returns:
      false.

    • getAttribute

      public String getAttribute(QName name)
      Description copied from interface: Header
      Gets the attribute value on the header element.

      This is a convenience method that calls into Header.getAttribute(String, String)

      Specified by:
      getAttribute in interface Header
      Parameters:
      name - Never null.
      See Also:

    • parseBool

      protected final boolean parseBool(String value)
      Parses a string that looks like xs:boolean into boolean. This method assumes that the whilespace normalization has already taken place.

    • getStringContent

      public String getStringContent()
      Description copied from interface: Header
      Used to obtain value XYZ from a header that looks like "<header>XYZ</header>". The primary use of this header for now is to access certain Addressing headers quickly.
      Specified by:
      getStringContent in interface Header
      Returns:
      Can be empty but always non-null.