com.ibm.dse.cs.html
Class HtmlConstants

java.lang.Object
  |
  +--com.ibm.dse.cs.html.HtmlConstants

public class HtmlConstants
extends java.lang.Object

Symbolic representations of the strings that are used by the Html client are contained in this class.


Field Summary
static java.lang.String AGINGEXCEPTIONCODE
          When a non-fatal DSEInvalidRequestException occurs, it may be either an Aging, a Pending or an Unconsistent processor failure, depending on whether a request was recently processed for the same page, or if the server is still processing a prior request for the page.
static java.lang.String CALLINGPAGEID
          When a request is issued from a form, the form has a page id on it in a hidden field.
static java.lang.String COMPID
          The component identifier assigned for traces
static java.lang.String DATAKEY
          When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY.
static java.lang.String DATANEXTEVENTNAME
          When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY.
static java.lang.String DATAOPERATIONNAME
          When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY.
static java.lang.String DATAPAGEID
          When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY.
static java.lang.String DATAPARENTCONTEXTNAME
          When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY.
static java.lang.String DATASESSIONIDKEY
          When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY.
static java.lang.String ERRORMESSAGES
          All the errors that will be displayed for a page and not specific to a field can be obtained from an array of Strings which is kept in the context with the key HtmlConstants.ERRORMESSAGES Cross validation errors, and double click errors fall under this category
static java.lang.String ERRORPAGE
          When a page wants to specify a particular page to handle validation errors that occur on it, it should include in a hidden field named HtmlConstants.ERRORPAGE the name of the page to handle the validation error.
static java.lang.String EXCEPTION
          When the presentation handler is called to process an exception, the exception is placed in the HttpServletRequest with the key HtmlConstants.EXCEPTION.
static java.lang.String EXTRAPATHINFO
          When a session is established (by invoking CSEstablishSessionServlet) if there is any extra data passed on the invokation (eg by calling CSEstablishSessionServlet/en) then the extra information is saved in the session in a dynamic field named HtmlConstants.EXTRAPATHINFO.
static java.lang.String HTMLEXCEPTION
          When a page is displayed, the framework may have placed any non-fatal exception in the HttpServletRequest with the key HtmlConstants.HTMLEXCEPTION.
static java.lang.String HTTPSESSION
          The name used to save the HttpSession in the operation context when DSE.INI HTMLClient.cookies == true.
static java.lang.String JSPBASEPATH
          The dse.ini file includes a specified path where web resources will be obtained by the application server.
static java.lang.String LASTPAGEIDPROCESSED
          When a request is issued from a form, the form has a page id on it in a hidden field.
static java.lang.String MINREQUESTRESUBMITTIME
          Field from dse.ini which specifies the minimum time in seconds between repeat requests from a given page id in a given session.
static java.lang.String NEXTEVENTNAME
          The name of a hidden field on a form which is to run under control of a Processor Operation.
static java.lang.String OPERATIONCONTEXT
          After an operation executes, its context is saved in the HttpServletRequest with the key HtmlConstants.OPERATIONCONTEXT.
static java.lang.String OPERATIONNAME
          The name of a hidden field on a form which is submitted for processing by CSReqServlet which holds the name of the DSEServerOperation to execute.
static java.lang.String PAGEID
          Every page has a unique (for its session) page id so that requests can be tracked by the server.
static java.lang.String PARENTCONTEXTNAME
          When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY.
static java.lang.String PENDINGEXCEPTIONCODE
          When a non-fatal DSEInvalidRequestException occurs, it may be either an Aging, a Pending or an Unconsistent processor failure, depending on whether a request was recently processed for the same page, or if the server is still processing a prior request for the page.
static java.lang.String PROCESSORID
          The id of the Processor which ran the operation which displayed the reply page.
static java.lang.String PROCESSOROPERATIONNAME
          The name of the Processor Operation that is to run for a request from an Html form.
static java.lang.String PROCESSORSTATE
          The name of the Processor state which the processor was in when the reply page was displayed.
static java.lang.String REPLYPAGE
          When an operation is run by the framework, its context must include a field HtmlConstants.REPLYPAGE.
static java.lang.String SESSIONID
          The name used in the framework to represent the session id.
static java.lang.String SETTINGSAGINGMESSAGE
          Field from dse.ini which specifies the message which must be appended to the exception thrown when an aging exception occurs.
static java.lang.String SETTINGSDOUBLECLICKMESSAGE
          Field from dse.ini which specifies the message which must be appended to the exception thrown when a double click occurs.
static java.lang.String SETTINGSERRORPAGEKEY
          Field from dse.ini which specifies the name of the default error page to use when the framework has an exception which prevents the normal reply page from being used.
static java.lang.String SETTINGSFILEPATHKEY
          Field from dse.ini which specifies the relative path from the application server web path for web files (jsp files).
static java.lang.String SETTINGSHOMEPAGEKEY
          Field from dse.ini which specifies the name of the home page to display when cookies are used and an HttpSession is used.
static java.lang.String SETTINGSSTARTUPOPKEY
          Field from dse.ini which specifies the name of the operation to use when CSEstablishSessionServlet is invoked.
