ThisPage (Bradley Ross Examples)

java.lang.Object
- bradleyross.j2ee.servlets.ThisPage

Direct Known Subclasses:

Servlet.ThisPage, UploadServlet.ThisPage
```
public class ThisPage
extends Object
```
Used by code for servlets to pass information about a specific HTTP request.

Author:

Bradley Ross

See Also:
UploadServlet.ThisPage

Field Summary

Fields
Modifier and Type	Field and Description
`protected ServletConfig`	`config` Servlet configuration.
`protected byte[]`	`contents` The byte array contains the contents of the document to be displayed.
`protected ServletContext`	`context` Application (context) configuration.
`protected DatabaseProperties`	`data` Used to pass information on database connection.
`protected int`	`debugLevel` Controls amount of diagnostic output.
`static int`	`DOWNLOAD` Indicates that the document should be downloaded to the client machine.
`protected Date`	`endDate` Ending date of date range.
`protected String`	`fileName` File name to be associated with the download.
`protected ServletInputStream`	`input` Input stream from HTTP request.
`protected Vector<String>`	`messageList` A list of warning or error messages that will appear on the web page generated by the servlet.
`protected String`	`mimeType` Contains the MIME code for the document to be displayed.
`protected int`	`mode` Indicates the mode of operation.
`static int`	`NORMAL` Indicates that the document should be displayed in the browser if possible.
`private ServletOutputStream`	`outputStream` Object for sending information to HTTP response as a binary stream.
`private GenericPrinter`	`printer` This is the printer object that will be used by servlet code.
`protected String`	`redirectAddress` Address to be used for redirecting servlet.
`private HttpServletRequest`	`request` Request object.
`private HttpServletResponse`	`response` Response object.
`protected Date`	`startDate` Starting date of date range.
`private StringWriter`	`stringWriter` Used internally to store information for page.
`protected boolean`	`terminateRequest` Cancel processing if set to true.
`private PrintWriter`	`writer` PrintWriter object for response.

Constructor Summary

Constructors
Constructor and Description
`ThisPage()` Default constructor added to allow subclassing.
`ThisPage(HttpServletRequest requestValue, HttpServletResponse responseValue, ServletConfig configValue)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addException(Exception e)` Adds a description of an exception to the list of messages for the error page.
`void`	`addMessage(String value)` Add a message to the list of messages for the error page.
`void`	`clearWriter()` Clear the contents of the StringWriter object.
`void`	`errorMessage()` Generates an error page based on the calls to the addMessage and addException methods.
`ServletConfig`	`getConfig()` Get servlet configuration.
`byte[]`	`getContents()` Get the byte array to be used to display the downloaded item.
`ServletContext`	`getContext()` Get application context.
`DatabaseProperties`	`getDatabase()` Get the object containing database connection properties.
`int`	`getDebugLevel()` Gets value of debugLevel.
`Date`	`getEndDate()` Return end date of date range.
`String`	`getFileName()` Get the filename associated with the item to be downloaded.
`ServletInputStream`	`getInputStream()` Return the input object obtaining information from the HTTP request.
`Vector<String>`	`getMessageList()` Returns list of messages for the error page.
`String`	`getMimeType()` Get the MIME code for the document.
`int`	`getMode()` Get the mode of operation.
`ServletOutputStream`	`getOutputStream()` Obtain the output stream for sending information to the browser as a stream of bytes.
`GenericPrinter`	`getPrinter()` Get the generic printer object.
`String`	`getRedirectAddress()` Get redirectAddress.
`HttpServletRequest`	`getRequest()` Gets request object.
`HttpServletResponse`	`getResponse()` Gets response object.
`Date`	`getStartDate()` Return start date for date range.
`boolean`	`getTerminateRequest()` Get the value of terminateRequest
`protected PrintWriter`	`getWriter()` Obtains the PrintWriter object for sending the page contents as a character string.
`void`	`sendContents()` Send the contents of the StringWriter object to the response object.
`void`	`setContents(byte[] value)` Set the byte array to be used to display the downloaded item.
`void`	`setDatabase(DatabaseProperties databaseValue)` Set the object containing database connection properties.
`void`	`setDebugLevel(int value)` Sets value of debugLevel
`void`	`setEndDate(Date value)` Set end date of date range.
`void`	`setFileName(String value)` Set the filename associated with the item to be downloaded.
`void`	`setMimeType(String value)` Set the MIME code for the document.
`void`	`setMode(int value)` Set the mode of operation
`void`	`setRedirectAddress(String value)` Set redirectAddress.
`void`	`setStartDate(Date value)` Set start date of date range.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - request
```
private HttpServletRequest request
```
    Request object.
  - response
