Package com.sun.xml.ws.api.message

Class Headers

java.lang.Object

com.sun.xml.ws.api.message.Headers

public abstract class Headers
extends Object

Factory methods for various Header implementations.

This class provides various methods to create different flavors of Header classes that store data in different formats.

This is a part of the JAX-WS RI internal API so that Pipe implementations can reuse the implementations done inside the JAX-WS without having a strong dependency to the actual class.

If you find some of the useful convenience methods missing from this class, please talk to us.

Author:

Kohsuke Kawaguchi

Method Summary

Modifier and Type	Method	Description
static Header	create(SOAPVersion soapVersion, jakarta.xml.bind.Marshaller m, Object o)	Deprecated. Use create(BindingContext, Object) instead.
static Header	create(SOAPVersion soapVersion, jakarta.xml.bind.Marshaller m, QName tagName, Object o)	Creates a Header backed a by a JAXB bean, with the given tag name.
static Header	create(SOAPVersion soapVersion, XMLStreamReader reader)	Creates a new Header that reads from XMLStreamReader.
static Header	create(SOAPVersion soapVersion, Element node)	Deprecated. Use create(Element)
static Header	create(BindingContext context, Object o)
static Header	create(XMLBridge bridge, Object jaxbObject)
static Header	create(jakarta.xml.bind.JAXBContext context, Object o)	Creates a Header backed a by a JAXB bean.
static Header	create(jakarta.xml.soap.SOAPHeaderElement header)	Creates a new Header backed by a SAAJ object.
static Header	create(QName name, String value)	Creates a new Header that that has a single text value in it (IOW, of the form <foo>text</foo>.)
static Header	create(org.glassfish.jaxb.runtime.api.Bridge bridge, Object jaxbObject)	Deprecated.
static Header	create(Element node)	Creates a new Header backed by an Element.
static Header	createMustUnderstand(SOAPVersion soapVersion, QName name, String value)	Creates a new Header that that has a single text value in it (IOW, of the form <foo>text</foo>.)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Header create(SOAPVersion soapVersion,
                            jakarta.xml.bind.Marshaller m,
                            Object o)

Deprecated.

Use create(BindingContext, Object) instead.

create

public static Header create(jakarta.xml.bind.JAXBContext context,
                            Object o)

Creates a Header backed a by a JAXB bean.

create

public static Header create(BindingContext context,
                            Object o)

create

public static Header create(SOAPVersion soapVersion,
                            jakarta.xml.bind.Marshaller m,
                            QName tagName,
                            Object o)

Creates a Header backed a by a JAXB bean, with the given tag name. See create(SOAPVersion, Marshaller, Object) for the meaning of other parameters.

Parameters:

tagName - The name of the newly created header. Must not be null.

o - The JAXB bean that represents the contents of the header. Must not be null.

create

public static Header create(org.glassfish.jaxb.runtime.api.Bridge bridge,
                            Object jaxbObject)

Deprecated.

Creates a Header backed a by a JAXB bean.

create

public static Header create(XMLBridge bridge,
                            Object jaxbObject)

create

public static Header create(jakarta.xml.soap.SOAPHeaderElement header)

Creates a new Header backed by a SAAJ object.

create

public static Header create(Element node)

Creates a new Header backed by an Element.

create

public static Header create(SOAPVersion soapVersion,
                            Element node)

Deprecated.

Use create(Element)

create

public static Header create(SOAPVersion soapVersion,
                            XMLStreamReader reader)
                     throws XMLStreamException

Creates a new Header that reads from XMLStreamReader.

Note that the header implementation will read the entire data into memory anyway, so this might not be as efficient as you might hope.

Throws:

XMLStreamException

create

public static Header create(QName name,
                            String value)

Creates a new Header that that has a single text value in it (IOW, of the form <foo>text</foo>.)

Parameters:

name - QName of the header element

value - text value of the header

createMustUnderstand

public static Header createMustUnderstand(@NotNull
                                          SOAPVersion soapVersion,
                                          @NotNull
                                          QName name,
                                          @NotNull
                                          String value)

Creates a new Header that that has a single text value in it (IOW, of the form <foo>text</foo>.)

Parameters:

name - QName of the header element

value - text value of the header