Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.commons.httpclient.methods.multipart

Class FilePart

public class FilePart
extends PartBase
This class implements a part of a Multipart post object that consists of a file.

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

Since:
2.0

Field Summary

static String
DEFAULT_CHARSET
Default charset of file attachments.
static String
DEFAULT_CONTENT_TYPE
Default content encoding of file attachments.
static String
DEFAULT_TRANSFER_ENCODING
Default transfer encoding of file attachments.
protected static String
FILE_NAME
Attachment's file name
protected static byte[]
FILE_NAME_BYTES
Attachment's file name as a byte array

Fields inherited from class org.apache.commons.httpclient.methods.multipart.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

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

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 org.apache.commons.httpclient.methods.multipart.PartBase

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

Methods inherited from class org.apache.commons.httpclient.methods.multipart.Part

getBoundary, getCharSet, getContentType, getLengthOfParts, getLengthOfParts, getName, getPartBoundary, getTransferEncoding, isRepeatable, length, lengthOfData, send, sendContentTypeHeader, sendData, sendDispositionHeader, sendEnd, sendEndOfHeader, sendParts, sendParts, sendStart, sendTransferEncodingHeader, toString

Field Details

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET
Default charset of file attachments.

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE
Default content encoding of file attachments.

DEFAULT_TRANSFER_ENCODING

public static final String DEFAULT_TRANSFER_ENCODING
Default transfer encoding of file attachments.

FILE_NAME

protected static final String FILE_NAME
Attachment's file name

FILE_NAME_BYTES

protected static final byte[] FILE_NAME_BYTES
Attachment's file name as a byte array

Constructor Details

FilePart

public FilePart(String name,
                File file)
            throws FileNotFoundException
FilePart Constructor.

Parameters:
name - the name of the file part
file - the file to post

FilePart

public FilePart(String name,
                File file,
                String contentType,
                String charset)
            throws FileNotFoundException
FilePart Constructor. default is used default is used

Parameters:
name - the name of the file part
file - the file to post
contentType - the content type for this part, if null the
charset - the charset encoding for this part, if null the

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

FilePart

public FilePart(String name,
                String fileName,
                File file,
                String contentType,
                String charset)
            throws FileNotFoundException
FilePart Constructor. default is used default is used

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
charset - the charset encoding for this part, if null the

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,
                PartSource partSource,
                String contentType,
                String charset)
FilePart Constructor. default is used default is used

Parameters:
name - the name for this part
partSource - the source for this part
contentType - the content type for this part, if null the
charset - the charset encoding for this part, if null the

Method Details

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.
Overrides:
lengthOfData in interface Part

Returns:
The length.

See Also:
Part.lengthOfData()

sendData

protected void sendData(OutputStream out)
            throws IOException
Write the data in "source" to the specified stream.
Overrides:
sendData in interface Part

Parameters:
out - The output stream.

See Also:
Part.sendData(OutputStream)

sendDispositionHeader

protected void sendDispositionHeader(OutputStream out)
            throws IOException
Write the disposition header to the output stream
Overrides:
sendDispositionHeader in interface Part

Parameters:
out - The output stream

See Also:
Part.sendDispositionHeader(OutputStream)

Overview Package Tree Index Deprecated About
Copyright (c) 1999-2005 - Apache Software Foundation