org.glassfish.jersey.message.internal

Class StreamingOutputProvider

java.lang.Object

org.glassfish.jersey.message.internal.StreamingOutputProvider

All Implemented Interfaces:

MessageBodyWriter<StreamingOutput>

@Produces(value={"application/octet-stream","*/*"})
 @Singleton
public final class StreamingOutputProvider
extends Object
implements MessageBodyWriter<StreamingOutput>

Message body writer that supports streaming output marshalling.

Author:

Paul Sandoz

Constructor Summary

Constructors

Constructor and Description
StreamingOutputProvider()

Method Summary

Modifier and Type	Method and Description
long	getSize(StreamingOutput o, 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<?> t, Type gt, Annotation[] as, MediaType mediaType) Ascertain if the MessageBodyWriter supports a particular type.
void	writeTo(StreamingOutput o, Class<?> t, Type gt, Annotation[] as, MediaType mediaType, MultivaluedMap<String,Object> httpHeaders, OutputStream entity) Write a type to an HTTP message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamingOutputProvider

public StreamingOutputProvider()

Method Detail

isWriteable

public boolean isWriteable(Class<?> t,
                           Type gt,
                           Annotation[] as,
                           MediaType mediaType)

Description copied from interface: MessageBodyWriter

Ascertain if the MessageBodyWriter supports a particular type.

Specified by:

isWriteable in interface MessageBodyWriter<StreamingOutput>

Parameters:

t - the class of instance that is to be written.

gt - 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.

as - an array of the annotations attached to the message entity instance.

mediaType - the media type of the HTTP entity.

Returns:

true if the type is supported, otherwise false.

getSize

public long getSize(StreamingOutput o,
                    Class<?> type,
                    Type genericType,
                    Annotation[] annotations,
                    MediaType mediaType)

Description copied from interface: MessageBodyWriter

Originally, the method has been called before 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 JAX-RS 2.0, the method has been deprecated and the value returned by the method is ignored by a JAX-RS 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 JAX-RS runtime.

Specified by:

getSize in interface MessageBodyWriter<StreamingOutput>

Parameters:

o - 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.

Returns:

length in bytes or -1 if the length cannot be determined in advance.

writeTo

public void writeTo(StreamingOutput o,
                    Class<?> t,
                    Type gt,
                    Annotation[] as,
                    MediaType mediaType,
                    MultivaluedMap<String,Object> httpHeaders,
                    OutputStream entity)
             throws IOException

Description copied from interface: MessageBodyWriter

Write a type to an HTTP message. The message header map is mutable but any changes must be made before writing to the output stream since the headers will be flushed prior to writing the message body.

Specified by:

writeTo in interface MessageBodyWriter<StreamingOutput>

Parameters:

o - the instance to write.

t - the class of instance that is to be written.

gt - the type of instance to be written. GenericEntity provides a way to specify this information at runtime.

as - 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.

entity - the OutputStream for the HTTP entity. The implementation must not close the output stream.

Throws:

IOException - if an IO error arises.