@Provider @Produces(value="*/*") public class StreamingOutputProvider extends Object implements MessageBodyWriter<StreamingOutput>
Constructor and Description |
---|
StreamingOutputProvider() |
Modifier and Type | Method and Description |
---|---|
long |
getSize(StreamingOutput streamingOutput,
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 |
isWriteable(Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType)
Ascertain if the MessageBodyWriter supports a particular type.
|
void |
writeTo(StreamingOutput streamingOutput,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,Object> httpHeaders,
OutputStream entityStream)
Write a type to an HTTP message.
|
public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
MessageBodyWriter
isWriteable
in interface MessageBodyWriter<StreamingOutput>
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(StreamingOutput streamingOutput, 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 version 2.0 of this API, the method has been deprecated and the value returned by the method is ignored
by an API 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 the runtime.
getSize
in interface MessageBodyWriter<StreamingOutput>
streamingOutput
- 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(StreamingOutput streamingOutput, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream) throws IOException
MessageBodyWriter
writeTo
in interface MessageBodyWriter<StreamingOutput>
streamingOutput
- 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.Copyright © 2020 JBoss by Red Hat. All rights reserved.