@Provider @Produces(value="application/*+json") @Consumes(value="application/*+json") public class JsonCollectionProvider extends CollectionProvider
providers
Constructor and Description |
---|
JsonCollectionProvider() |
Modifier and Type | Method and Description |
---|---|
Object |
readFrom(Class<Object> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,String> httpHeaders,
InputStream entityStream)
Read a type from the
InputStream . |
void |
writeTo(Object entry,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,Object> httpHeaders,
OutputStream entityStream)
Write a type to an HTTP message.
|
getCharset, getFinder, getJAXBObject, getSize, isDisableDTDs, isDisableExternalEntities, isEnableSecureProcessingFeature, isReadable, isWrapped, isWriteable, needsSecurity, setDisableDTDs, setDisableExternalEntities, setEnableSecureProcessingFeature
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>
readFrom
in class CollectionProvider
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 void writeTo(Object entry, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream) throws IOException, WebApplicationException
MessageBodyWriter
writeTo
in interface MessageBodyWriter<Object>
writeTo
in class CollectionProvider
entry
- 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.Copyright © 2016 JBoss by Red Hat. All rights reserved.