Package org.apache.cxf.jaxrs.provider

Class JAXBElementProvider<T>

java.lang.Object

org.apache.cxf.jaxrs.provider.AbstractConfigurableProvider

org.apache.cxf.jaxrs.provider.AbstractJAXBProvider<T>

org.apache.cxf.jaxrs.provider.JAXBElementProvider<T>

All Implemented Interfaces:

jakarta.ws.rs.ext.MessageBodyReader<T>, jakarta.ws.rs.ext.MessageBodyWriter<T>

Direct Known Subclasses:

JAXBElementTypedProvider, XSLTJaxbProvider

@Produces({"application/xml","application/*+xml","text/xml"})
@Consumes({"application/xml","application/*+xml","text/xml"})
@Provider
public class JAXBElementProvider<T>
extends AbstractJAXBProvider<T>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.cxf.jaxrs.provider.AbstractJAXBProvider

AbstractJAXBProvider.CollectionWrapper, AbstractJAXBProvider.JAXBCollectionWrapperReader

Field Summary

Fields inherited from class org.apache.cxf.jaxrs.provider.AbstractJAXBProvider

classContexts, collectionContextClasses, inAppendMap, inDropElements, inElementsMap, jaxbElementClassMap, marshalAsJaxbElement, NS_MAPPER_PROPERTY_RI, NS_MAPPER_PROPERTY_RI_INT, objectFactoryOrIndexMap, outAppendMap, outDropElements, outElementsMap, packageContexts, unmarshalAsJaxbElement, xmlTypeAsJaxbElementOnly

Fields inherited from class org.apache.cxf.jaxrs.provider.AbstractConfigurableProvider

BUNDLE, LOG

Constructor Summary

Constructors

Constructor	Description
JAXBElementProvider()

Method Summary

Modifier and Type	Method	Description
protected void	addAttachmentMarshaller(jakarta.xml.bind.Marshaller ms)
protected void	addAttachmentUnmarshaller(jakarta.xml.bind.Unmarshaller um)
protected boolean	canBeReadAsJaxbElement(Class<?> type)
protected Object	doUnmarshal(jakarta.xml.bind.Unmarshaller unmarshaller, Class<?> type, InputStream is, Annotation[] anns, jakarta.ws.rs.core.MediaType mt)
protected XMLStreamReader	getStreamReader(InputStream is, Class<?> type, jakarta.ws.rs.core.MediaType mt)
protected XMLStreamWriter	getStreamWriter(Object obj, OutputStream os, jakarta.ws.rs.core.MediaType mt)
protected void	marshal(Object obj, Class<?> cls, Type genericType, String enc, OutputStream os, jakarta.ws.rs.core.MediaType mt)
protected void	marshal(Object obj, Class<?> cls, Type genericType, String enc, OutputStream os, jakarta.ws.rs.core.MediaType mt, Annotation[] anns)
protected final void	marshal(Object obj, Class<?> cls, Type genericType, String enc, OutputStream os, Annotation[] anns, jakarta.ws.rs.core.MediaType mt, jakarta.xml.bind.Marshaller ms)
protected void	marshalCollection(Class<?> originalCls, Object collection, Type genericType, String enc, OutputStream os, jakarta.ws.rs.core.MediaType m, Annotation[] anns)
protected void	marshalCollectionMember(Object obj, Class<?> cls, Type genericType, String enc, OutputStream os, Annotation[] anns, jakarta.ws.rs.core.MediaType mt, String ns)
protected void	marshalToOutputStream(jakarta.xml.bind.Marshaller ms, Object obj, OutputStream os, Annotation[] anns, jakarta.ws.rs.core.MediaType mt)
protected void	marshalToWriter(jakarta.xml.bind.Marshaller ms, Object obj, XMLStreamWriter writer, Annotation[] anns, jakarta.ws.rs.core.MediaType mt)
protected boolean	objectFactoryOrIndexAvailable(Class<?> type)
T	readFrom(Class<T> type, Type genericType, Annotation[] anns, jakarta.ws.rs.core.MediaType mt, jakarta.ws.rs.core.MultivaluedMap<String,String> headers, InputStream is)
protected String	resolveXMLResourceURI(String path)
void	setMarshallerProperties(Map<String,Object> marshallProperties)
void	setMessageContext(MessageContext mc)
void	setNamespacePrefixes(Map<String,String> prefixes)
void	setSchemaLocation(String schemaLocation)
protected void	setXmlPiProperty(jakarta.xml.bind.Marshaller ms, String value)
void	setXmlPiPropertyName(String xmlPiPropertyName)
void	setXmlResourceOffset(String value)
protected Object	unmarshalFromInputStream(jakarta.xml.bind.Unmarshaller unmarshaller, InputStream is, Annotation[] anns, jakarta.ws.rs.core.MediaType mt)
protected Object	unmarshalFromReader(jakarta.xml.bind.Unmarshaller unmarshaller, XMLStreamReader reader, Annotation[] anns, jakarta.ws.rs.core.MediaType mt)
void	writeTo(T obj, Class<?> cls, Type genericType, Annotation[] anns, jakarta.ws.rs.core.MediaType m, jakarta.ws.rs.core.MultivaluedMap<String,Object> headers, OutputStream os)

