com.dpslink.base.io

Class FileUploadEvent

java.lang.Object

java.util.EventObject

com.dpslink.base.io.FileUploadEvent

All Implemented Interfaces:

java.io.Serializable

public class FileUploadEvent
extends java.util.EventObject

Defines a file upload event. A file upload event is sent to a registered FileUploadListener when the file upload processing requires some kind of action to be taken by the listener.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_EXCEPTION The error code for I/O exception occurred.
static int	ERROR_FILESIZE The error code for file size exceeded.
static int	ERROR_NONE The error code for no error.
static int	ERROR_NOTFOUND The error code for file not found.
private int	ivError The upload processing's error code.
private java.lang.String	ivField The name of the form field being processed.
private java.lang.String	ivFile The name of the file being processed.
private java.util.HashMap<java.lang.String,java.lang.String>	ivParams The submitted form fields and their values.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
FileUploadEvent(FileUpload source, java.lang.String field, java.lang.String file, java.util.HashMap<java.lang.String,java.lang.String> params, int error) Constructor for the upload event.

Method Summary

Modifier and Type	Method and Description
BaseServletContext	getContext() Returns the current context for the servlet or thread that initiated the file upload.
int	getError() Returns the upload processing's error code.
java.lang.String	getField() Returns the name of the form field being processed.
java.lang.String	getFile() Returns the name of the file being processed.
java.lang.String	getParam(java.lang.String name) Returns a parameter value from the submitted form fields and values.
java.util.HashMap<java.lang.String,java.lang.String>	getParams() Returns the hash map of all submitted form fields and values.
java.lang.String	getParamString(java.lang.String name) Returns a parameter value from the submitted form fields and values.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

ERROR_NONE

public static final int ERROR_NONE

The error code for no error.

See Also:

Constant Field Values

ERROR_NOTFOUND

public static final int ERROR_NOTFOUND

The error code for file not found.

See Also:

Constant Field Values

ERROR_FILESIZE

public static final int ERROR_FILESIZE

The error code for file size exceeded.

See Also:

Constant Field Values

ERROR_EXCEPTION

public static final int ERROR_EXCEPTION

The error code for I/O exception occurred.

See Also:

Constant Field Values

ivField

private java.lang.String ivField

The name of the form field being processed.

ivFile

private java.lang.String ivFile

The name of the file being processed.

ivParams

private java.util.HashMap<java.lang.String,java.lang.String> ivParams

The submitted form fields and their values.

ivError

private int ivError

The upload processing's error code.

Constructor Detail

FileUploadEvent

public FileUploadEvent(FileUpload source,
                       java.lang.String field,
                       java.lang.String file,
                       java.util.HashMap<java.lang.String,java.lang.String> params,
                       int error)

Constructor for the upload event.

Parameters:

source - (FileUpload) The object where the event originated.

field - (String) The name of the form field being processed.

file - (String) The name of the file being processed.

params - (HashMap) The submitted form fields and their values.

error - (int) The upload processing's error code.

Method Detail

getContext

public BaseServletContext getContext()

Returns the current context for the servlet or thread that initiated the file upload.

Returns:

BaseServletContext - The current servlet or thread context.

getField

public java.lang.String getField()

Returns the name of the form field being processed.

Returns:

String - The form field name.

getFile

public java.lang.String getFile()

Returns the name of the file being processed.

Returns:

String - The file name.

getParam

public java.lang.String getParam(java.lang.String name)

Returns a parameter value from the submitted form fields and values.

Parameters:

name - (String) The name of the desired parameter value.

Returns:

String - The value associated with the given parameter name. Returns null if a value for the parameter name does not exist.

getParams

public java.util.HashMap<java.lang.String,java.lang.String> getParams()

Returns the hash map of all submitted form fields and values.

Returns:

HashMap] - The submitted form fields and values.

getParamString

public java.lang.String getParamString(java.lang.String name)

Returns a parameter value from the submitted form fields and values.

Parameters:

name - (String) The name of the desired parameter value.

Returns:

String - The value associated with the given parameter name. Returns an empty string if a value for the parameter name does not exist.

getError

public int getError()

Returns the upload processing's error code.

Returns:

int - The error code.