org.jboss.resteasy.plugins.providers.jaxb
Class JAXBXmlTypeProvider
java.lang.Object
org.jboss.resteasy.plugins.providers.AbstractEntityProvider<T>
org.jboss.resteasy.plugins.providers.jaxb.AbstractJAXBProvider<Object>
org.jboss.resteasy.plugins.providers.jaxb.JAXBXmlTypeProvider
- All Implemented Interfaces:
- javax.ws.rs.ext.MessageBodyReader<Object>, javax.ws.rs.ext.MessageBodyWriter<Object>
@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);
- Version:
- $Revision:$
- Author:
- Ryan J. McDonough
Method Summary |
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)
|
Methods inherited from class org.jboss.resteasy.plugins.providers.jaxb.AbstractJAXBProvider |
decorateMarshaller, decorateUnmarshaller, findJAXBContext, getCharset, getMarshaller, isExpandEntityReferences, isReadable, isWriteable, processWithoutEntityExpansion, setCharset, setExpandEntityReferences, suppressExpandEntityExpansion |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
OBJECT_FACTORY_NAME
protected static final String OBJECT_FACTORY_NAME
- See Also:
- Constant Field Values
JAXBXmlTypeProvider
public JAXBXmlTypeProvider()
writeTo
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
- Specified by:
writeTo
in interface javax.ws.rs.ext.MessageBodyWriter<Object>
- Overrides:
writeTo
in class AbstractJAXBProvider<Object>
- Throws:
IOException
readFrom
public 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
- Specified by:
readFrom
in interface javax.ws.rs.ext.MessageBodyReader<Object>
- Overrides:
readFrom
in class AbstractJAXBProvider<Object>
- Throws:
IOException
isReadWritable
protected boolean isReadWritable(Class<?> type,
Type genericType,
Annotation[] annotations,
javax.ws.rs.core.MediaType mediaType)
- Description copied from class:
AbstractJAXBProvider
- FIXME Comment this
- Specified by:
isReadWritable
in class AbstractJAXBProvider<Object>
- Returns:
findObjectFactory
public static Object findObjectFactory(Class<?> type)
- Attempts to locate
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.
- Parameters:
t
- type
-
- Returns:
wrapInJAXBElement
public 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.
- Parameters:
t
- type
-
- Returns:
Copyright © 2013 JBoss by Red Hat. All Rights Reserved.