Coverage Report

Coverage Report - pt.digitalis.dif.controller.http.HTTPConstants

Classes in this File

0/16

0/2

 /**
  * 2007, Digitalis Informatica. All rights reserved. Distribuicao e Gestao de Informatica, Lda. Estrada de Paco de Arcos
  * num.9 - Piso -1 2780-666 Paco de Arcos Telefone: (351) 21 4408990 Fax: (351) 21 4408999 http://www.digitalis.pt
  */
 package pt.digitalis.dif.controller.http;
 
 import java.util.ArrayList;
 import java.util.List;
 
 import pt.digitalis.dif.controller.interfaces.IDIFRequest;
 
 /**
  * Defines a set of constants used on the HTTP service requests and responses.
  * 
  * @author Pedro Viegas <a href="mailto:pviegas@digitalis.pt">pviegas@digitalis.pt</a>
  * @author Rodrigo Gonçalves <a href="mailto:rgoncalves@digitalis.pt">rgoncalves@digitalis.pt</a>
  * @created Dec 19, 2007
  */
 public class HTTPConstants {
 
     /** The HTTP parameter indicating that a stage is to be retrieved in component mode. */
     final static public String AJAX_MODE_PARAMETER = "ajax_mode";
 
     /** The HTTP parameter indicating that we wish to retrieve an asset form the DiF's repository */
     final static public String ASSET_ID_PARAMETER = "assetID";
 
     /** The HTTP parameter indicating that a stage is to be retrieved in component mode. */
     final static public String COMPONENT_MODE_PARAMETER = "component_mode";
 
     /** The suffix for use in messages that define a Help text for components */
     final static public String CONVENTIONED_HELP_SUFFIX = "Help";
 
     /** The suffix for use in messages that define a Hint text for components */
     final static public String CONVENTIONED_HINT_SUFFIX = "Hint";
 
     /** The HTTP parameter indicating that the document is an attachment */
     final static public String DOC_IS_ATTACHMENT_PARAMETER = "docIsAttachment";
 
     /** The HTTP parameter indicating that we wish to retrieve a document form the DiF's repository */
     final static public String DOCID_PARAMETER = "docID";
 
     /** The parameter name to indicate after successful login stage */
     final static public String ERROR_ATTRIBUTE = "errordescriptor";
 
     /** Event id called. */
     final static public String EVENT_ID = "_event";
 
     /** Form complete field names, so we know all fields to invalidate session values on form submit */
     final static public String FORM_FIELD_NAMES = "_formfieldnames";
 
     /** Form hidden field indicating the stage where the include stage was born. */
     final static public String FORM_PARENT_STAGE_PARAMETER = "_formparentstage";
 
     /** Form configuration business id for the form submit occurred. */
     final static public String FORM_SUBMIT__CONFIG_BUSINESS_ID = "_formsubmitnameconfigbusinessid";
 
     /** Form id where the form submit occurred. */
     final static public String FORM_SUBMIT_NAME = "_formsubmitname";
 
     /** Stage id where the form submit occurred. */
     final static public String FORM_SUBMIT_STAGE = "_formsubmitstage";
 
     /** Form validation request identifier for validation only AJAX action. */
     final static public String FORM_VALIDATION = "_formvalidation";
 
     /** The HTTP parameter containing the stage name that will be invoked. */
     final static public String FORMAT_PARAMETER = "format";
 
     /** The HTTP parameter indicating that a stage is to be retrieved in help mode. */
     final static public String HELP_MODE_PARAMETER = "help_mode";
 
     /**  */
     final static public String HTTP_CHANNEL_ID = "http";
 
     /** The HTTP parameter indicating that the form is in insert mode. */
     final static public String INSERT_MODE_PARAMETER = "insert_mode";
 
     /** The HTTP parameter indicating the language. */
     final static public String LANGUAGE = "language";
 
     /** The parameter name to indicate after successful login stage */
     final static public String ON_SUCESS_LOGIN_STAGE = "afterloginstageid";
 
     /** The HTTP parameter indicating that parent page script already include, in component mode. */
     final static public String PAGE_IMPORTED_IDS_PARAMETER = "pageScriptsIDs";
 
     /** The HTTP parameter indicating the stage where the include stage was born. */
     final static public String PARENT_STAGE_PARAMETER = "_parentstage";
 
     /** The HTTP parameter indicating that a stage is to be retrieved in popup mode. */
     final static public String POPUP_MODE_PARAMETER = "popup_mode";
 
     /** A list of private DIF parameters that will not be saved in the breadcrumb instance */
     private static List<String> privateParameters;
 
     /** The attribute name to put DIFResponse into the HttpServletRequest. */
     final static public String RESPONSE_ATTRIBUTE = "DIFResponseAttribute";
 
     /** The HTTP parameter indicating that a stage was called component mode. */
     final static public String REST_URL_PARAMETER = "rest_call";
 
     /** The HTTP parameter containing the stage name that will be invoked. */
     final static public String STAGE_PARAMETER = "stage";
 
     /** The submit action parameter name */
     final static public String SUBMIT_ACTION = "submitAction";
 
     /** The Tab Index parameter, indicates which index the page should begin */
     final static public String TAB_INDEX_PARAMETER = "tabIndexParam";
 
     /** The HTTP parameter indicating that a stage is to be retrieved in template mode. */
     final static public String TEMPLATE_MODE_PARAMETER = "template_mode";
 
     /** the new theme ID */
     public static final String THEME_ID = "themeID";
 
     /** The HTTP parameter indicating that an error occurred in upload file. */
     final static public String UPLOAD_FILE_SIZE_ERROR = "Upload_File_Size_Error";
 
     /** The HTTP parameter indicating the compatibility mode for Rich Web UI. */
     final static public String WEBUI_COMPAT_MODE = "webui_compat_mode";
 
     /** The HTTP parameter indicating the debug mode for Rich Web UI. */
     final static public String WEBUI_DEBUG_MODE = "webui_debug_mode";
 
     /** The HTTP parameter indicating the mode to render the web page in. */
     final static public String WEBUI_MODE = "webui_mode";
 
     /**
      * Inspector for the 'privateParameters' attribute.
      * 
      * @return the privateParameters value
      */
     public static List<String> getPrivateParameters()
     {
         if (privateParameters == null)
         {
             privateParameters = new ArrayList<String>();
             privateParameters.add(HTTPConstants.STAGE_PARAMETER);
             privateParameters.add(HTTPConstants.HELP_MODE_PARAMETER);
             privateParameters.add(HTTPConstants.COMPONENT_MODE_PARAMETER);
             privateParameters.add(HTTPConstants.FORM_SUBMIT_STAGE);
             privateParameters.add(HTTPConstants.FORM_SUBMIT_NAME);
             privateParameters.add(HTTPConstants.EVENT_ID);
             privateParameters.add(HTTPConstants.LANGUAGE);
             privateParameters.add(HTTPConstants.WEBUI_MODE);
             privateParameters.add(HTTPConstants.ON_SUCESS_LOGIN_STAGE);
             privateParameters.add(IDIFRequest.USER_PARAMETER_ID);
             privateParameters.add(IDIFRequest.PASSWORD_PARAMETER_ID);
         }
 
         return privateParameters;
     }
 }