static java.lang.String SETTINGSUNCONSISTENTPROCESSORMESSAGE
          Field from dse.ini which specifies the message which must be appended to the exception thrown when an unconsistent processor exception occurs.
static java.lang.String TYPEEXCEPTION
          When an exception is thrown due to a type mismatch on a form, the exception is saved in the HttpServletRequest with key HtmlConstants.TYPEEXCEPTION for access by the designated error page.
static java.lang.String UNCONSISTENTPROCESSOREXCEPTIONCODE
          When a non-fatal DSEInvalidRequestException occurs, it may be either an Aging, a Pending or an Unconsistent processor failure, depending on whether a request was recently processed for the same page, or if the server is still processing a prior request for the page, or if the server is processing a request for this processor.
 
Constructor Summary
HtmlConstants()
          HtmlConstants constructor comment.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SESSIONID

public static final java.lang.String SESSIONID
The name used in the framework to represent the session id. The session and operation contexts which are used by Html client operations must include a field which has this name.

COMPID

public static final java.lang.String COMPID
The component identifier assigned for traces

HTTPSESSION

public static final java.lang.String HTTPSESSION
The name used to save the HttpSession in the operation context when DSE.INI HTMLClient.cookies == true.

PAGEID

public static final java.lang.String PAGEID
Every page has a unique (for its session) page id so that requests can be tracked by the server. There must be a hidden field on each page that has a form where the framework places the page id for the request which the form will generate when it is posted. The name of this hidden field must be HtmlConstants.PAGEID.

PARENTCONTEXTNAME

public static final java.lang.String PARENTCONTEXTNAME
When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY. A hidden field named PARENTCONTEXTNAME must be on the form to supply the field named parentContextName in this keyed collection.

JSPBASEPATH

public static final java.lang.String JSPBASEPATH
The dse.ini file includes a specified path where web resources will be obtained by the application server. This path is taken relative to the web path of the app server. It is referred to internally in the framework by HtmlConstants.JSPBASEPATH.

CALLINGPAGEID

public static final java.lang.String CALLINGPAGEID
When a request is issued from a form, the form has a page id on it in a hidden field. A field in the operation context named HtmlConstants.CALLINGPAGEID is required for use by the framework.

EXTRAPATHINFO

public static final java.lang.String EXTRAPATHINFO
When a session is established (by invoking CSEstablishSessionServlet) if there is any extra data passed on the invokation (eg by calling CSEstablishSessionServlet/en) then the extra information is saved in the session in a dynamic field named HtmlConstants.EXTRAPATHINFO.

LASTPAGEIDPROCESSED

public static final java.lang.String LASTPAGEIDPROCESSED
When a request is issued from a form, the form has a page id on it in a hidden field. This field is stored as the calling page id for the form. Upon successful completion of the request, this page id is stored as the last processed page id, in the variable defined below.

REPLYPAGE

public static final java.lang.String REPLYPAGE
When an operation is run by the framework, its context must include a field HtmlConstants.REPLYPAGE. The operation must place the name of the page to reply to the client in this field when it executes.

EXCEPTION

public static final java.lang.String EXCEPTION
When the presentation handler is called to process an exception, the exception is placed in the HttpServletRequest with the key HtmlConstants.EXCEPTION. The error page can then access the exception by obtaining the exception from the HttpServletRequest with this key.

OPERATIONCONTEXT

public static final java.lang.String OPERATIONCONTEXT
After an operation executes, its context is saved in the HttpServletRequest with the key HtmlConstants.OPERATIONCONTEXT. The reply page can then access the operation results from the context by obtaining the context from the HttpServletRequest with this key.

ERRORPAGE

public static final java.lang.String ERRORPAGE
When a page wants to specify a particular page to handle validation errors that occur on it, it should include in a hidden field named HtmlConstants.ERRORPAGE the name of the page to handle the validation error.

ERRORMESSAGES

public static final java.lang.String ERRORMESSAGES
All the errors that will be displayed for a page and not specific to a field can be obtained from an array of Strings which is kept in the context with the key HtmlConstants.ERRORMESSAGES Cross validation errors, and double click errors fall under this category

HTMLEXCEPTION

public static final java.lang.String HTMLEXCEPTION
When a page is displayed, the framework may have placed any non-fatal exception in the HttpServletRequest with the key HtmlConstants.HTMLEXCEPTION. It is up to the JSP author to decide if a message will be displayed to the user on the page about the exception which occurred. Normally the exception getCode() method can be called by the JSP author to obtain more information about the nature of the non-fatal exception.

TYPEEXCEPTION

public static final java.lang.String TYPEEXCEPTION
When an exception is thrown due to a type mismatch on a form, the exception is saved in the HttpServletRequest with key HtmlConstants.TYPEEXCEPTION for access by the designated error page.

PROCESSOROPERATIONNAME

public static final java.lang.String PROCESSOROPERATIONNAME
The name of the Processor Operation that is to run for a request from an Html form.

NEXTEVENTNAME