```
private HttpServletResponse response
```
    Response object.
  - config
```
protected ServletConfig config
```
    Servlet configuration.
  - context
```
protected ServletContext context
```
    Application (context) configuration.
  - input
```
protected ServletInputStream input
```
    Input stream from HTTP request.
    
    See Also:
    getInputStream()
  - data
```
protected DatabaseProperties data
```
    Used to pass information on database connection.
    
    See Also:
    setDatabase(DatabaseProperties), getDatabase()
  - startDate
```
protected Date startDate
```
    Starting date of date range.
    
    See Also:
    setStartDate(Date), getStartDate()
  - endDate
```
protected Date endDate
```
    Ending date of date range.
    
    See Also:
    setEndDate(Date), getEndDate()
  - writer
```
private PrintWriter writer
```
    PrintWriter object for response.
    The value is only set when the method getWriter() is called.
    
    See Also:
    getWriter()
  - stringWriter
```
private StringWriter stringWriter
```
    Used internally to store information for page.
  - printer
```
private GenericPrinter printer
```
    This is the printer object that will be used by servlet code.
    The material is passed to a StringWriter that can be cleared and rewritten before sending the material to the response object.
    
    See Also:
    getPrinter()
  - outputStream
```
private ServletOutputStream outputStream
```
    Object for sending information to HTTP response as a binary stream.
    
    See Also:
    getOutputStream()
  - messageList
```
protected Vector<String> messageList
```
    A list of warning or error messages that will appear on the web page generated by the servlet.
    The text of the messages are processed by StringHelpers.escapeHTML(String) before being sent to the web page. The surrounding tags will also have to be added.
    
    The error page is generated by calling errorMessage().
  - terminateRequest
```
protected boolean terminateRequest
```
    Cancel processing if set to true.
    The flag is set when errorMessage() or sendContents() is called.
  - debugLevel
```
protected int debugLevel
```
    Controls amount of diagnostic output.
    More positive values mean more diagnostic listings.
  - NORMAL
```
public static final int NORMAL
```
    Indicates that the document should be displayed in the browser if possible.
    
    See Also:
    mode, Constant Field Values
  - DOWNLOAD
```
public static final int DOWNLOAD
```
    Indicates that the document should be downloaded to the client machine.
    
    See Also:
    mode, Constant Field Values
  - mode
```
protected int mode
```
    Indicates the mode of operation. The two possible values are defined by the static integer values NORMAL and DOWNLOAD.
  - mimeType
```
protected String mimeType
```
    Contains the MIME code for the document to be displayed.
  - contents
```
protected byte[] contents
```
    The byte array contains the contents of the document to be displayed.
  - fileName
```
protected String fileName
```
    File name to be associated with the download.
  - redirectAddress
```
protected String redirectAddress
```
    Address to be used for redirecting servlet.
- Constructor Detail
  - ThisPage
```
public ThisPage()
```
    Default constructor added to allow subclassing.
  - ThisPage
```
public ThisPage(HttpServletRequest requestValue,
        HttpServletResponse responseValue,
        ServletConfig configValue)
         throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - getTerminateRequest
```
public boolean getTerminateRequest()
```
    Get the value of terminateRequest
    
    Returns:
    Value of flag
    See Also:
    terminateRequest
  - clearWriter
```
public void clearWriter()
```
    Clear the contents of the StringWriter object.
  - getWriter
```
protected PrintWriter getWriter()
                         throws IOException
```
    Obtains the PrintWriter object for sending the page contents as a character string.
    The only public means of calling this method is to use sendContents().
    
    Returns:
    PrintWriter object
    
    Throws:
    
    IOException
  - sendContents
```
public void sendContents()
                  throws IOException
```
    Send the contents of the StringWriter object to the response object.
    
    Throws:
    
    IOException
  - setDatabase
```
public void setDatabase(DatabaseProperties databaseValue)
```
    Set the object containing database connection properties.
    
    Parameters:
    databaseValue - Object containing database properties
    See Also:
    data
  - getDatabase
```
public DatabaseProperties getDatabase()
```
    Get the object containing database connection properties.
    
    Returns:
    Object containing database connection properties
    See Also:
    data
  - getRequest
```
public HttpServletRequest getRequest()
```
    Gets request object.
    
    Returns:
    Request object
  - getResponse
```
public HttpServletResponse getResponse()
```
    Gets response object.
    
    Returns:
    Response object
  - getConfig
```
public ServletConfig getConfig()
```
    Get servlet configuration.
    Parameters that are specified for a single servlet belong to this object.
    
    Returns:
    Servlet configuration object
  - getContext
```
public ServletContext getContext()
```
    Get application context.
    Parameters that belong to the entire application belong to this object.
    
    Returns:
    Application context
    See Also:
    context
  - getInputStream
```
public ServletInputStream getInputStream()
```
    Return the input object obtaining information from the HTTP request.
    
    Returns:
    ServletInputStream object
    See Also:
    input
  - getOutputStream
```
public ServletOutputStream getOutputStream()
                                    throws IOException
