bradleyross.j2ee.servlets

Class UploadServlet.ThisPage

java.lang.Object

bradleyross.j2ee.servlets.ThisPage

bradleyross.j2ee.servlets.UploadServlet.ThisPage

Enclosing class:

UploadServlet

public class UploadServlet.ThisPage
extends ThisPage

Contains information relating to a single HTTP request.

Since a single object can be used for multiple simultaneous HTTP requests, information about a single request can't be placed in the fields relating to the instance.

By placing the contents of all of the data fields in this object, the methods can have access to all of the fields without interfering with each other.

Each of the input fields is identified by its name in the HTML tag.

Author:

Bradley Ross

Field Summary

Fields

Modifier and Type	Field and Description
protected String	boundary Boundary marker for multipart form
protected boolean	endOfPacket True if final part of request has been processed.
protected Hashtable<String,UploadServlet.Contents>	items Contains the various elements from the requesting form.
protected String	redirectAddress Address to be used for redirecting servlet upon completion.

Fields inherited from class bradleyross.j2ee.servlets.ThisPage

config, contents, context, data, debugLevel, DOWNLOAD, endDate, fileName, input, messageList, mimeType, mode, NORMAL, startDate, terminateRequest

Constructor Summary

Constructors

Constructor and Description
UploadServlet.ThisPage(HttpServletRequest value1, HttpServletResponse value2, ServletConfig value3) Constructor for object, setting the input and output streams so that the element can be processed.

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(UploadServlet.Contents value) Adds an element to the list associated with the HTTP request.
String	getBoundary() Obtains value of boundary marker
byte[]	getByteArray(String key) Return the contents of one of the elements as a byte array.
UploadServlet.Contents	getElement(String key) Retrieve the object associated with an element based on the element name.
boolean	getEndOfPacket() Gets value of endOfPacket.
Enumeration<String>	getPartNames() Return an enumeration containing the names of the elements.
String	getRedirectAddress() Get the URL to be used for redirecting the servlet upon completion.
String	getString(String key) Return the contents of one of the elements as a String object.
void	setEndOfPacket(boolean value) Sets value of endOfPacket.
void	setRedirectAddress(String value) Set the URL for redirecting the servlet upon completion.

Methods inherited from class bradleyross.j2ee.servlets.ThisPage

addException, addMessage, clearWriter, errorMessage, getConfig, getContents, getContext, getDatabase, getDebugLevel, getEndDate, getFileName, getInputStream, getMessageList, getMimeType, getMode, getOutputStream, getPrinter, getRequest, getResponse, getStartDate, getTerminateRequest, getWriter, sendContents, setContents, setDatabase, setDebugLevel, setEndDate, setFileName, setMimeType, setMode, setStartDate

Methods inherited from class java.lang.Object

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

Field Detail

items

protected Hashtable<String,UploadServlet.Contents> items

Contains the various elements from the requesting form.

endOfPacket

protected boolean endOfPacket

True if final part of request has been processed.

See Also:

getEndOfPacket(), setEndOfPacket(boolean)

boundary

protected String boundary

Boundary marker for multipart form

redirectAddress

protected String redirectAddress

Address to be used for redirecting servlet upon completion.

See Also:

HttpServletResponse.sendRedirect(String), getRedirectAddress(), setRedirectAddress(String)

Constructor Detail

UploadServlet.ThisPage

public UploadServlet.ThisPage(HttpServletRequest value1,
                      HttpServletResponse value2,
                      ServletConfig value3)
                       throws IOException

Constructor for object, setting the input and output streams so that the element can be processed.

Parameters:

value1 - Request object

value2 - Response object

value3 - Servlet configuration object

Throws:

IOException

Method Detail

setEndOfPacket

public void setEndOfPacket(boolean value)

Sets value of endOfPacket.

Parameters:

value - Value for endOfPacket

See Also:

endOfPacket

getEndOfPacket

public boolean getEndOfPacket()

Gets value of endOfPacket.

Returns:

value of endOfPacket

See Also:

endOfPacket

getBoundary

public String getBoundary()

Obtains value of boundary marker

Returns:

Value of boundary marker

addElement

public void addElement(UploadServlet.Contents value)

Adds an element to the list associated with the HTTP request.

Parameters:

value - Element

getPartNames

public Enumeration<String> getPartNames()

Return an enumeration containing the names of the elements.

Returns:

Enumeration containing list of names.

setRedirectAddress

public void setRedirectAddress(String value)

Set the URL for redirecting the servlet upon completion.

Overrides:

setRedirectAddress in class ThisPage

Parameters:

value - URL to be used for redirecting servlet

See Also:

redirectAddress

getRedirectAddress

public String getRedirectAddress()

Get the URL to be used for redirecting the servlet upon completion.

Overrides:

getRedirectAddress in class ThisPage

Returns:

URL to be used

See Also:

redirectAddress

getElement

public UploadServlet.Contents getElement(String key)

Retrieve the object associated with an element based on the element name.

Parameters:

key - Name of the element in the form

Returns:

Object containing the contents of the element, including name, MIME type, and contents

getString

public String getString(String key)

Return the contents of one of the elements as a String object.

Parameters:

key - Key value for element

Returns:

String object containing contents

getByteArray

public byte[] getByteArray(String key)

Return the contents of one of the elements as a byte array.

Parameters:

key - Key value for the element

Returns:

Byte array containing contents of element