/*
* Copyright (c) 2010, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.jersey.message;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.List;
import java.util.Map;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.ext.MessageBodyReader;
import javax.ws.rs.ext.MessageBodyWriter;
import javax.ws.rs.ext.ReaderInterceptor;
import javax.ws.rs.ext.WriterInterceptor;
import org.glassfish.jersey.internal.PropertiesDelegate;
An injectable interface providing lookup of MessageBodyReader
and MessageBodyWriter
instances. Author: Paul Sandoz See Also:
/**
* An injectable interface providing lookup of {@link MessageBodyReader} and
* {@link MessageBodyWriter} instances.
*
* @author Paul Sandoz
* @see javax.ws.rs.core.Context
* @see MessageBodyReader
* @see MessageBodyWriter
*/
public interface MessageBodyWorkers {
Get the map of media type to list of message body writers that are compatible with
a media type.
Params: - mediaType – the compatible media type.
Returns: the map of media type to list of message body writers.
/**
* Get the map of media type to list of message body writers that are compatible with
* a media type.
*
* @param mediaType the compatible media type.
* @return the map of media type to list of message body writers.
*/
public Map<MediaType, List<MessageBodyReader>> getReaders(MediaType mediaType);
Get the map of media type to list of message body writers that are compatible with
a media type.
Params: - mediaType – the compatible media type.
Returns: the map of media type to list of message body writers.
/**
* Get the map of media type to list of message body writers that are compatible with
* a media type.
*
* @param mediaType the compatible media type.
* @return the map of media type to list of message body writers.
*/
public Map<MediaType, List<MessageBodyWriter>> getWriters(MediaType mediaType);
Convert a map media type to list of message body readers to a string.
Params: - readers – the map media type to list of message body readers
Returns: the string representation.
/**
* Convert a map media type to list of message body readers to a string.
*
* @param readers the map media type to list of message body readers
* @return the string representation.
*/
public String readersToString(Map<MediaType, List<MessageBodyReader>> readers);
Convert a map media type to list of message body writers to a string.
Params: - writers – the map media type to list of message body readers
Returns: the string representation.
/**
* Convert a map media type to list of message body writers to a string.
*
* @param writers the map media type to list of message body readers
* @return the string representation.
*/
public String writersToString(Map<MediaType, List<MessageBodyWriter>> writers);
Get a message body reader that matches a set of criteria.
Params: - 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.
Type parameters: - <T> – the type of object to be read.
Returns: a MessageBodyReader that matches the supplied criteria or null if none is
found.
/**
* Get a message body reader that matches a set of criteria.
*
* @param <T> the type of object to be read.
* @param type the class of object to be read.
* @param 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
* {@code Class.getGenericParameterTypes}.
* @param 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
* {@code Class.getParameterAnnotations}.
* @param mediaType the media type of the data that will be read, this will be
* compared to the values of {@link javax.ws.rs.Consumes} for each
* candidate reader and only matching readers will be queried.
* @return a MessageBodyReader that matches the supplied criteria or null if none is
* found.
*/
<T> MessageBodyReader<T> getMessageBodyReader(Class<T> type, Type genericType, Annotation annotations[], MediaType mediaType);
Get a message body reader that matches a set of criteria.
Params: - 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.
Type parameters: - <T> – the type of object to be read.
Returns: a MessageBodyReader that matches the supplied criteria or null if none is
found.
/**
* Get a message body reader that matches a set of criteria.
*
* @param <T> the type of object to be read.
* @param type the class of object to be read.
* @param 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
* {@code Class.getGenericParameterTypes}.
* @param 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
* {@code Class.getParameterAnnotations}.
* @param mediaType the media type of the data that will be read, this will be
* compared to the values of {@link javax.ws.rs.Consumes} for each
* candidate reader and only matching readers will be queried.
* @param propertiesDelegate request-scoped properties delegate.
* @return a MessageBodyReader that matches the supplied criteria or null if none is
* found.
*/
<T> MessageBodyReader<T> getMessageBodyReader(Class<T> type, Type genericType, Annotation annotations[], MediaType mediaType,
PropertiesDelegate propertiesDelegate);
Get a message body writer that matches a set of criteria.
Params: - 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.
Type parameters: - <T> – the type of the object that is to be written.
Returns: a MessageBodyReader that matches the supplied criteria or null if none is
found.
/**
* Get a message body writer that matches a set of criteria.
*
* @param <T> the type of the object that is to be written.
* @param type the class of object that is to be written.
* @param 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 {@code Field.getGenericType}.
* @param 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
* {@code Field.getDeclaredAnnotations}.
* @param mediaType the media type of the data that will be written, this will be
* compared to the values of {@link javax.ws.rs.Produces} for each
* candidate writer and only matching writers will be queried.
* @return a MessageBodyReader that matches the supplied criteria or null if none is
* found.
*/
<T> MessageBodyWriter<T> getMessageBodyWriter(Class<T> type, Type genericType, Annotation annotations[], MediaType mediaType);
Get a message body writer that matches a set of criteria.
Params: - 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.
Type parameters: - <T> – the type of the object that is to be written.
Returns: a MessageBodyReader that matches the supplied criteria or null if none is
found.
/**
* Get a message body writer that matches a set of criteria.
*
* @param <T> the type of the object that is to be written.
* @param type the class of object that is to be written.
* @param 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 {@code Field.getGenericType}.
* @param 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
* {@code Field.getDeclaredAnnotations}.
* @param mediaType the media type of the data that will be written, this will be
* compared to the values of {@link javax.ws.rs.Produces} for each
* candidate writer and only matching writers will be queried.
* @param propertiesDelegate request-scoped properties delegate.
* @return a MessageBodyReader that matches the supplied criteria or null if none is
* found.
*/
<T> MessageBodyWriter<T> getMessageBodyWriter(Class<T> type, Type genericType, Annotation annotations[], MediaType mediaType,
PropertiesDelegate propertiesDelegate);
Get the list of media types supported for a Java type.
Params: - 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
.
Returns: the list of supported media types, the list is ordered as follows: a/b <
a/* < *\\/*
/**
* Get the list of media types supported for a Java type.
*
* @param type the class of object that is to be read.
* @param 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 {@code Method.getGenericParameterTypes}.
* @param 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 {@code Method.getParameterAnnotations}.
* @return the list of supported media types, the list is ordered as follows: a/b <
* a/* < *\\/*
*/
List<MediaType> getMessageBodyReaderMediaTypes(Class<?> type, Type genericType, Annotation[] annotations);
Get the list of media types supported for a Java type.
Params: - type – the class of object that is to be read.
Returns: the list of supported media types, the list is ordered as follows: a/b <
a/* < *\\/*
/**
* Get the list of media types supported for a Java type.
*
* @param type the class of object that is to be read.
* @return the list of supported media types, the list is ordered as follows: a/b <
* a/* < *\\/*
*/
List<MediaType> getMessageBodyReaderMediaTypesByType(Class<?> type);
Get a list of MessageBodyReader
s that are suitable for the given type
. The list is sorted based on the class hierarchy (most specific readers are first). Params: - type – the class of object readers are requested for.
Returns: the list of supported MessageBodyReader
s for given class.
/**
* Get a list of {@code MessageBodyReader}s that are suitable for the given {@code type}. The list is sorted based on the
* class hierarchy (most specific readers are first).
*
* @param type the class of object readers are requested for.
* @return the list of supported {@code MessageBodyReader}s for given class.
*/
List<MessageBodyReader> getMessageBodyReadersForType(Class<?> type);
Get a list of MessageBodyReader
models that are suitable for the given type
. The list is sorted based on the class hierarchy (most specific readers are first). Params: - type – the class of object readers are requested for.
Returns: the list of supported MessageBodyReader
models for given class. Since: 2.16
/**
* Get a list of {@code MessageBodyReader} models that are suitable for the given {@code type}.
*
* The list is sorted based on the class hierarchy (most specific readers are first).
*
* @param type the class of object readers are requested for.
* @return the list of supported {@code MessageBodyReader} models for given class.
* @since 2.16
*/
List<ReaderModel> getReaderModelsForType(Class<?> type);
Get the list of media types supported for a Java type.
Params: - 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
.
Returns: the list of supported media types, the list is ordered as follows: a/b <
a/* < *\\/*
/**
* Get the list of media types supported for a Java type.
*
* @param type the class of object that is to be written.
* @param 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 {@code Field.getGenericType}.
* @param 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
* {@code Field.getDeclaredAnnotations}.
* @return the list of supported media types, the list is ordered as follows: a/b <
* a/* < *\\/*
*/
List<MediaType> getMessageBodyWriterMediaTypes(Class<?> type, Type genericType, Annotation[] annotations);
Get the list of media types supported for a Java type.
Params: - type – the class of object that is to be written.
Returns: the list of supported media types, the list is ordered as follows: a/b <
a/* < *\\/*
/**
* Get the list of media types supported for a Java type.
*
* @param type the class of object that is to be written.
* @return the list of supported media types, the list is ordered as follows: a/b <
* a/* < *\\/*
*/
List<MediaType> getMessageBodyWriterMediaTypesByType(Class<?> type);
Get a list of MessageBodyWriter
s that are suitable for the given type
. The list is sorted based on the class hierarchy (most specific writers are first). Params: - type – the class of object writers are requested for.
Returns: the list of supported MessageBodyWriter
s for given class.
/**
* Get a list of {@code MessageBodyWriter}s that are suitable for the given {@code type}. The list is sorted based on the
* class hierarchy (most specific writers are first).
*
* @param type the class of object writers are requested for.
* @return the list of supported {@code MessageBodyWriter}s for given class.
*/
List<MessageBodyWriter> getMessageBodyWritersForType(Class<?> type);
Get a list of MessageBodyWriter
models that are suitable for the given type
. The list is sorted based on the class hierarchy (most specific writers are first). Params: - type – the class of object writers are requested for.
Returns: the list of supported MessageBodyWriter
models for given class. Since: 2.16
/**
* Get a list of {@code MessageBodyWriter} models that are suitable for the given {@code type}.
*
* The list is sorted based on the class hierarchy (most specific writers are first).
*
* @param type the class of object writers are requested for.
* @return the list of supported {@code MessageBodyWriter} models for given class.
* @since 2.16
*/
List<WriterModel> getWritersModelsForType(Class<?> type);
Get the most acceptable media type supported for a Java type given a set of
acceptable media types.
Params: - 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.
Returns: the best media types
/**
* Get the most acceptable media type supported for a Java type given a set of
* acceptable media types.
*
* @param type the class of object that is to be written.
* @param 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 {@code Field.getGenericType}.
* @param 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
* {@code Field.getDeclaredAnnotations}.
* @param acceptableMediaTypes the list of acceptable media types, sorted according to
* the quality with the media type of highest quality occurring first
* first.
* @return the best media types
*/
MediaType getMessageBodyWriterMediaType(Class<?> type, Type genericType, Annotation[] annotations,
List<MediaType> acceptableMediaTypes);
Reads a type from the 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. Params: - 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.
Throws: - WebApplicationException – Thrown when
message body
reader
fails. - IOException – Thrown when reading from the
entityStream
fails.
Returns: the entity that was read from the entityStream
.
/**
* Reads a type from the {@link InputStream entityStream} using interceptors. If the
* parameter {@code intercept} is true then {@link ReaderInterceptor reader
* interceptors} are executed before calling the {@link MessageBodyReader message
* body reader}. The appropriate {@link MessageBodyReader message body reader} is
* chosen after the interceptor execution based on parameter passed to this method
* and modified by the interceptors.
*
* @param rawType raw Java entity type.
* @param type generic Java entity type.
* @param 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
* {@code Method.getParameterAnnotations}.
* @param mediaType the media type of the HTTP entity.
* @param httpHeaders the mutable HTTP headers associated with HTTP entity.
* @param propertiesDelegate request-scoped properties delegate.
* @param entityStream the {@link InputStream} of the HTTP entity. The stream is not
* closed after reading the entity.
* @param 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.
* @param translateNce if {@code true}, the {@link javax.ws.rs.core.NoContentException} thrown by a selected message body
* reader will be translated into a {@link javax.ws.rs.BadRequestException} as required by
* JAX-RS specification on the server side.
* @return the entity that was read from the {@code entityStream}.
* @throws WebApplicationException Thrown when {@link MessageBodyReader message body
* reader} fails.
* @throws IOException Thrown when reading from the {@code entityStream} fails.
*/
public Object readFrom(Class<?> rawType,
Type type,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String, String> httpHeaders,
PropertiesDelegate propertiesDelegate,
InputStream entityStream,
Iterable<ReaderInterceptor> readerInterceptors,
boolean translateNce)
throws WebApplicationException, IOException;
Writers a type to the 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. Params: - entity – Entity to be written to the entityStream
- rawType – 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.
Throws: - WebApplicationException – Thrown when
message body
reader
fails. - IOException – Thrown when reading from the
entityStream
fails.
Returns: Outer output stream that should be closed by the caller.
/**
* Writers a type to the {@link OutputStream entityStream} using interceptors. If the
* parameter {@code intercept} is true then {@link WriterInterceptor writer
* interceptors} are executed before calling the {@link MessageBodyWriter message
* body writer}. The appropriate {@link MessageBodyWriter message body writer} is
* chosen after the interceptor execution based on parameter passed to this method
* and modified by the interceptors.
*
* @param entity Entity to be written to the entityStream
* @param rawType raw Java entity type.
* @param type generic Java entity type.
* @param annotations an array of the annotations on the resource method that returns
* the object.
* @param mediaType the media type of the HTTP entity.
* @param httpHeaders the mutable HTTP headers associated with HTTP entity.
* @param propertiesDelegate request-scoped properties delegate.
* @param entityStream the {@link OutputStream} for the HTTP entity.
* @param 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.
* @return Outer output stream that should be closed by the caller.
* @throws WebApplicationException Thrown when {@link MessageBodyReader message body
* reader} fails.
* @throws IOException Thrown when reading from the {@code entityStream} fails.
*/
public OutputStream writeTo(Object entity, Class<?> rawType, Type type, Annotation[] annotations, MediaType mediaType,
MultivaluedMap<String, Object> httpHeaders, PropertiesDelegate propertiesDelegate,
OutputStream entityStream,
Iterable<WriterInterceptor> writerInterceptors)
throws java.io.IOException, javax.ws.rs.WebApplicationException;
}