pt.digitalis.dif.controller.http
Class HTTPConstants

java.lang.Object
  pt.digitalis.dif.controller.http.HTTPConstants

public class HTTPConstants
extends Object

Defines a set of constants used on the HTTP service requests and responses.

Author:

Pedro Viegas pviegas@digitalis.pt, Rodrigo Gonçalves rgoncalves@digitalis.pt

Created on:

Dec 19, 2007

Field Summary

static String	AJAX_MODE_PARAMETER The HTTP parameter indicating that a stage is to be retrieved in component mode.
static String	ASSET_ID_PARAMETER The HTTP parameter indicating that we wish to retrieve an asset form the DiF's repository
static String	COMPONENT_MODE_PARAMETER The HTTP parameter indicating that a stage is to be retrieved in component mode.
static String	CONVENTIONED_HELP_SUFFIX The suffix for use in messages that define a Help text for components
static String	CONVENTIONED_HINT_SUFFIX The suffix for use in messages that define a Hint text for components
static String	DOC_IS_ATTACHMENT_PARAMETER The HTTP parameter indicating that the document is an attachment
static String	DOCID_PARAMETER The HTTP parameter indicating that we wish to retrieve a document form the DiF's repository
static String	ERROR_ATTRIBUTE The parameter name to indicate after successful login stage
static String	EVENT_ID Event id called.
static String	FORM_FIELD_NAMES Form complete field names, so we know all fields to invalidate session values on form submit
static String	FORM_PARENT_STAGE_PARAMETER Form hidden field indicating the stage where the include stage was born.
static String	FORM_SUBMIT__CONFIG_BUSINESS_ID Form configuration business id for the form submit occurred.
static String	FORM_SUBMIT_NAME Form id where the form submit occurred.
static String	FORM_SUBMIT_STAGE Stage id where the form submit occurred.
static String	FORM_VALIDATION Form validation request identifier for validation only AJAX action.
static String	FORMAT_PARAMETER The HTTP parameter containing the stage name that will be invoked.
static String	HELP_MODE_PARAMETER The HTTP parameter indicating that a stage is to be retrieved in help mode.
static String	HTTP_CHANNEL_ID
static String	INSERT_MODE_PARAMETER The HTTP parameter indicating that the form is in insert mode.
static String	LANGUAGE The HTTP parameter indicating the language.
static String	ON_SUCESS_LOGIN_STAGE The parameter name to indicate after successful login stage
static String	PAGE_IMPORTED_IDS_PARAMETER The HTTP parameter indicating that parent page script already include, in component mode.
static String	PARENT_STAGE_PARAMETER The HTTP parameter indicating the stage where the include stage was born.
static String	POPUP_MODE_PARAMETER The HTTP parameter indicating that a stage is to be retrieved in popup mode.
static String	RESPONSE_ATTRIBUTE The attribute name to put DIFResponse into the HttpServletRequest.
static String	REST_URL_PARAMETER The HTTP parameter indicating that a stage was called component mode.
static String	STAGE_PARAMETER The HTTP parameter containing the stage name that will be invoked.
static String	SUBMIT_ACTION The submit action parameter name
static String	TAB_INDEX_PARAMETER The Tab Index parameter, indicates which index the page should begin
static String	TEMPLATE_MODE_PARAMETER The HTTP parameter indicating that a stage is to be retrieved in template mode.
static String	THEME_ID the new theme ID
static String	UPLOAD_FILE_SIZE_ERROR The HTTP parameter indicating that an error occurred in upload file.
static String	WEBUI_COMPAT_MODE The HTTP parameter indicating the compatibility mode for Rich Web UI.
static String	WEBUI_DEBUG_MODE The HTTP parameter indicating the debug mode for Rich Web UI.
static String	WEBUI_MODE The HTTP parameter indicating the mode to render the web page in.

Constructor Summary

HTTPConstants()

Method Summary

static List<String>

getPrivateParameters() Inspector for the 'privateParameters' attribute.

Methods inherited from class java.lang.Object

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

Field Detail

AJAX_MODE_PARAMETER

public static final String AJAX_MODE_PARAMETER

The HTTP parameter indicating that a stage is to be retrieved in component mode.

See Also:

Constant Field Values

ASSET_ID_PARAMETER

public static final String ASSET_ID_PARAMETER

The HTTP parameter indicating that we wish to retrieve an asset form the DiF's repository

See Also:

Constant Field Values

COMPONENT_MODE_PARAMETER

public static final String COMPONENT_MODE_PARAMETER

The HTTP parameter indicating that a stage is to be retrieved in component mode.

See Also:

Constant Field Values

CONVENTIONED_HELP_SUFFIX

public static final String CONVENTIONED_HELP_SUFFIX

The suffix for use in messages that define a Help text for components

See Also:

Constant Field Values

CONVENTIONED_HINT_SUFFIX

public static final String CONVENTIONED_HINT_SUFFIX

The suffix for use in messages that define a Hint text for components

See Also:

Constant Field Values

DOC_IS_ATTACHMENT_PARAMETER

public static final String DOC_IS_ATTACHMENT_PARAMETER

The HTTP parameter indicating that the document is an attachment

