Class FilePart

java.lang.Object

org.apache.commons.httpclient.methods.multipart.Part

org.apache.commons.httpclient.methods.multipart.PartBase

org.apache.commons.httpclient.methods.multipart.FilePart

public class FilePart
extends PartBase

This class implements a part of a Multipart post object that consists of a file.

Since:

2.0

Author:

Matthew Albright, Jeff Dever, Adrian Sutton, Michael Becke, Mark Diggory, Mike Bowler, Oleg Kalnichevski

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CHARSET	Default charset of file attachments.
static final String	DEFAULT_CONTENT_TYPE	Default content encoding of file attachments.
static final String	DEFAULT_TRANSFER_ENCODING	Default transfer encoding of file attachments.
protected static final String	FILE_NAME	Attachment's file name

Fields inherited from class Part

BOUNDARY, BOUNDARY_BYTES, CHARSET, CHARSET_BYTES, CONTENT_DISPOSITION, CONTENT_DISPOSITION_BYTES, CONTENT_TRANSFER_ENCODING, CONTENT_TRANSFER_ENCODING_BYTES, CONTENT_TYPE, CONTENT_TYPE_BYTES, CRLF, CRLF_BYTES, EXTRA, EXTRA_BYTES, QUOTE, QUOTE_BYTES

Constructor Summary

Constructors

Constructor	Description
FilePart(String name, File file)	FilePart Constructor.
FilePart(String name, File file, String contentType, String charset)	FilePart Constructor.
FilePart(String name, String fileName, File file)	FilePart Constructor.
FilePart(String name, String fileName, File file, String contentType, String charset)	FilePart Constructor.
FilePart(String name, PartSource partSource)	FilePart Constructor.
FilePart(String name, PartSource partSource, String contentType, String charset)	FilePart Constructor.

Method Summary

Modifier and Type	Method	Description
protected PartSource	getSource()	Returns the source of the file part.
protected long	lengthOfData()	Return the length of the data.
protected void	sendData(OutputStream out)	Write the data in "source" to the specified stream.
protected void	sendDispositionHeader(OutputStream out)	Write the disposition header to the output stream

Methods inherited from class PartBase

getCharSet, getContentType, getName, getTransferEncoding, setCharSet, setContentType, setName, setTransferEncoding

Methods inherited from class Part

getBoundary, getLengthOfParts, getLengthOfParts, getPartBoundary, isRepeatable, length, send, sendContentTypeHeader, sendEnd, sendEndOfHeader, sendParts, sendParts, sendStart, sendTransferEncodingHeader, toString

Methods inherited from class Object

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

Field Details

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

Default content encoding of file attachments.

See Also:

• Constant Field Values

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

Default charset of file attachments.

See Also:

• Constant Field Values

DEFAULT_TRANSFER_ENCODING

public static final String DEFAULT_TRANSFER_ENCODING

Default transfer encoding of file attachments.

See Also:

• Constant Field Values

FILE_NAME

protected static final String FILE_NAME

Attachment's file name

See Also:

• Constant Field Values

Constructor Details

FilePart

public FilePart(String name,
 PartSource partSource,
 String contentType,
 String charset)

FilePart Constructor.

Parameters:

name - the name for this part

partSource - the source for this part

contentType - the content type for this part, if null the default is used

charset - the charset encoding for this part, if null the default is used

FilePart

public FilePart(String name,
 PartSource partSource)

FilePart Constructor.

Parameters:

name - the name for this part

partSource - the source for this part

FilePart

public FilePart(String name,
 File file)
         throws FileNotFoundException

FilePart Constructor.

Parameters:

name - the name of the file part

file - the file to post

Throws:

FileNotFoundException - if the file is not a normal file or if it is not readable.

FilePart

public FilePart(String name,
 File file,
 String contentType,
 String charset)
         throws FileNotFoundException

FilePart Constructor.

Parameters:

name - the name of the file part

file - the file to post

contentType - the content type for this part, if null the default is used

charset - the charset encoding for this part, if null the default is used

Throws:

FileNotFoundException - if the file is not a normal file or if it is not readable.

FilePart

public FilePart(String name,
 String fileName,
 File file)
         throws FileNotFoundException

FilePart Constructor.

Parameters:

name - the name of the file part

fileName - the file name

file - the file to post

Throws:

FileNotFoundException - if the file is not a normal file or if it is not readable.

FilePart

public FilePart(String name,
 String fileName,
 File file,
 String contentType,
 String charset)
         throws FileNotFoundException

FilePart Constructor.

Parameters:

name - the name of the file part

fileName - the file name

file - the file to post

contentType - the content type for this part, if null the default is used

charset - the charset encoding for this part, if null the default is used

Throws:

FileNotFoundException - if the file is not a normal file or if it is not readable.

Method Details

sendDispositionHeader

protected void sendDispositionHeader(OutputStream out)
                              throws IOException

Write the disposition header to the output stream

Overrides:

sendDispositionHeader in class Part

Parameters:

out - The output stream

Throws:

IOException - If an IO problem occurs

See Also:

• Part.sendDispositionHeader(OutputStream)

sendData

protected void sendData(OutputStream out)
                 throws IOException

Write the data in "source" to the specified stream.

Specified by:

sendData in class Part

Parameters:

out - The output stream.

Throws:

IOException - if an IO problem occurs.

See Also:

• Part.sendData(OutputStream)

getSource

protected PartSource getSource()

Returns the source of the file part.

Returns:

The source.

lengthOfData

protected long lengthOfData()
                     throws IOException

Return the length of the data.

Specified by:

lengthOfData in class Part

Returns:

The length.

Throws:

IOException - if an IO problem occurs

See Also:

• Part.lengthOfData()