public abstract class XmlRootObjectJaxbProvider extends AbstractJaxbProvider<Object>
| Modifier and Type | Class and Description |
|---|---|
static class |
XmlRootObjectJaxbProvider.App
Provider for un-marshalling entities of
application/xml media type
into JAXB beans using JAXB unmarshaller. |
static class |
XmlRootObjectJaxbProvider.General
Provider for un-marshalling entities of
<type>/<sub-type>+xml media types
into JAXB beans using JAXB unmarshaller. |
static class |
XmlRootObjectJaxbProvider.Text
Provider for un-marshalling entities of
text/xml media type
into JAXB beans using JAXB unmarshaller. |
UTF8| Modifier and Type | Method and Description |
|---|---|
protected JAXBContext |
getStoredJaxbContext(Class type) |
boolean |
isReadable(Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType)
Ascertain if the MessageBodyReader can produce an instance of a
particular type.
|
boolean |
isWriteable(Class<?> arg0,
Type arg1,
Annotation[] arg2,
MediaType mediaType)
Ascertain if the MessageBodyWriter supports a particular type.
|
Object |
readFrom(Class<Object> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,String> httpHeaders,
InputStream inputStream)
Read a type from the
InputStream. |
void |
writeTo(Object arg0,
Class<?> arg1,
Type arg2,
Annotation[] arg3,
MediaType arg4,
MultivaluedMap<String,Object> arg5,
OutputStream arg6)
Write a type to an HTTP message.
|
getMarshaller, getSAXSource, getUnmarshaller, isFormattedOutput, isSupported, isXmlRootElementProcessing, setConfiguration, setHeadergetCharset, getSize, readFromAsString, writeTo, writeTo, writeToAsStringprotected JAXBContext getStoredJaxbContext(Class type) throws JAXBException
getStoredJaxbContext in class AbstractJaxbProvider<Object>JAXBExceptionpublic boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
MessageBodyReadertype parameter gives the
class of the instance that should be produced, the genericType parameter
gives the java.lang.reflect.Type of the instance
that should be produced.
E.g. if the instance to be produced is List<String>, the type parameter
will be java.util.List and the genericType parameter will be
java.lang.reflect.ParameterizedType.type - the class of instance to be produced.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, if one is not
specified in the request then application/octet-stream is
used.true if the type is supported, otherwise false.public final Object readFrom(Class<Object> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,String> httpHeaders, InputStream inputStream) throws IOException
MessageBodyReaderInputStream.
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.
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.inputStream - 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.public boolean isWriteable(Class<?> arg0, Type arg1, Annotation[] arg2, MediaType mediaType)
MessageBodyWriterarg0 - the class of instance that is to be written.arg1 - the type of instance to be written, obtained either
by reflection of a resource method return type or via inspection
of the returned instance. GenericEntity
provides a way to specify this information at runtime.arg2 - an array of the annotations attached to the message entity instance.mediaType - the media type of the HTTP entity.true if the type is supported, otherwise false.public void writeTo(Object arg0, Class<?> arg1, Type arg2, Annotation[] arg3, MediaType arg4, MultivaluedMap<String,Object> arg5, OutputStream arg6) throws IOException, WebApplicationException
MessageBodyWriterarg0 - the instance to write.arg1 - the class of instance that is to be written.arg2 - the type of instance to be written. GenericEntity
provides a way to specify this information at runtime.arg3 - an array of the annotations attached to the message entity instance.arg4 - the media type of the HTTP entity.arg5 - a mutable map of the HTTP message headers.arg6 - the OutputStream for the HTTP entity. The
implementation should not close the output stream.IOException - if an IO error arises.WebApplicationException - if a specific HTTP error response needs to be produced.
Only effective if thrown prior to the message being committed.Copyright © 2007-2014, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.