@Provider 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 response.
|
decorateMarshaller, decorateUnmarshaller, findJAXBContext, getCharset, getMarshaller, isDisableDTDs, isDisableExternalEntities, isEnableSecureProcessingFeature, isReadable, isWriteable, needsSecurity, processWithSecureProcessing, setCharset, setDisableDTDs, setDisableExternalEntities, setEnableSecureProcessingFeaturegetSizeprotected 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
MessageBodyWriterwriteTo in interface MessageBodyWriter<Object>writeTo in class AbstractJAXBProvider<Object>t - the instance to write.type - the class of object that is to be written.genericType - the type of object to be written, obtained either
by reflection of a resource method return type or by inspection
of the returned instance. GenericEntity
provides a way to specify this information at runtime.annotations - an array of the annotations on the resource
method that returns the object.mediaType - the media type of the HTTP entity.httpHeaders - a mutable map of the HTTP response headers.entityStream - the OutputStream for the HTTP entity. The
implementation should not close the output stream.IOException - if an IO error arisespublic Object readFrom(Class<Object> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,String> httpHeaders, InputStream entityStream) throws IOException
MessageBodyReaderInputStream.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 object 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.IOException - if an IO error arisesprotected boolean isReadWritable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
AbstractJAXBProviderisReadWritable 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 © 2018 JBoss by Red Hat. All rights reserved.