public interface MessageBodyWorkers
MessageBodyReader
and
MessageBodyWriter
instances.Context
,
MessageBodyReader
,
MessageBodyWriter
Modifier and Type | Method and Description |
---|---|
<T> javax.ws.rs.ext.MessageBodyReader<T> |
getMessageBodyReader(Class<T> type,
Type genericType,
Annotation[] annotations,
javax.ws.rs.core.MediaType mediaType)
Get a message body reader that matches a set of criteria.
|
<T> javax.ws.rs.ext.MessageBodyReader<T> |
getMessageBodyReader(Class<T> type,
Type genericType,
Annotation[] annotations,
javax.ws.rs.core.MediaType mediaType,
PropertiesDelegate propertiesDelegate)
Get a message body reader that matches a set of criteria.
|
List<javax.ws.rs.core.MediaType> |
getMessageBodyReaderMediaTypes(Class<?> type,
Type genericType,
Annotation[] annotations)
Get the list of media types supported for a Java type.
|
List<javax.ws.rs.core.MediaType> |
getMessageBodyReaderMediaTypesByType(Class<?> type)
Get the list of media types supported for a Java type.
|
List<javax.ws.rs.ext.MessageBodyReader> |
getMessageBodyReadersForType(Class<?> type)
Get a list of
MessageBodyReader s that are suitable for the given type . |
<T> javax.ws.rs.ext.MessageBodyWriter<T> |
getMessageBodyWriter(Class<T> type,
Type genericType,
Annotation[] annotations,
javax.ws.rs.core.MediaType mediaType)
Get a message body writer that matches a set of criteria.
|
<T> javax.ws.rs.ext.MessageBodyWriter<T> |
getMessageBodyWriter(Class<T> type,
Type genericType,
Annotation[] annotations,
javax.ws.rs.core.MediaType mediaType,
PropertiesDelegate propertiesDelegate)
Get a message body writer that matches a set of criteria.
|
javax.ws.rs.core.MediaType |
getMessageBodyWriterMediaType(Class<?> type,
Type genericType,
Annotation[] annotations,
List<javax.ws.rs.core.MediaType> acceptableMediaTypes)
Get the most acceptable media type supported for a Java type given a set of
acceptable media types.
|
List<javax.ws.rs.core.MediaType> |
getMessageBodyWriterMediaTypes(Class<?> type,
Type genericType,
Annotation[] annotations)
Get the list of media types supported for a Java type.
|
List<javax.ws.rs.core.MediaType> |
getMessageBodyWriterMediaTypesByType(Class<?> type)
Get the list of media types supported for a Java type.
|
List<javax.ws.rs.ext.MessageBodyWriter> |
getMessageBodyWritersForType(Class<?> type)
Get a list of
MessageBodyWriter s that are suitable for the given type . |
List<ReaderModel> |
getReaderModelsForType(Class<?> type)
Get a list of
MessageBodyReader models that are suitable for the given type . |
Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyReader>> |
getReaders(javax.ws.rs.core.MediaType mediaType)
Get the map of media type to list of message body writers that are compatible with
a media type.
|
Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyWriter>> |
getWriters(javax.ws.rs.core.MediaType mediaType)
Get the map of media type to list of message body writers that are compatible with
a media type.
|
List<WriterModel> |
getWritersModelsForType(Class<?> type)
Get a list of
MessageBodyWriter models that are suitable for the given type . |
String |
readersToString(Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyReader>> readers)
Convert a map media type to list of message body readers to a string.
|
Object |
readFrom(Class<?> rawType,
Type type,
Annotation[] annotations,
javax.ws.rs.core.MediaType mediaType,
javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders,
PropertiesDelegate propertiesDelegate,
InputStream entityStream,
Iterable<javax.ws.rs.ext.ReaderInterceptor> readerInterceptors,
boolean translateNce)
Reads a type from the
entityStream using interceptors. |
String |
writersToString(Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyWriter>> writers)
Convert a map media type to list of message body writers to a string.
|
OutputStream |
writeTo(Object entity,
Class<?> rawType,
Type type,
Annotation[] annotations,
javax.ws.rs.core.MediaType mediaType,
javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders,
PropertiesDelegate propertiesDelegate,
OutputStream entityStream,
Iterable<javax.ws.rs.ext.WriterInterceptor> writerInterceptors)
Writers a type to the
entityStream using interceptors. |
Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyReader>> getReaders(javax.ws.rs.core.MediaType mediaType)
mediaType
- the compatible media type.Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyWriter>> getWriters(javax.ws.rs.core.MediaType mediaType)
mediaType
- the compatible media type.String readersToString(Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyReader>> readers)
readers
- the map media type to list of message body readersString writersToString(Map<javax.ws.rs.core.MediaType,List<javax.ws.rs.ext.MessageBodyWriter>> writers)
writers
- the map media type to list of message body readers<T> javax.ws.rs.ext.MessageBodyReader<T> getMessageBodyReader(Class<T> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)
T
- the type of object to be read.type
- the class of object to be read.genericType
- the type of object 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
Class.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
Class.getParameterAnnotations
.mediaType
- the media type of the data that will be read, this will be
compared to the values of Consumes
for each
candidate reader and only matching readers will be queried.<T> javax.ws.rs.ext.MessageBodyReader<T> getMessageBodyReader(Class<T> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, PropertiesDelegate propertiesDelegate)
T
- the type of object to be read.type
- the class of object to be read.genericType
- the type of object 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
Class.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
Class.getParameterAnnotations
.mediaType
- the media type of the data that will be read, this will be
compared to the values of Consumes
for each
candidate reader and only matching readers will be queried.propertiesDelegate
- request-scoped properties delegate.<T> javax.ws.rs.ext.MessageBodyWriter<T> getMessageBodyWriter(Class<T> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)
T
- the type of the object that is to be written.type
- the class of object that is to be written.genericType
- the type of object to be written. E.g. if the message body is to
be produced from a field, this will be the declared type of the field as
returned by Field.getGenericType
.annotations
- an array of the annotations on the declaration of the artifact
that will be written. E.g. if the message body is to be produced from a
field, this will be the annotations on that field returned by
Field.getDeclaredAnnotations
.mediaType
- the media type of the data that will be written, this will be
compared to the values of Produces
for each
candidate writer and only matching writers will be queried.<T> javax.ws.rs.ext.MessageBodyWriter<T> getMessageBodyWriter(Class<T> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, PropertiesDelegate propertiesDelegate)
T
- the type of the object that is to be written.type
- the class of object that is to be written.genericType
- the type of object to be written. E.g. if the message body is to
be produced from a field, this will be the declared type of the field as
returned by Field.getGenericType
.annotations
- an array of the annotations on the declaration of the artifact
that will be written. E.g. if the message body is to be produced from a
field, this will be the annotations on that field returned by
Field.getDeclaredAnnotations
.mediaType
- the media type of the data that will be written, this will be
compared to the values of Produces
for each
candidate writer and only matching writers will be queried.propertiesDelegate
- request-scoped properties delegate.List<javax.ws.rs.core.MediaType> getMessageBodyReaderMediaTypes(Class<?> type, Type genericType, Annotation[] annotations)
type
- the class of object that is to be read.genericType
- the type of object to be read. E.g. if the message body is to be
read as a method parameter, this will be the declared type of the
parameter as returned by Method.getGenericParameterTypes
.annotations
- an array of the annotations on the declaration of the artifact
that will be read. E.g. if the message body is to be consumed as a
method parameter, this will be the annotations on that parameter
returned by Method.getParameterAnnotations
.List<javax.ws.rs.core.MediaType> getMessageBodyReaderMediaTypesByType(Class<?> type)
type
- the class of object that is to be read.List<javax.ws.rs.ext.MessageBodyReader> getMessageBodyReadersForType(Class<?> type)
MessageBodyReader
s that are suitable for the given type
. The list is sorted based on the
class hierarchy (most specific readers are first).type
- the class of object readers are requested for.MessageBodyReader
s for given class.List<ReaderModel> getReaderModelsForType(Class<?> type)
MessageBodyReader
models that are suitable for the given type
.
The list is sorted based on the class hierarchy (most specific readers are first).type
- the class of object readers are requested for.MessageBodyReader
models for given class.List<javax.ws.rs.core.MediaType> getMessageBodyWriterMediaTypes(Class<?> type, Type genericType, Annotation[] annotations)
type
- the class of object that is to be written.genericType
- the type of object to be written. E.g. if the message body is to
be produced from a field, this will be the declared type of the field as
returned by Field.getGenericType
.annotations
- an array of the annotations on the declaration of the artifact
that will be written. E.g. if the message body is to be produced from a
field, this will be the annotations on that field returned by
Field.getDeclaredAnnotations
.List<javax.ws.rs.core.MediaType> getMessageBodyWriterMediaTypesByType(Class<?> type)
type
- the class of object that is to be written.List<javax.ws.rs.ext.MessageBodyWriter> getMessageBodyWritersForType(Class<?> type)
MessageBodyWriter
s that are suitable for the given type
. The list is sorted based on the
class hierarchy (most specific writers are first).type
- the class of object writers are requested for.MessageBodyWriter
s for given class.List<WriterModel> getWritersModelsForType(Class<?> type)
MessageBodyWriter
models that are suitable for the given type
.
The list is sorted based on the class hierarchy (most specific writers are first).type
- the class of object writers are requested for.MessageBodyWriter
models for given class.javax.ws.rs.core.MediaType getMessageBodyWriterMediaType(Class<?> type, Type genericType, Annotation[] annotations, List<javax.ws.rs.core.MediaType> acceptableMediaTypes)
type
- the class of object that is to be written.genericType
- the type of object to be written. E.g. if the message body is to
be produced from a field, this will be the declared type of the field as
returned by Field.getGenericType
.annotations
- an array of the annotations on the declaration of the artifact
that will be written. E.g. if the message body is to be produced from a
field, this will be the annotations on that field returned by
Field.getDeclaredAnnotations
.acceptableMediaTypes
- the list of acceptable media types, sorted according to
the quality with the media type of highest quality occurring first
first.Object readFrom(Class<?> rawType, Type type, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders, PropertiesDelegate propertiesDelegate, InputStream entityStream, Iterable<javax.ws.rs.ext.ReaderInterceptor> readerInterceptors, boolean translateNce) throws javax.ws.rs.WebApplicationException, IOException
entityStream
using interceptors. If the
parameter intercept
is true then reader
interceptors
are executed before calling the message
body reader
. The appropriate message body reader
is
chosen after the interceptor execution based on parameter passed to this method
and modified by the interceptors.rawType
- raw Java entity type.type
- generic Java entity type.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 mutable HTTP headers associated with HTTP entity.propertiesDelegate
- request-scoped properties delegate.entityStream
- the InputStream
of the HTTP entity. The stream is not
closed after reading the entity.readerInterceptors
- Reader interceptor that are to be used to intercept the reading of an entity. The interceptors
will be executed in the same order as given in this parameter.translateNce
- if true
, the NoContentException
thrown by a selected message body
reader will be translated into a BadRequestException
as required by
JAX-RS specification on the server side.entityStream
.javax.ws.rs.WebApplicationException
- Thrown when message body
reader
fails.IOException
- Thrown when reading from the entityStream
fails.OutputStream writeTo(Object entity, Class<?> rawType, Type type, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders, PropertiesDelegate propertiesDelegate, OutputStream entityStream, Iterable<javax.ws.rs.ext.WriterInterceptor> writerInterceptors) throws IOException, javax.ws.rs.WebApplicationException
entityStream
using interceptors. If the
parameter intercept
is true then writer
interceptors
are executed before calling the message
body writer
. The appropriate message body writer
is
chosen after the interceptor execution based on parameter passed to this method
and modified by the interceptors.entity
- Entity to be written to the entityStreamrawType
- raw Java entity type.type
- generic Java entity type.annotations
- an array of the annotations on the resource method that returns
the object.mediaType
- the media type of the HTTP entity.httpHeaders
- the mutable HTTP headers associated with HTTP entity.propertiesDelegate
- request-scoped properties delegate.entityStream
- the OutputStream
for the HTTP entity.writerInterceptors
- Writer interceptor that are to be used to intercept the writing of an entity. The interceptors
will be executed in the same order as given in this parameter.javax.ws.rs.WebApplicationException
- Thrown when message body
reader
fails.IOException
- Thrown when reading from the entityStream
fails.Copyright © 2007-2021, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.