EE4J Core API 10.0.0 · jakarta.ws.rs.ext.MessageBodyReader

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public boolean	Returns: `true` if the type is supported, otherwise `false`. isReadable(Class<?> the class of instance to be produced. type, Type 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`. genericType, Annotation[] 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`. annotations, MediaType the media type of the HTTP entity, if one is not specified in the request then `application/octet-stream` is used. mediaType) Ascertain if the MessageBodyReader can produce an instance of a particular type.
public T	Returns: the type that was read from the stream. In case the entity input stream is empty, the reader is expected to either return an instance representing a zero-length entity or throw a `jakarta.ws.rs.core.NoContentException` in case no zero-length entity representation is defined for the supported Java type. readFrom(Class<T> the type that is to be read from the entity stream. type, Type 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`. genericType, Annotation[] 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`. annotations, MediaType the media type of the HTTP entity. mediaType, MultivaluedMap<String, String> the read-only HTTP headers associated with HTTP entity. httpHeaders, 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. entityStream) Read a type from the `InputStream`.

public boolean

Returns:

true if the type is supported, otherwise false.

the class of instance to be produced.

type, Type

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.

genericType, Annotation[]

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.

annotations, MediaType

the media type of the HTTP entity, if one is not specified in the request then application/octet-stream is used.

mediaType)

Ascertain if the MessageBodyReader can produce an instance of a particular type.

public T

Returns:

the type that was read from the stream. In case the entity input stream is empty, the reader is expected to either return an instance representing a zero-length entity or throw a jakarta.ws.rs.core.NoContentException in case no zero-length entity representation is defined for the supported Java type.

readFrom(Class<T>

the type that is to be read from the entity stream.

type, Type

genericType, Annotation[]

annotations, MediaType

the media type of the HTTP entity.

mediaType, MultivaluedMap<String, String>

the read-only HTTP headers associated with HTTP entity.

httpHeaders, 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.

entityStream)

Read a type from the InputStream.

Method Detail

isReadable back to summary

isReadable	back to summary
public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) Ascertain if the MessageBodyReader can produce an instance of a particular type. The `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`. Parameters type:Class<?> the class of instance to be produced. genericType:Type 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:Annotation[] 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:MediaType the media type of the HTTP entity, if one is not specified in the request then `application/octet-stream` is used. Returns:boolean `true` if the type is supported, otherwise `false`.

public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)

Ascertain if the MessageBodyReader can produce an instance of a particular type. The 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.

Parameters

type:Class<?>: the class of instance to be produced.
genericType:Type: 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:Annotation[]: 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:MediaType: the media type of the HTTP entity, if one is not specified in the request then application/octet-stream is used.

Returns:boolean

true if the type is supported, otherwise false.

readFrom back to summary

readFrom	back to summary
public T readFrom(Class<T> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String, String> httpHeaders, InputStream entityStream) throws IOException, WebApplicationException Read a type from the `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 `jakarta.ws.rs.core.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 `jakarta.ws.rs.BadRequestException` wrapping the original `NoContentException` and rethrown for a standard processing by the registered `exception mappers`. Parameters type:Class<T> the type that is to be read from the entity stream. genericType:Type 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:Annotation[] 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:MediaType the media type of the HTTP entity. httpHeaders:MultivaluedMap<String, String> the read-only HTTP headers associated with HTTP entity. entityStream: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. Returns:T the type that was read from the stream. In case the entity input stream is empty, the reader is expected to either return an instance representing a zero-length entity or throw a `jakarta.ws.rs.core.NoContentException` in case no zero-length entity representation is defined for the supported Java type. Exceptions 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 T readFrom(Class<T> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String, String> httpHeaders, InputStream entityStream) throws IOException, WebApplicationException

Read a type from the 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 jakarta.ws.rs.core.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 jakarta.ws.rs.BadRequestException wrapping the original NoContentException and rethrown for a standard processing by the registered exception mappers.

Parameters

type:Class<T>: the type that is to be read from the entity stream.
genericType:Type: 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:Annotation[]: 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:MediaType: the media type of the HTTP entity.
httpHeaders:MultivaluedMap<String, String>: the read-only HTTP headers associated with HTTP entity.
entityStream: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.

Returns:T

Exceptions

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 Interface MessageBodyReader<T>

Method Summary

Method Detail