org.jboss.resteasy.plugins.providers.multipart
Class MultipartFormDataWriter

java.lang.Object
  extended by org.jboss.resteasy.plugins.providers.multipart.AbstractMultipartWriter
      extended by org.jboss.resteasy.plugins.providers.multipart.AbstractMultipartFormDataWriter
          extended by org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataWriter
All Implemented Interfaces:
MessageBodyWriter<MultipartFormDataOutput>

@Provider
public class MultipartFormDataWriter
extends AbstractMultipartFormDataWriter
implements MessageBodyWriter<MultipartFormDataOutput>

Version:
$Revision: 1 $
Author:
Bill Burke

Field Summary
 
Fields inherited from class org.jboss.resteasy.plugins.providers.multipart.AbstractMultipartWriter
workers
 
Constructor Summary
MultipartFormDataWriter()
           
 
Method Summary
 long getSize(MultipartFormDataOutput multipartFormDataOutput, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
          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(MultipartFormDataOutput multipartFormDataOutput, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream)
          Write a type to an HTTP response.
 
Methods inherited from class org.jboss.resteasy.plugins.providers.multipart.AbstractMultipartFormDataWriter
writeParts
 
Methods inherited from class org.jboss.resteasy.plugins.providers.multipart.AbstractMultipartWriter
write, writePart
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MultipartFormDataWriter

public MultipartFormDataWriter()
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<MultipartFormDataOutput>
Parameters:
type - the class of object that is to be written.
genericType - the type of object 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 on the resource method that returns the object.
mediaType - the media type of the HTTP entity.
Returns:
true if the type is supported, otherwise false.

getSize

public long getSize(MultipartFormDataOutput multipartFormDataOutput,
                    Class<?> type,
                    Type genericType,
                    Annotation[] annotations,
                    MediaType mediaType)
Description copied from interface: MessageBodyWriter
Called before writeTo to ascertain the length in bytes of the serialized form of t. A non-negative return value is used in a HTTP Content-Length header.

Specified by:
getSize in interface MessageBodyWriter<MultipartFormDataOutput>
Parameters:
multipartFormDataOutput - the instance to write
type - the class of object that is to be written.
genericType - the type of object to be written, obtained either by reflection of a resource method return type or by inspection of the returned instance. GenericEntity provides a way to specify this information at runtime.
annotations - an array of the annotations on the resource method that returns the object.
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(MultipartFormDataOutput multipartFormDataOutput,
                    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 response. The response 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 response body.

Specified by:
writeTo in interface MessageBodyWriter<MultipartFormDataOutput>
Parameters:
multipartFormDataOutput - the instance to write.
type - the class of object that is to be written.
genericType - the type of object to be written, obtained either by reflection of a resource method return type or by inspection of the returned instance. GenericEntity provides a way to specify this information at runtime.
annotations - an array of the annotations on the resource method that returns the object.
mediaType - the media type of the HTTP entity.
httpHeaders - a mutable map of the HTTP response headers.
entityStream - the OutputStream for the HTTP entity. The implementation should 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 response being committed.


Copyright © 2011. All Rights Reserved.