org.glassfish.jersey.jaxb.internal

Class XmlJaxbElementProvider

java.lang.Object

org.glassfish.jersey.message.internal.AbstractMessageReaderWriterProvider<T>

org.glassfish.jersey.jaxb.internal.AbstractJaxbProvider<jakarta.xml.bind.JAXBElement<?>>

org.glassfish.jersey.jaxb.internal.AbstractJaxbElementProvider

org.glassfish.jersey.jaxb.internal.XmlJaxbElementProvider

All Implemented Interfaces:

jakarta.ws.rs.ext.MessageBodyReader<jakarta.xml.bind.JAXBElement<?>>, jakarta.ws.rs.ext.MessageBodyWriter<jakarta.xml.bind.JAXBElement<?>>

Direct Known Subclasses:

XmlJaxbElementProvider.App, XmlJaxbElementProvider.General, XmlJaxbElementProvider.Text

public abstract class XmlJaxbElementProvider
extends AbstractJaxbElementProvider

Base XML-based message body provider for JAXB element instances.

Author:

Paul Sandoz, Marek Potociar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlJaxbElementProvider.App Provider for marshalling/un-marshalling JAXB elements from/to entities of application/xml media type.
static class	XmlJaxbElementProvider.General Provider for marshalling/un-marshalling JAXB elements from/to entities of <type>/<sub-type>+xml media types.
static class	XmlJaxbElementProvider.Text Provider for marshalling/un-marshalling JAXB elements from/to entities of text/xml media type.

Field Summary

Fields inherited from class org.glassfish.jersey.message.internal.AbstractMessageReaderWriterProvider

UTF8

Constructor Summary

Constructors

Constructor and Description
XmlJaxbElementProvider(jakarta.inject.Provider<SAXParserFactory> spf, jakarta.ws.rs.ext.Providers ps, jakarta.ws.rs.core.Configuration config)
XmlJaxbElementProvider(jakarta.inject.Provider<SAXParserFactory> spf, jakarta.ws.rs.ext.Providers ps, jakarta.ws.rs.core.MediaType mt, jakarta.ws.rs.core.Configuration config)

Method Summary

Modifier and Type	Method and Description
protected jakarta.xml.bind.JAXBElement<?>	readFrom(Class<?> type, jakarta.ws.rs.core.MediaType mediaType, jakarta.xml.bind.Unmarshaller unmarshaller, InputStream entityStream) Read JAXB element from an entity stream.
protected void	writeTo(jakarta.xml.bind.JAXBElement<?> t, jakarta.ws.rs.core.MediaType mediaType, Charset c, jakarta.xml.bind.Marshaller m, OutputStream entityStream) Write JAXB element to an entity stream.

Methods inherited from class org.glassfish.jersey.jaxb.internal.AbstractJaxbElementProvider

isReadable, isWriteable, readFrom, writeTo

Methods inherited from class org.glassfish.jersey.jaxb.internal.AbstractJaxbProvider

getMarshaller, getSAXSource, getStoredJaxbContext, getUnmarshaller, isFormattedOutput, isSupported, isXmlRootElementProcessing, setConfiguration, setHeader

Methods inherited from class org.glassfish.jersey.message.internal.AbstractMessageReaderWriterProvider

getCharset, getSize, readFromAsString, writeTo, writeTo, writeToAsString

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlJaxbElementProvider

public XmlJaxbElementProvider(jakarta.inject.Provider<SAXParserFactory> spf,
                              jakarta.ws.rs.ext.Providers ps,
                              jakarta.ws.rs.core.Configuration config)

XmlJaxbElementProvider

public XmlJaxbElementProvider(jakarta.inject.Provider<SAXParserFactory> spf,
                              jakarta.ws.rs.ext.Providers ps,
                              jakarta.ws.rs.core.MediaType mt,
                              jakarta.ws.rs.core.Configuration config)

Method Detail

readFrom

protected final jakarta.xml.bind.JAXBElement<?> readFrom(Class<?> type,
                                                         jakarta.ws.rs.core.MediaType mediaType,
                                                         jakarta.xml.bind.Unmarshaller unmarshaller,
                                                         InputStream entityStream)
                                                  throws jakarta.xml.bind.JAXBException

Description copied from class: AbstractJaxbElementProvider

Read JAXB element from an entity stream.

Specified by:

readFrom in class AbstractJaxbElementProvider

Parameters:

type - the type that is to be read from the entity stream.

mediaType - the media type of the HTTP entity.

unmarshaller - JAXB unmarshaller to be used.

entityStream - the InputStream of the HTTP entity. The caller is responsible for ensuring that the input stream ends when the entity has been consumed. The implementation should not close the input stream.

Returns:

JAXB element representing the entity.

Throws:

jakarta.xml.bind.JAXBException - in case entity unmarshalling fails.

writeTo

protected final void writeTo(jakarta.xml.bind.JAXBElement<?> t,
                             jakarta.ws.rs.core.MediaType mediaType,
                             Charset c,
                             jakarta.xml.bind.Marshaller m,
                             OutputStream entityStream)
                      throws jakarta.xml.bind.JAXBException

Description copied from class: AbstractJaxbElementProvider

Write JAXB element to an entity stream.

Specified by:

writeTo in class AbstractJaxbElementProvider

Parameters:

t - JAXB element to be written to an entity stream.

mediaType - the media type of the HTTP entity.

c - character set to be used.

m - JAXB unmarshaller to be used.

entityStream - the InputStream of the HTTP entity. The caller is responsible for ensuring that the input stream ends when the entity has been consumed. The implementation should not close the input stream.

Throws:

jakarta.xml.bind.JAXBException - in case entity marshalling fails.