@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,
javax.ws.rs.core.MediaType mediaType)
FIXME Comment this
|
Object |
readFrom(Class<Object> type,
Type genericType,
Annotation[] annotations,
javax.ws.rs.core.MediaType mediaType,
javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders,
InputStream entityStream) |
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,
javax.ws.rs.core.MediaType mediaType,
javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders,
OutputStream entityStream) |
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, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream) throws IOException
writeTo in interface javax.ws.rs.ext.MessageBodyWriter<Object>writeTo in class AbstractJAXBProvider<Object>IOExceptionpublic Object readFrom(Class<Object> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders, InputStream entityStream) throws IOException
readFrom in interface javax.ws.rs.ext.MessageBodyReader<Object>readFrom in class AbstractJAXBProvider<Object>IOExceptionprotected boolean isReadWritable(Class<?> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.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 © 2015 JBoss by Red Hat. All rights reserved.