See Also:

Constant Field Values

DOCID_PARAMETER

public static final String DOCID_PARAMETER

The HTTP parameter indicating that we wish to retrieve a document form the DiF's repository

See Also:

Constant Field Values

ERROR_ATTRIBUTE

public static final String ERROR_ATTRIBUTE

The parameter name to indicate after successful login stage

See Also:

Constant Field Values

EVENT_ID

public static final String EVENT_ID

Event id called.

See Also:

Constant Field Values

FORM_FIELD_NAMES

public static final String FORM_FIELD_NAMES

Form complete field names, so we know all fields to invalidate session values on form submit

See Also:

Constant Field Values

FORM_PARENT_STAGE_PARAMETER

public static final String FORM_PARENT_STAGE_PARAMETER

Form hidden field indicating the stage where the include stage was born.

See Also:

Constant Field Values

FORM_SUBMIT__CONFIG_BUSINESS_ID

public static final String FORM_SUBMIT__CONFIG_BUSINESS_ID

Form configuration business id for the form submit occurred.

See Also:

Constant Field Values

FORM_SUBMIT_NAME

public static final String FORM_SUBMIT_NAME

Form id where the form submit occurred.

See Also:

Constant Field Values

FORM_SUBMIT_STAGE

public static final String FORM_SUBMIT_STAGE

Stage id where the form submit occurred.

See Also:

Constant Field Values

FORM_VALIDATION

public static final String FORM_VALIDATION

Form validation request identifier for validation only AJAX action.

See Also:

Constant Field Values

FORMAT_PARAMETER

public static final String FORMAT_PARAMETER

The HTTP parameter containing the stage name that will be invoked.

See Also:

Constant Field Values

HELP_MODE_PARAMETER

public static final String HELP_MODE_PARAMETER

The HTTP parameter indicating that a stage is to be retrieved in help mode.

See Also:

Constant Field Values

HTTP_CHANNEL_ID

public static final String HTTP_CHANNEL_ID

See Also:

Constant Field Values

INSERT_MODE_PARAMETER

public static final String INSERT_MODE_PARAMETER

The HTTP parameter indicating that the form is in insert mode.

See Also:

Constant Field Values

LANGUAGE

public static final String LANGUAGE

The HTTP parameter indicating the language.

See Also:

Constant Field Values

ON_SUCESS_LOGIN_STAGE

public static final String ON_SUCESS_LOGIN_STAGE

The parameter name to indicate after successful login stage

See Also:

Constant Field Values

PAGE_IMPORTED_IDS_PARAMETER

public static final String PAGE_IMPORTED_IDS_PARAMETER

The HTTP parameter indicating that parent page script already include, in component mode.

See Also:

Constant Field Values

PARENT_STAGE_PARAMETER

public static final String PARENT_STAGE_PARAMETER

The HTTP parameter indicating the stage where the include stage was born.

See Also:

Constant Field Values

POPUP_MODE_PARAMETER

public static final String POPUP_MODE_PARAMETER

The HTTP parameter indicating that a stage is to be retrieved in popup mode.

See Also:

Constant Field Values

RESPONSE_ATTRIBUTE

public static final String RESPONSE_ATTRIBUTE

The attribute name to put DIFResponse into the HttpServletRequest.

See Also:

Constant Field Values

REST_URL_PARAMETER

public static final String REST_URL_PARAMETER

The HTTP parameter indicating that a stage was called component mode.

See Also:

Constant Field Values

STAGE_PARAMETER

public static final String STAGE_PARAMETER

The HTTP parameter containing the stage name that will be invoked.

See Also:

Constant Field Values

SUBMIT_ACTION

public static final String SUBMIT_ACTION

The submit action parameter name

See Also:

Constant Field Values

TAB_INDEX_PARAMETER

public static final String TAB_INDEX_PARAMETER

The Tab Index parameter, indicates which index the page should begin

See Also:

Constant Field Values

TEMPLATE_MODE_PARAMETER

public static final String TEMPLATE_MODE_PARAMETER

The HTTP parameter indicating that a stage is to be retrieved in template mode.

See Also:

Constant Field Values

THEME_ID

public static final String THEME_ID

the new theme ID

See Also:

Constant Field Values

UPLOAD_FILE_SIZE_ERROR

public static final String UPLOAD_FILE_SIZE_ERROR

The HTTP parameter indicating that an error occurred in upload file.

See Also:

Constant Field Values

WEBUI_COMPAT_MODE

public static final String WEBUI_COMPAT_MODE

The HTTP parameter indicating the compatibility mode for Rich Web UI.

See Also:

Constant Field Values

WEBUI_DEBUG_MODE

public static final String WEBUI_DEBUG_MODE

The HTTP parameter indicating the debug mode for Rich Web UI.

See Also:

Constant Field Values

WEBUI_MODE

public static final String WEBUI_MODE

The HTTP parameter indicating the mode to render the web page in.

See Also:

Constant Field Values

Constructor Detail

HTTPConstants

public HTTPConstants()

Method Detail

getPrivateParameters

public static List<String> getPrivateParameters()

Inspector for the 'privateParameters' attribute.

Returns:

the privateParameters value