@Provider @Produces(value={"application/*+xml","text/*+xml"}) @Consumes(value={"application/*+xml","text/*+xml"}) public class JAXBXmlTypeProvider extends AbstractJAXBProvider<Object>
A JAXB entity provider that handles classes without XmlRootElement
annotation. Classes which have
been generated by XJC will most likely not contain this annotation, In order for these classes to
marshalled, they must be wrapped within a JAXBElement
instance. This is typically accomplished by
invoking a method on the class which serves as the XmlRegistry
and is named ObjectFactory.
This provider is selected when the class is annotated with an XmlType
annotation and
not an XmlRootElement
annotation.
This provider simplifies this task by attempting to locate the XmlRegistry
for the target class. By
default, a JAXB implementation will create a class called ObjectFactory and is located in the same package
as the target class. When this class is located, it will contain a "create" method that takes the object
instance as a parameter. For example, of the target type is called "Contact", then the ObjectFactory class
will have a method:
public JAXBElement createContact(Contact value);
Modifier and Type | Field and Description |
---|---|
protected static String |
OBJECT_FACTORY_NAME |
providers
Constructor and Description |
---|
JAXBXmlTypeProvider() |
Modifier and Type | Method and Description |
---|---|
static Object |
findObjectFactory(Class<?> type)
Attempts to locate
XmlRegistry for the XML type. |
protected boolean |
isReadWritable(Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType)
FIXME Comment this
|
Object |
readFrom(Class<Object> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,String> httpHeaders,
InputStream entityStream)
Read a type from the
InputStream . |
static JAXBElement<?> |
wrapInJAXBElement(Object t,
Class<?> type)
If this object is managed by an XmlRegistry, this method will invoke the registry and wrap the object in
a JAXBElement so that it can be marshalled.
|
void |
writeTo(Object t,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,Object> httpHeaders,
OutputStream entityStream)
Write a type to an HTTP message.
|
decorateMarshaller, decorateUnmarshaller, findJAXBContext, getCharset, getMarshaller, isDisableDTDs, isDisableExternalEntities, isEnableSecureProcessingFeature, isReadable, isWriteable, needsSecurity, processWithSecureProcessing, setCharset, setDisableDTDs, setDisableExternalEntities, setEnableSecureProcessingFeature
getSize
protected static final String OBJECT_FACTORY_NAME
public void writeTo(Object t, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream) throws IOException
MessageBodyWriter
writeTo
in interface MessageBodyWriter<Object>
writeTo
in class AbstractJAXBProvider<Object>
t
- the instance to write.type
- the class of instance that is to be written.genericType
- the type of instance to be written. GenericEntity
provides a way to specify this information at runtime.annotations
- an array of the annotations attached to the message entity instance.mediaType
- the media type of the HTTP entity.httpHeaders
- a mutable map of the HTTP message headers.entityStream
- the OutputStream
for the HTTP entity. The
implementation should not close the output stream.IOException
- if an IO error arises.public Object readFrom(Class<Object> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,String> httpHeaders, InputStream entityStream) throws IOException
MessageBodyReader
InputStream
.
In case the entity input stream is empty, the reader is expected to either return a
Java representation of a zero-length entity or throw a NoContentException
in case no zero-length entity representation is defined for the supported Java type.
A NoContentException
, if thrown by a message body reader while reading a server
request entity, is automatically translated by JAX-RS server runtime into a BadRequestException
wrapping the original NoContentException
and rethrown for a standard processing by
the registered exception mappers
.
readFrom
in interface MessageBodyReader<Object>
readFrom
in class AbstractJAXBProvider<Object>
type
- the type that is to be read from the entity stream.genericType
- the type of instance to be produced. E.g. if the
message body is to be converted into a method parameter, this will be
the formal type of the method parameter as returned by
Method.getGenericParameterTypes
.annotations
- an array of the annotations on the declaration of the
artifact that will be initialized with the produced instance. E.g.
if the message body is to be converted into a method parameter, this
will be the annotations on that parameter returned by
Method.getParameterAnnotations
.mediaType
- the media type of the HTTP entity.httpHeaders
- the read-only HTTP headers associated with HTTP entity.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.NoContentException
in case no zero-length entity representation is
defined for the supported Java type.IOException
- if an IO error arises. In case the entity input stream is empty
and the reader is not able to produce a Java representation for
a zero-length entity, NoContentException
is expected to
be thrown.protected boolean isReadWritable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
AbstractJAXBProvider
isReadWritable
in class AbstractJAXBProvider<Object>
public static Object findObjectFactory(Class<?> type)
XmlRegistry
for the XML type. Usually, a class named ObjectFactory is located
in the same package as the type we're trying to marshall. This method simply locates this class and
instantiates it if found.t
- type
- public static JAXBElement<?> wrapInJAXBElement(Object t, Class<?> type)
t
- type
- Copyright © 2016 JBoss by Red Hat. All rights reserved.