creamtec.webcream.core
Class HttpRequestData

java.lang.Object
  creamtec.webcream.core.HttpRequestData

All Implemented Interfaces:

java.io.Serializable

public class HttpRequestData
extends java.lang.Object
implements java.io.Serializable

Holds various HTTP request parameters, mostly mirroring HttpRequest interface

See Also:

Serialized Form

Constructor Summary

HttpRequestData()

Method Summary

java.lang.String	getAction() Returns action, as specified in the HttpRequest.
java.lang.String	getAppName() Returns application name.
java.lang.String	getErrorMessage() Returns the error message to be displayed at the top of the response page
java.util.HashMap	getParams() Returns a hashtable of parameters, that represent the values, entered by the user to form inputs.
long	getRequestId() Returns the request ID.
boolean	isNewSession() Returns true if the request is recieved for a newly created session, which means that the client is making it's first request for the application (or returning to the application after exiting it)
void	setAction(java.lang.String action) Sets action to be emulated
void	setAppName(java.lang.String name) Sets application name.
void	setErrorMessage(java.lang.String errorMessage) Sets the error message that will be displayed at the top of the response page
void	setNewSession(boolean newSession) Sets whether or not the request is received for a new session
void	setParams(java.util.HashMap params) Sets parameters, containing values of form inputs
void	setRequestId(long id) Sets request ID

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequestData

public HttpRequestData()

Method Detail

setParams

public void setParams(java.util.HashMap params)

Sets parameters, containing values of form inputs

getParams

public java.util.HashMap getParams()

Returns a hashtable of parameters, that represent the values, entered by the user to form inputs. Values are specific to the type of input (see HTML), and for some inputs there may be no valuesin the hashtable at all. Typically, component name is used as a hash code Custom parameters placed into this map should have keys beginning with "custom."

getRequestId

public long getRequestId()

Returns the request ID. Used for synchronization of the focused window and the HTML page, being submitted

setRequestId

public void setRequestId(long id)

Sets request ID

isNewSession

public boolean isNewSession()

Returns true if the request is recieved for a newly created session, which means that the client is making it's first request for the application (or returning to the application after exiting it)

setNewSession

public void setNewSession(boolean newSession)

Sets whether or not the request is received for a new session

getAppName

public java.lang.String getAppName()

Returns application name. Application name is everything, typed after the servlet name in the URL (servletPath).

setAppName

public void setAppName(java.lang.String name)

Sets application name. Application name is everything, typed after the servlet name in the URL (servletPath).

getAction

public java.lang.String getAction()

Returns action, as specified in the HttpRequest. Action can be the extra directory path, that was appended to the servlet virtual directory (mapping), or can be specifed by a form

setAction

public void setAction(java.lang.String action)

Sets action to be emulated

getErrorMessage

public java.lang.String getErrorMessage()

Returns the error message to be displayed at the top of the response page

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Sets the error message that will be displayed at the top of the response page

Parameters:

errorMessage - text to be displayed or null