public static final java.lang.String NEXTEVENTNAME
The name of a hidden field on a form which is to run under control of a Processor Operation. The content of this field should specify which event to pump to the automaton to cause the next operation to be executed.

OPERATIONNAME

public static final java.lang.String OPERATIONNAME
The name of a hidden field on a form which is submitted for processing by CSReqServlet which holds the name of the DSEServerOperation to execute.

AGINGEXCEPTIONCODE

public static final java.lang.String AGINGEXCEPTIONCODE
When a non-fatal DSEInvalidRequestException occurs, it may be either an Aging, a Pending or an Unconsistent processor failure, depending on whether a request was recently processed for the same page, or if the server is still processing a prior request for the page. The exception setCode() method is called to set HtmlConstants.AGINGEXCEPTIONCODE for Aging errors.

PENDINGEXCEPTIONCODE

public static final java.lang.String PENDINGEXCEPTIONCODE
When a non-fatal DSEInvalidRequestException occurs, it may be either an Aging, a Pending or an Unconsistent processor failure, depending on whether a request was recently processed for the same page, or if the server is still processing a prior request for the page. The exception setCode() method is called to set HtmlConstants.PENDINGEXCEPTIONCODE for Pending errors.

UNCONSISTENTPROCESSOREXCEPTIONCODE

public static final java.lang.String UNCONSISTENTPROCESSOREXCEPTIONCODE
When a non-fatal DSEInvalidRequestException occurs, it may be either an Aging, a Pending or an Unconsistent processor failure, depending on whether a request was recently processed for the same page, or if the server is still processing a prior request for the page, or if the server is processing a request for this processor. The exception setCode() method is called to set HtmlConstants.PENDINGEXCEPTIONCODE for Pending errors.

SETTINGSERRORPAGEKEY

public static final java.lang.String SETTINGSERRORPAGEKEY
Field from dse.ini which specifies the name of the default error page to use when the framework has an exception which prevents the normal reply page from being used.

SETTINGSSTARTUPOPKEY

public static final java.lang.String SETTINGSSTARTUPOPKEY
Field from dse.ini which specifies the name of the operation to use when CSEstablishSessionServlet is invoked.

SETTINGSFILEPATHKEY

public static final java.lang.String SETTINGSFILEPATHKEY
Field from dse.ini which specifies the relative path from the application server web path for web files (jsp files).

SETTINGSHOMEPAGEKEY

public static final java.lang.String SETTINGSHOMEPAGEKEY
Field from dse.ini which specifies the name of the home page to display when cookies are used and an HttpSession is used.

MINREQUESTRESUBMITTIME

public static final java.lang.String MINREQUESTRESUBMITTIME
Field from dse.ini which specifies the minimum time in seconds between repeat requests from a given page id in a given session. This value is intended to help prevent multiple submissions when only one was intended by the user. The time begins when the server actually completes the processing of the operation and has called processReply() for the result page.

PROCESSORSTATE

public static final java.lang.String PROCESSORSTATE
The name of the Processor state which the processor was in when the reply page was displayed.

PROCESSORID

public static final java.lang.String PROCESSORID
The id of the Processor which ran the operation which displayed the reply page.

DATAKEY

public static final java.lang.String DATAKEY
When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY.

DATAOPERATIONNAME

public static final java.lang.String DATAOPERATIONNAME
When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY. DATAOPERATIONNAME is the name of the field in this keyed collection that holds the operation name from the form which was submitted.

DATANEXTEVENTNAME

public static final java.lang.String DATANEXTEVENTNAME
When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY. DATANEXTEVENTNAME is the name of the field in this keyed collection that holds the next event name from the form which was submitted.

DATAPARENTCONTEXTNAME

public static final java.lang.String DATAPARENTCONTEXTNAME
When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY. DATAPARENTCONTEXTNAME is the name of the field in this keyed collection that holds the parent context from the form which was submitted.

DATAPAGEID

public static final java.lang.String DATAPAGEID
When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY. DATAPAGEID is the name of the field in this keyed collection that holds the page id from the form which was submitted.

DATASESSIONIDKEY

public static final java.lang.String DATASESSIONIDKEY
When CSReqServlet is called, it fills a keyed collection named CSConstants.DATAKEY. DATASESSIONIDKEY is the name of the field in this keyed collection that holds the session id from the form which was submitted.

SETTINGSDOUBLECLICKMESSAGE

public static final java.lang.String SETTINGSDOUBLECLICKMESSAGE
Field from dse.ini which specifies the message which must be appended to the exception thrown when a double click occurs.

SETTINGSAGINGMESSAGE

public static final java.lang.String SETTINGSAGINGMESSAGE
Field from dse.ini which specifies the message which must be appended to the exception thrown when an aging exception occurs.

SETTINGSUNCONSISTENTPROCESSORMESSAGE

public static final java.lang.String SETTINGSUNCONSISTENTPROCESSORMESSAGE
Field from dse.ini which specifies the message which must be appended to the exception thrown when an unconsistent processor exception occurs.
Constructor Detail

HtmlConstants

public HtmlConstants()
HtmlConstants constructor comment.