Methods inherited from class org.apache.cxf.jaxrs.provider.AbstractJAXBProvider

checkAdapter, clearContexts, configureReaderRestrictions, convertToJaxbElementIfNeeded, createDepthReaderIfNeeded, createMarshaller, createTransformReaderIfNeeded, createTransformWriterIfNeeded, createUnmarshaller, createUnmarshaller, getActualType, getClassContext, getClassContext, getCollectionContext, getCollectionWrapperQName, getContext, getDepthProperties, getJAXBContext, getJaxbElementClass, getJaxbQName, getPackageContext, getPackageContext, getSchema, getSchema, getSize, getStreamHandlerFromCurrentMessage, handleExceptionEnd, handleExceptionStart, handleJAXBException, handleXMLStreamException, init, isReadable, isSkipJaxbChecks, isSupported, isWriteable, isXmlRoot, isXmlType, setAttributesToElements, setCatalogLocation, setCollectionWrapperMap, setCollectionWrapperName, setContext, setContextProperties, setDepthProperties, setExtraClass, setInAppendElements, setInDropElements, setInTransformElements, setJaxbElementClassMap, setJaxbElementClassNames, setMarshallAsJaxbElement, setMarshallerListener, setMarshallerProp, setNamespaceMapper, setNamespaceMapperPropertyName, setOutAppendElements, setOutDropElements, setOutTransformElements, setSchema, setSchemaHandler, setSchemaHandlers, setSchemaLocations, setSingleJaxbContext, setSkipJaxbChecks, setUnmarshallAsJaxbElement, setUnmarshallerListener, setUnmarshallerProperties, setUseSingleContextForPackages, setValidateBeforeWrite, setValidateInput, setValidateOutput, setValidationHandler, setXmlRootAsJaxbElement, setXmlTypeAsJaxbElementOnly, validateObjectIfNeeded, writeTo

Methods inherited from class org.apache.cxf.jaxrs.provider.AbstractConfigurableProvider

getBus, getConsumeMediaTypes, getEnableBuffering, getEnableStreaming, getProduceMediaTypes, isPayloadEmpty, isPayloadEmpty, reportEmptyContentLength, setBus, setConsumeMediaTypes, setEnableBuffering, setEnableStreaming, setProduceMediaTypes

Methods inherited from class java.lang.Object

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

Constructor Details

JAXBElementProvider

public JAXBElementProvider()

Method Details

objectFactoryOrIndexAvailable

protected boolean objectFactoryOrIndexAvailable(Class<?> type)

Overrides:

objectFactoryOrIndexAvailable in class AbstractJAXBProvider<T>

setXmlResourceOffset

public void setXmlResourceOffset(String value)

setNamespacePrefixes

public void setNamespacePrefixes(Map<String,String> prefixes)

setXmlPiProperty

protected void setXmlPiProperty(jakarta.xml.bind.Marshaller ms,
 String value)
                         throws Exception

Throws:

Exception

canBeReadAsJaxbElement

protected boolean canBeReadAsJaxbElement(Class<?> type)

Overrides:

canBeReadAsJaxbElement in class AbstractJAXBProvider<T>

setMessageContext

@Context
public void setMessageContext(MessageContext mc)

