org.jdesktop.html.form
[Java] Class FileParameter

java.lang.Object
  org.jdesktop.beans.AbstractBean
      org.jdesktop.http.NameValuePair
          org.jdesktop.http.Parameter
              org.jdesktop.html.form.FileParameter

public class FileParameter
extends Parameter

A special Parameter intended to be used as a Form Parameter on a FormRequest for uploading files.

FileParameter adds the contentType and fileName properties. These properties are used to construct the multipart/form-data body of a form request. It is important that the fileName refer to an actual existing file object, and that the contentType be accurate. If either of these two constraints are not met, then the request will likely fail.

The fileName must be formatted such that creating a new File will succeed in locating the file. We use the same rules as the URLConnection class for determining the contentType automatically for the file. In the common case, it will be unnecessary to indicate the contentType manually. However, in special cases you may need to specify the content type manually. The format of the contentType is a mime type, such as text/plain.

If the fileName is correctly specified, then the InputStream returned from getValueStream() will be non-null. You are responsible for closing this stream when finished reading from it.

The "value" of this Parameter is specified to be the fileName. This is enforced by overridding setValue to be a null-op, and by setFilename() calling super.setValue().

Authors:

Richard

MIMES

private static FileNameMap MIMES

contentType

private String contentType

contentTypeSetManually

private boolean contentTypeSetManually

fileName

private String fileName

FileParameter

public FileParameter()

Create a new FileParameter. You will need to specify a name and fileName at some point for this parameter to be useful.

FileParameter

public FileParameter(String name, File file)

Create a new FileParameter using the given name as the name of this parameter (the key, if you will), and the given File as the file to be uploaded by the FormRequest.

Parameters:

name

file - may be null.

FileParameter

public FileParameter(String name, String fileName)

Create a new FileParameter using the given name as the name of this parameter (the key if you will) and the given fileName as the absolute path to the file to be uploaded by the FormRequest.

Parameters:

name

fileName - may be null.

clone

FilePa
public FileParameter clone()

computeMimeType

static String computeMimeType(String filename)

Static utility method for computing the mime type based on a filename. This is made package private solely for the sake of testing.

Parameters:

filename

Returns:

getContentType

public final String getContentType()

Gets the content type of the data being uploaded. This is never null, and defaults to "content/unknown" when the mime type of the data couldn't be determined and was not set manually.

Returns:

getFilename

public final String getFilename()

Gets the absolute path of the file being uploaded.

Returns:

getMimeMap

private static final FileNameMap getMimeMap()

Static utility method for getting the FileNameMap used to map file names to mime types.

Returns:

getValueStream

public InputStream getValueStream()

Creates and returns a new InputStream based on the underlying file data. If it is not possible to create such an InputStream due to an incorrect or missing file, then null is returned.

Returns:

setContentType

public void setContentType(String contentType)

Sets the mime-type of the content being uploaded. Generally this is determined automatically when the fileName is set. In rare cases where the mime-type cannot be determined, or when you want to force the mime type, you can set the content type manually with this method.

Parameters:

contentType - if set to null, then the mime type "content/unknown" is used.

setFilename

public void setFilename(String name)

Sets the absolute path to the file to be uploaded. If null, then the filename is cleared and the parameter becomes useless for uploading. Invoking this method causes the content type to be set automatically, unless it has been set manually.

Parameters:

name

setValue

@Override
public void setValue(String value)

Groovy Documentation