1	0	/**
2		* 2007, Digitalis Informatica. All rights reserved. Distribuicao e Gestao de Informatica, Lda. Estrada de Paco de Arcos
3		* num.9 - Piso -1 2780-666 Paco de Arcos Telefone: (351) 21 4408990 Fax: (351) 21 4408999 http://www.digitalis.pt
4		*/
5		package pt.digitalis.dif.controller.http;
6
7		import java.util.ArrayList;
8		import java.util.List;
9
10		import pt.digitalis.dif.controller.interfaces.IDIFRequest;
11
12		/**
13		* Defines a set of constants used on the HTTP service requests and responses.
14		*
15		* @author Pedro Viegas <a href="mailto:pviegas@digitalis.pt">pviegas@digitalis.pt</a>
16		* @author Rodrigo Gonçalves <a href="mailto:rgoncalves@digitalis.pt">rgoncalves@digitalis.pt</a>
17		* @created Dec 19, 2007
18		*/
19	0	public class HTTPConstants {
20
21		/** The HTTP parameter indicating that a stage is to be retrieved in component mode. */
22		final static public String AJAX_MODE_PARAMETER = "ajax_mode";
23
24		/** The HTTP parameter indicating that we wish to retrieve an asset form the DiF's repository */
25		final static public String ASSET_ID_PARAMETER = "assetID";
26
27		/** The HTTP parameter indicating that a stage is to be retrieved in component mode. */
28		final static public String COMPONENT_MODE_PARAMETER = "component_mode";
29
30		/** The suffix for use in messages that define a Help text for components */
31		final static public String CONVENTIONED_HELP_SUFFIX = "Help";
32
33		/** The suffix for use in messages that define a Hint text for components */
34		final static public String CONVENTIONED_HINT_SUFFIX = "Hint";
35
36		/** The HTTP parameter indicating that the document is an attachment */
37		final static public String DOC_IS_ATTACHMENT_PARAMETER = "docIsAttachment";
38
39		/** The HTTP parameter indicating that we wish to retrieve a document form the DiF's repository */
40		final static public String DOCID_PARAMETER = "docID";
41
42		/** The parameter name to indicate after successful login stage */
43		final static public String ERROR_ATTRIBUTE = "errordescriptor";
44
45		/** Event id called. */
46		final static public String EVENT_ID = "_event";
47
48		/** Form complete field names, so we know all fields to invalidate session values on form submit */
49		final static public String FORM_FIELD_NAMES = "_formfieldnames";
50
51		/** Form hidden field indicating the stage where the include stage was born. */
52		final static public String FORM_PARENT_STAGE_PARAMETER = "_formparentstage";
53
54		/** Form configuration business id for the form submit occurred. */
55		final static public String FORM_SUBMIT__CONFIG_BUSINESS_ID = "_formsubmitnameconfigbusinessid";
56
57		/** Form id where the form submit occurred. */
58		final static public String FORM_SUBMIT_NAME = "_formsubmitname";
59
60		/** Stage id where the form submit occurred. */
61		final static public String FORM_SUBMIT_STAGE = "_formsubmitstage";
62
63		/** Form validation request identifier for validation only AJAX action. */
64		final static public String FORM_VALIDATION = "_formvalidation";
65
66		/** The HTTP parameter containing the stage name that will be invoked. */
67		final static public String FORMAT_PARAMETER = "format";
68
69		/** The HTTP parameter indicating that a stage is to be retrieved in help mode. */
70		final static public String HELP_MODE_PARAMETER = "help_mode";
71
72		/** */
73		final static public String HTTP_CHANNEL_ID = "http";
74
75		/** The HTTP parameter indicating that the form is in insert mode. */
76		final static public String INSERT_MODE_PARAMETER = "insert_mode";
77
78		/** The HTTP parameter indicating the language. */
79		final static public String LANGUAGE = "language";
80
81		/** The parameter name to indicate after successful login stage */
82		final static public String ON_SUCESS_LOGIN_STAGE = "afterloginstageid";
83
84		/** The HTTP parameter indicating that parent page script already include, in component mode. */
85		final static public String PAGE_IMPORTED_IDS_PARAMETER = "pageScriptsIDs";
86
87		/** The HTTP parameter indicating the stage where the include stage was born. */
88		final static public String PARENT_STAGE_PARAMETER = "_parentstage";
89
90		/** The HTTP parameter indicating that a stage is to be retrieved in popup mode. */
91		final static public String POPUP_MODE_PARAMETER = "popup_mode";
92
93		/** A list of private DIF parameters that will not be saved in the breadcrumb instance */
94		private static List<String> privateParameters;
95
96		/** The attribute name to put DIFResponse into the HttpServletRequest. */
97		final static public String RESPONSE_ATTRIBUTE = "DIFResponseAttribute";
98
99		/** The HTTP parameter indicating that a stage was called component mode. */
100		final static public String REST_URL_PARAMETER = "rest_call";
101
102		/** The HTTP parameter containing the stage name that will be invoked. */
103		final static public String STAGE_PARAMETER = "stage";
104
105		/** The submit action parameter name */
106		final static public String SUBMIT_ACTION = "submitAction";
107
108		/** The Tab Index parameter, indicates which index the page should begin */
109		final static public String TAB_INDEX_PARAMETER = "tabIndexParam";
110
111		/** The HTTP parameter indicating that a stage is to be retrieved in template mode. */
112		final static public String TEMPLATE_MODE_PARAMETER = "template_mode";
113
114		/** the new theme ID */
115		public static final String THEME_ID = "themeID";
116
117		/** The HTTP parameter indicating that an error occurred in upload file. */
118		final static public String UPLOAD_FILE_SIZE_ERROR = "Upload_File_Size_Error";
119
120		/** The HTTP parameter indicating the compatibility mode for Rich Web UI. */
121		final static public String WEBUI_COMPAT_MODE = "webui_compat_mode";
122
123		/** The HTTP parameter indicating the debug mode for Rich Web UI. */
124		final static public String WEBUI_DEBUG_MODE = "webui_debug_mode";
125
126		/** The HTTP parameter indicating the mode to render the web page in. */
127		final static public String WEBUI_MODE = "webui_mode";
128
129		/**
130		* Inspector for the 'privateParameters' attribute.
131		*
132		* @return the privateParameters value
133		*/
134		public static List<String> getPrivateParameters()
135		{
136	0	if (privateParameters == null)
137		{
138	0	privateParameters = new ArrayList<String>();
139	0	privateParameters.add(HTTPConstants.STAGE_PARAMETER);
140	0	privateParameters.add(HTTPConstants.HELP_MODE_PARAMETER);
141	0	privateParameters.add(HTTPConstants.COMPONENT_MODE_PARAMETER);
142	0	privateParameters.add(HTTPConstants.FORM_SUBMIT_STAGE);
143	0	privateParameters.add(HTTPConstants.FORM_SUBMIT_NAME);
144	0	privateParameters.add(HTTPConstants.EVENT_ID);
145	0	privateParameters.add(HTTPConstants.LANGUAGE);
146	0	privateParameters.add(HTTPConstants.WEBUI_MODE);
147	0	privateParameters.add(HTTPConstants.ON_SUCESS_LOGIN_STAGE);
148	0	privateParameters.add(IDIFRequest.USER_PARAMETER_ID);
149	0	privateParameters.add(IDIFRequest.PASSWORD_PARAMETER_ID);
150		}
151
152	0	return privateParameters;
153		}
154		}