setMarshallerProperties

public void setMarshallerProperties(Map<String,Object> marshallProperties)

setSchemaLocation

public void setSchemaLocation(String schemaLocation)

readFrom

public T readFrom(Class<T> type,
 Type genericType,
 Annotation[] anns,
 jakarta.ws.rs.core.MediaType mt,
 jakarta.ws.rs.core.MultivaluedMap<String,String> headers,
 InputStream is)
           throws IOException

Throws:

IOException

doUnmarshal

protected Object doUnmarshal(jakarta.xml.bind.Unmarshaller unmarshaller,
 Class<?> type,
 InputStream is,
 Annotation[] anns,
 jakarta.ws.rs.core.MediaType mt)
                      throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException

getStreamReader

protected XMLStreamReader getStreamReader(InputStream is,
 Class<?> type,
 jakarta.ws.rs.core.MediaType mt)

unmarshalFromInputStream

protected Object unmarshalFromInputStream(jakarta.xml.bind.Unmarshaller unmarshaller,
 InputStream is,
 Annotation[] anns,
 jakarta.ws.rs.core.MediaType mt)
                                   throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException

unmarshalFromReader

protected Object unmarshalFromReader(jakarta.xml.bind.Unmarshaller unmarshaller,
 XMLStreamReader reader,
 Annotation[] anns,
 jakarta.ws.rs.core.MediaType mt)
                              throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException

writeTo

public void writeTo(T obj,
 Class<?> cls,
 Type genericType,
 Annotation[] anns,
 jakarta.ws.rs.core.MediaType m,
 jakarta.ws.rs.core.MultivaluedMap<String,Object> headers,
 OutputStream os)
             throws IOException

Throws:

IOException

marshalCollection

protected void marshalCollection(Class<?> originalCls,
 Object collection,
 Type genericType,
 String enc,
 OutputStream os,
 jakarta.ws.rs.core.MediaType m,
 Annotation[] anns)
                          throws Exception

Throws:

Exception

marshalCollectionMember

protected void marshalCollectionMember(Object obj,
 Class<?> cls,
 Type genericType,
 String enc,
 OutputStream os,
 Annotation[] anns,
 jakarta.ws.rs.core.MediaType mt,
 String ns)
                                throws Exception

Throws:

Exception

marshal

protected void marshal(Object obj,
 Class<?> cls,
 Type genericType,
 String enc,
 OutputStream os,
 jakarta.ws.rs.core.MediaType mt)
                throws Exception

Throws:

Exception

marshal

protected void marshal(Object obj,
 Class<?> cls,
 Type genericType,
 String enc,
 OutputStream os,
 jakarta.ws.rs.core.MediaType mt,
 Annotation[] anns)
                throws Exception

Throws:

Exception

resolveXMLResourceURI

protected String resolveXMLResourceURI(String path)

addAttachmentMarshaller

protected void addAttachmentMarshaller(jakarta.xml.bind.Marshaller ms)

addAttachmentUnmarshaller

protected void addAttachmentUnmarshaller(jakarta.xml.bind.Unmarshaller um)

marshal

protected final void marshal(Object obj,
 Class<?> cls,
 Type genericType,
 String enc,
 OutputStream os,
 Annotation[] anns,
 jakarta.ws.rs.core.MediaType mt,
 jakarta.xml.bind.Marshaller ms)
                      throws Exception

Throws:

Exception

getStreamWriter

protected XMLStreamWriter getStreamWriter(Object obj,
 OutputStream os,
 jakarta.ws.rs.core.MediaType mt)

marshalToOutputStream

protected void marshalToOutputStream(jakarta.xml.bind.Marshaller ms,
 Object obj,
 OutputStream os,
 Annotation[] anns,
 jakarta.ws.rs.core.MediaType mt)
                              throws Exception

Throws:

Exception

marshalToWriter

protected void marshalToWriter(jakarta.xml.bind.Marshaller ms,
 Object obj,
 XMLStreamWriter writer,
 Annotation[] anns,
 jakarta.ws.rs.core.MediaType mt)
                        throws Exception

Throws:

Exception

setXmlPiPropertyName

public void setXmlPiPropertyName(String xmlPiPropertyName)