org.codehaus.cargo.tools.daemon

Class MultipartFormWriter

java.lang.Object

org.codehaus.cargo.tools.daemon.MultipartFormWriter

public class MultipartFormWriter
extends java.lang.Object

Represents a form writer capable of sending files and form data as multipart chunks.

Version:

$Id: MultipartFormWriter.java 3648 2013-05-24 21:54:23Z alitokmen $

Constructor Summary

Constructors

Constructor and Description
MultipartFormWriter(MultipartFormContentType contentType, java.io.OutputStream os) Attaches to the outputstream and allows writing form data or files to it.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the writer.
void	writeField(java.lang.String name, java.lang.String value) Writes a string field value.
void	writeFile(java.lang.String name, java.lang.String mimeType, java.io.File file) Writes a file's contents.
void	writeFile(java.lang.String name, java.lang.String mimeType, java.lang.String fileName, byte[] data) Writes the given bytes.
void	writeFile(java.lang.String name, java.lang.String mimeType, java.lang.String fileName, java.io.InputStream is) Writes a input stream's contents.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipartFormWriter

public MultipartFormWriter(MultipartFormContentType contentType,
                           java.io.OutputStream os)

Attaches to the outputstream and allows writing form data or files to it.

Parameters:

contentType - The form content type

os - the output stream

Method Detail

writeField

public void writeField(java.lang.String name,
                       java.lang.String value)
                throws java.io.IOException

Writes a string field value.

Parameters:

name - the field name (required)

value - the field value

Throws:

java.io.IOException - on input/output errors

writeFile

public void writeFile(java.lang.String name,
                      java.lang.String mimeType,
                      java.io.File file)
               throws java.io.IOException

Writes a file's contents.

Parameters:

name - the field name

mimeType - the file content type (optional, recommended)

file - the file (the file must exist)

Throws:

java.io.IOException - on input/output errors

writeFile

public void writeFile(java.lang.String name,
                      java.lang.String mimeType,
                      java.lang.String fileName,
                      java.io.InputStream is)
               throws java.io.IOException

Writes a input stream's contents.

Parameters:

name - The field name

mimeType - The file content type (optional, recommended)

fileName - The file name (required)

is - The input stream

Throws:

java.io.IOException - on input/output errors

writeFile

public void writeFile(java.lang.String name,
                      java.lang.String mimeType,
                      java.lang.String fileName,
                      byte[] data)
               throws java.io.IOException

Writes the given bytes.

Parameters:

name - the field name

mimeType - the file content type (optional, recommended)

fileName - the file name (required)

data - the file data

Throws:

java.io.IOException - on input/output errors

close

public void close()
           throws java.io.IOException

Closes the writer. This method must be called.

Throws:

java.io.IOException - on input/output errors