```
    Obtain the output stream for sending information to the browser as a stream of bytes.
    If this method is called, the sendContents() and errorMessage() messages can not be used.
    
    Returns:
    ServletOutputStream object
    
    Throws:
    
    IOException
  - getPrinter
```
public GenericPrinter getPrinter()
```
    Get the generic printer object.
    
    Returns:
    GenericPrinter object
    See Also:
    printer
  - getMessageList
```
public Vector<String> getMessageList()
```
    Returns list of messages for the error page.
    
    Returns:
    List of messages
  - addMessage
```
public void addMessage(String value)
```
    Add a message to the list of messages for the error page.
    
    Parameters:
    value - Message to be added
    See Also:
    messageList
  - addException
```
public void addException(Exception e)
```
    Adds a description of an exception to the list of messages for the error page.
    
    Parameters:
    e - Exception to be described
    See Also:
    messageList
  - errorMessage
```
public void errorMessage()
                  throws IOException
```
    Generates an error page based on the calls to the addMessage and addException methods.
    
    Throws:
    
    IOException
    See Also:
    addMessage(String), addException(Exception)
  - setStartDate
```
public void setStartDate(Date value)
```
    Set start date of date range.
    
    Parameters:
    value - Date to be used for start of date range
    See Also:
    startDate
  - getStartDate
```
public Date getStartDate()
```
    Return start date for date range.
    
    Returns:
    Start of date range
    See Also:
    startDate
  - setEndDate
```
public void setEndDate(Date value)
```
    Set end date of date range.
    
    Parameters:
    value - Date to be used for end of date range
    See Also:
    endDate
  - getEndDate
```
public Date getEndDate()
```
    Return end date of date range.
    
    Returns:
    End date of date range
    See Also:
    endDate
  - getDebugLevel
```
public int getDebugLevel()
```
    Gets value of debugLevel.
    
    Returns:
    Value of debugLevel
    See Also:
    debugLevel
  - setDebugLevel
```
public void setDebugLevel(int value)
```
    Sets value of debugLevel
    
    Parameters:
    value - Value to be used
    See Also:
    debugLevel
  - setMimeType
```
public void setMimeType(String value)
```
    Set the MIME code for the document.
    
    Parameters:
    value - MIME code
  - getMimeType
```
public String getMimeType()
```
    Get the MIME code for the document.
    
    Returns:
    MIME code
  - setFileName
```
public void setFileName(String value)
```
    Set the filename associated with the item to be downloaded.
    
    Parameters:
    value - File name
  - getFileName
```
public String getFileName()
```
    Get the filename associated with the item to be downloaded.
    
    Returns:
    File name
  - getContents
```
public byte[] getContents()
```
    Get the byte array to be used to display the downloaded item.
    
    Returns:
    Contents of downloaded item
  - setContents
```
public void setContents(byte[] value)
```
    Set the byte array to be used to display the downloaded item.
    
    Parameters:
    value - Contents of downloaded item
  - setMode
```
public void setMode(int value)
             throws IOException
```
    Set the mode of operation
    
    Parameters:
    value - Mode of operation
    
    Throws:
    
    IOException
  - getMode
```
public int getMode()
```
    Get the mode of operation.
    
    Returns:
    Mode of operation
  - setRedirectAddress
```
public void setRedirectAddress(String value)
```
    Set redirectAddress.
    
    Parameters:
    value - Value to be used
    See Also:
    redirectAddress
  - getRedirectAddress
```
public String getRedirectAddress()
```
    Get redirectAddress.
    
    Returns:
    Value of redirectAddress
    See Also:
    redirectAddress

Class ThisPage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

request

response

config

context

input

data

startDate

endDate

writer

stringWriter

printer

outputStream

messageList

terminateRequest

debugLevel

NORMAL

DOWNLOAD

mode

mimeType

contents

fileName

redirectAddress

Constructor Detail

ThisPage

ThisPage

Method Detail

getTerminateRequest

clearWriter

getWriter

sendContents

setDatabase

getDatabase

getRequest

getResponse

getConfig

getContext

getInputStream

getOutputStream

getPrinter

getMessageList

addMessage

addException

errorMessage

setStartDate

getStartDate

setEndDate

getEndDate

getDebugLevel

setDebugLevel

setMimeType

getMimeType

setFileName

getFileName

getContents

setContents

setMode

getMode

setRedirectAddress

getRedirectAddress