uws.service.request

Class UploadFile

java.lang.Object

uws.service.request.UploadFile

public class UploadFile
extends java.lang.Object

This class lets represent a file submitted inline in an HTTP request.

To read this special kind of parameter, an InputStream must be open. This class lets do it by its function open().

When not used any more this file should be deleted, in order to save server disk space. This can be easily done thanks to deleteFile(). This function actually just call the corresponding function of the file manager, which is the only one to known how to deal with this file on the server. Indeed, even if most of the time this file is stored on the local file system, it could also be stored on a distant server by a VOSpace. In this case, the way to proceed is different, hence the use of the file manager.

Version:

4.1 (11/2014)

Author:

Grégory Mantelet (ARI)

See Also:

UWSParameters, MultipartParser

Field Summary

Fields

Modifier and Type	Field and Description
protected UWSFileManager	fileManager File manager to use in order to open, move or delete this uploaded file.
java.lang.String	fileName File name.
long	length Length in bytes of the file.
protected java.lang.String	location Location at which the content of this upload has been stored.
java.lang.String	mimeType MIME type of the file.
protected UWSJob	owner Jobs that owns this uploaded file.
java.lang.String	paramName Name of the parameter in which the file was submitted.
protected boolean	used Indicate whether this file has been or is used by a UWSJob.

Constructor Summary

Constructors

Constructor and Description
UploadFile(java.lang.String paramName, java.lang.String fileName, java.lang.String location, UWSFileManager fileManager) Build the description of an uploaded file.
UploadFile(java.lang.String paramName, java.lang.String location, UWSFileManager fileManager) Build the description of an uploaded file.

Method Summary

Modifier and Type	Method and Description
void	deleteFile() Delete definitely this uploaded file from the server.
java.lang.String	getLocation() Get the location (e.g.
UWSJob	getOwner() Get the job that uses this uploaded file.
boolean	isUsed() Tell whether this uploaded file has been or will be used.
void	move(UWSJob destination) Move this uploaded file in a location related to the given UWSJob.
java.io.InputStream	open() Open a stream toward this uploaded file.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

paramName

public final java.lang.String paramName

Name of the parameter in which the file was submitted.

fileName

public final java.lang.String fileName

File name. It is the name provided in the HTTP request.

location

protected java.lang.String location

Location at which the content of this upload has been stored. It can be a local file path, but also any other path or ID allowing the UWSFileManager to access its content.

owner

protected UWSJob owner

Jobs that owns this uploaded file.

used

protected boolean used

Indicate whether this file has been or is used by a UWSJob. In other words, it is true when an open, move or delete operation has been performed. An unused UploadFile instance shall be physically deleted from the file system.

mimeType

public java.lang.String mimeType

MIME type of the file.

length

public long length

Length in bytes of the file. If negative, the length should be considered as unknown.

fileManager

protected final UWSFileManager fileManager

File manager to use in order to open, move or delete this uploaded file.

Constructor Detail

UploadFile

public UploadFile(java.lang.String paramName,
                  java.lang.String location,
                  UWSFileManager fileManager)

Build the description of an uploaded file.

Parameters:

paramName - Name of the HTTP request parameter in which the uploaded content was stored. MUST NOT be NULL

location - Location of the file on the server. This String is then used by the given file manager in order to open, move or delete the uploaded file. Thus, it can be a path, an ID or any other String meaningful to the file manager.

fileManager - File manager to use in order to open, move or delete this uploaded file from the server.

UploadFile

public UploadFile(java.lang.String paramName,
                  java.lang.String fileName,
                  java.lang.String location,
                  UWSFileManager fileManager)

Build the description of an uploaded file.

Parameters:

paramName - Name of the HTTP request parameter in which the uploaded content was stored. MUST NOT be NULL

fileName - Filename as provided by the HTTP request. MAY be NULL

location - Location of the file on the server. This String is then used by the given file manager in order to open, move or delete the uploaded file. Thus, it can be a path, an ID or any other String meaningful to the file manager.

fileManager - File manager to use in order to open, move or delete this uploaded file from the server.

Method Detail

getLocation

public java.lang.String getLocation()

Get the location (e.g. URI, file path) of this file on the server.

Important note: This function SHOULD be used only by the UWSFileManager when open, move and delete operations are executed. The RequestParser provided by the library set this location to the file URI (i.e. "file://{local-file-path}") since the default behavior is to store uploaded file on the system temporary directory.

Returns:

Location (e.g. URI) or ID or any other meaningful String used by the file manager to access to the uploaded file.

getOwner

public UWSJob getOwner()

Get the job that uses this uploaded file.

Returns:

The owner of this file.

isUsed

public final boolean isUsed()

Tell whether this uploaded file has been or will be used. That's to say, whether an open, delete or move operation has been executed (even if it failed) on this UploadFile instance.

Returns:

true if the file must be preserved, false otherwise.

open

public java.io.InputStream open()
                         throws java.io.IOException

Open a stream toward this uploaded file.

Returns:

Stream toward this upload content.

Throws:

java.io.IOException - If an error occurs while opening the stream.

See Also:

UWSFileManager.getUploadInput(UploadFile)

deleteFile

public void deleteFile()
                throws java.io.IOException

Delete definitely this uploaded file from the server.

Throws:

java.io.IOException - If the delete operation can not be performed.

See Also:

UWSFileManager.deleteUpload(UploadFile)

move

public void move(UWSJob destination)
          throws java.io.IOException

Move this uploaded file in a location related to the given UWSJob. It is particularly useful if at reception of an HTTP request uploaded files are stored in a temporary directory (e.g. /tmp on Unix/Linux systems).

This function calls UWSFileManager.moveUpload(UploadFile, UWSJob) to process to the physical moving of the file, but it then, it updates its location in this UploadFile instance. The file manager does NOT update this location! That's why it must not be called directly, but through move(UWSJob).

Parameters:

destination - The job by which this uploaded file will be exclusively used.

Throws:

java.io.IOException - If the move operation can not be performed.

See Also:

UWSFileManager.moveUpload(UploadFile, UWSJob)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object