Package org.jboss.resteasy.plugins.providers.multipart

Class MultipartEntityPartWriter

java.lang.Object

org.jboss.resteasy.plugins.providers.multipart.AbstractMultipartWriter

org.jboss.resteasy.plugins.providers.multipart.AbstractMultipartFormDataWriter

org.jboss.resteasy.plugins.providers.multipart.MultipartEntityPartWriter

All Implemented Interfaces:

MessageBodyWriter<List<EntityPart>>, AsyncMessageBodyWriter<List<EntityPart>>

@Provider
@Produces("multipart/form-data")
public class MultipartEntityPartWriter
extends AbstractMultipartFormDataWriter
implements AsyncMessageBodyWriter<List<EntityPart>>

A MessageBodyWriter for write multipart/form-data as a list of entity parts.

Since:

6.1

Author:

James R. Perkins

Field Summary

Fields inherited from class org.jboss.resteasy.plugins.providers.multipart.AbstractMultipartWriter

COLON_SPACE_BYTES, DOUBLE_DASH_BYTES, LINE_SEPARATOR_BYTES, workers

Constructor Summary

Constructors

Constructor	Description
MultipartEntityPartWriter()

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	asyncWriteTo(List<EntityPart> entityParts, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> httpHeaders, AsyncOutputStream entityStream)	Write a type to an HTTP message using async IO.
boolean	isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)	Ascertain if the MessageBodyWriter supports a particular type.
void	writeTo(List<EntityPart> entityParts, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream)	Write a type to an HTTP message.

Methods inherited from class org.jboss.resteasy.plugins.providers.multipart.AbstractMultipartFormDataWriter

asyncWriteParts, writeParts

Methods inherited from class org.jboss.resteasy.plugins.providers.multipart.AbstractMultipartWriter

asyncWrite, asyncWrite, asyncWritePart, asyncWritePart, asyncWriteParts, write, write, writePart, writePart, writeParts

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.ws.rs.ext.MessageBodyWriter

getSize

Constructor Detail

MultipartEntityPartWriter

public MultipartEntityPartWriter()

Method Detail

isWriteable

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

Description copied from interface: MessageBodyWriter

Ascertain if the MessageBodyWriter supports a particular type.

Specified by:

isWriteable in interface MessageBodyWriter<List<EntityPart>>

Parameters:

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.

Returns:

true if the type is supported, otherwise false.

writeTo

public void writeTo(List<EntityPart> entityParts,
                    Class<?> type,
                    Type genericType,
                    Annotation[] annotations,
                    MediaType mediaType,
                    MultivaluedMap<String,Object> httpHeaders,
                    OutputStream entityStream)
             throws IOException,
                    WebApplicationException

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<List<EntityPart>>

Parameters:

entityParts - 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 must not close the output stream.

Throws:

IOException - if an IO error arises.

WebApplicationException - if a specific HTTP error response needs to be produced. Only effective if thrown prior to the message being committed.

asyncWriteTo

public CompletionStage<Void> asyncWriteTo(List<EntityPart> entityParts,
                                          Class<?> type,
                                          Type genericType,
                                          Annotation[] annotations,
                                          MediaType mediaType,
                                          MultivaluedMap<String,Object> httpHeaders,
                                          AsyncOutputStream entityStream)

Description copied from interface: AsyncMessageBodyWriter

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

Specified by:

asyncWriteTo in interface AsyncMessageBodyWriter<List<EntityPart>>

Parameters:

entityParts - 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 AsyncOutputStream for the HTTP entity. The implementation should not close the output stream.

Returns:

a CompletionStage indicating completion