@Provider @Produces(value={"application/*+xml","text/*+xml"}) @Consumes(value={"application/*+xml","text/*+xml"}) public class MapProvider extends Object implements MessageBodyReader<Object>, MessageBodyWriter<Object>
Constructor and Description |
---|
MapProvider() |
Modifier and Type | Method and Description |
---|---|
static String |
getCharset(MediaType mediaType) |
protected JAXBContextFinder |
getFinder(MediaType type) |
Object |
getJAXBObject(JAXBContextFinder finder,
MediaType mediaType,
Class<?> clazz,
Element element) |
long |
getSize(Object entry,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType)
Originally, the method has been called before
writeTo to ascertain the length in bytes of
the serialized form of t . |
boolean |
isDisableDTDs() |
boolean |
isDisableExternalEntities() |
boolean |
isEnableSecureProcessingFeature() |
boolean |
isReadable(Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType)
Ascertain if the MessageBodyReader can produce an instance of a
particular type.
|
protected boolean |
isWrapped(Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType) |
boolean |
isWriteable(Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType)
Ascertain if the MessageBodyWriter supports a particular type.
|
protected boolean |
needsSecurity() |
Object |
readFrom(Class<Object> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,String> httpHeaders,
InputStream entityStream)
Read a type from the
InputStream . |
void |
setDisableDTDs(boolean disableDTDs) |
void |
setDisableExternalEntities(boolean disableExternalEntities) |
void |
setEnableSecureProcessingFeature(boolean enableSecureProcessingFeature) |
void |
writeTo(Object target,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,Object> httpHeaders,
OutputStream entityStream)
Write a type to an HTTP message.
|
protected JAXBContextFinder getFinder(MediaType type)
public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
MessageBodyReader
type
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
.isReadable
in interface MessageBodyReader<Object>
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
.protected boolean isWrapped(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
public Object getJAXBObject(JAXBContextFinder finder, MediaType mediaType, Class<?> clazz, Element element) throws JAXBException
JAXBException
public Object readFrom(Class<Object> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,String> httpHeaders, InputStream entityStream) throws IOException, WebApplicationException
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>
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.WebApplicationException
- if a specific HTTP error response needs to be produced.
Only effective if thrown prior to the response being committed.public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
MessageBodyWriter
isWriteable
in interface MessageBodyWriter<Object>
type
- the class of instance that is to be written.genericType
- 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.annotations
- 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 long getSize(Object entry, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
MessageBodyWriter
writeTo
to ascertain the length in bytes of
the serialized form of t
. A non-negative return value has been used in a HTTP
Content-Length
header.
As of JAX-RS 2.0, the method has been deprecated and the value returned by the method is ignored
by a JAX-RS runtime. All MessageBodyWriter
implementations are advised to return -1
from the method. Responsibility to compute the actual Content-Length
header value has been
delegated to JAX-RS runtime.
getSize
in interface MessageBodyWriter<Object>
entry
- the instance to writetype
- 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.public void writeTo(Object target, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream) throws IOException, WebApplicationException
MessageBodyWriter
writeTo
in interface MessageBodyWriter<Object>
target
- 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.WebApplicationException
- if a specific HTTP error response needs to be produced.
Only effective if thrown prior to the message being committed.public boolean isDisableExternalEntities()
public void setDisableExternalEntities(boolean disableExternalEntities)
public boolean isEnableSecureProcessingFeature()
public void setEnableSecureProcessingFeature(boolean enableSecureProcessingFeature)
public boolean isDisableDTDs()
public void setDisableDTDs(boolean disableDTDs)
protected boolean needsSecurity()
Copyright © 2014. All Rights Reserved.