Constants


1   /*
2    *  SSL-Explorer
3    *
4    *  Copyright (C) 2003-2006 3SP LTD. All Rights Reserved
5    *
6    *  This program is free software; you can redistribute it and/or
7    *  modify it under the terms of the GNU General Public License
8    *  as published by the Free Software Foundation; either version 2 of
9    *  the License, or (at your option) any later version.
10   *  This program is distributed in the hope that it will be useful,
11   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   *  GNU General Public License for more details.
14   *
15   *  You should have received a copy of the GNU General Public
16   *  License along with this program; if not, write to the Free Software
17   *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18   */
19              
20  package com.sslexplorer.security;
21  
22  import com.sslexplorer.extensions.ExtensionDescriptor;
23  import com.sslexplorer.navigation.actions.RedirectAction;
24  import com.sslexplorer.policyframework.LaunchSession;
25  import com.sslexplorer.policyframework.Resource;
26  import com.sslexplorer.policyframework.ResourceStack;
27  import com.sslexplorer.vfs.UploadManager;
28  
29  /**
30   * Strings contants used throughout SSL-Explorer.
31   *
32   * @author Lee David Painter
33   *
34   * Application constants.
35   */
36  public class Constants {
37  
38      /* Session attribute keys * */
39  
40      /**
41       * Key store store the sessions {@link UploadManager}.
42       */
43      public static final String   UPLOAD_MANAGER = "uploadManager";
44  
45      /**
46       * Key for session attribute that stores the currently pending VPN ticket.
47       * As soon as a VPN client uses the ticket for authorization a new ticket
48       * will be generated and placed in the session attributes ready for the
49       * next use.
50       */
51      public final static String   VPN_AUTHORIZATION_TICKET = "pendingVPNTicket";
52  
53      /**
54       * Key used to store the one use ticket for launching a web from the
55       * network places page.
56       */
57      public static final String   WEB_FOLDER_LAUNCH_TICKET = "webFolderLaunchTicket";
58  
59      /**
60       * Key used to store the referer which may be passed around actions
61       * under some circumstances.
62       */
63      public static final String   REFERER = "referer";
64  
65      /**
66       * Comment for <code>VPN_AUTOSTART</code>
67       */
68      public final static String   VPN_AUTOSTART = "autoStartVPN";
69  
70      /**
71       * Comment for <code>LOGON_INFO</code>
72       */
73      public static final String   LOGON_INFO = "logonInfo";
74  
75      /**
76       * Comment for <code>LOGON_TICKET</code>
77       */
78      public final static String   LOGON_TICKET = "logonTicket";
79  
80      public final static String   DOMAIN_LOGON_TICKET = "domainLogonTicket";
81  
82      public final static String   REQ_ATTR_AGENT_AUTHENTICATION_TICKET = "agentAuthenticationTicket";
83  
84      public final static String   REQ_ATTR_AGENT_EXTENSION = "agentExtension";
85  
86      /**
87       * Comment for <code>SELECTED_MENU</code>
88       */
89      public static final String   SELECTED_MENU = "selectedMenu";
90  
91      /**
92       * Comment for <code>AUTH_SENT</code>
93       */
94      public final static String   AUTH_SENT = "authSent";
95  
96      /**
97       * Comment for <code>USER</code>
98       */
99      public final static String   USER = "user";
100 
101     /**
102      * Comment for <code>SESSION_LOCKED</code>
103      */
104     public final static String   SESSION_LOCKED = "sessionLocked";
105 
106     /**
107      * Comment for <code>GLOBAL_WARNINGS</code>
108      */
109     public final static String   GLOBAL_WARNINGS = "globalWarnings";
110 
111     /**
112      * Comment for <code>GLOBAL_WARNINGS</code>
113      */
114     public final static String   SESSION_GLOBAL_WARNINGS = "sessionGlobalWarnings";
115 
116     /**
117      * Comment for <code>GLOBAL_WARNINGS_KEY</code>
118      */
119     public final static String   GLOBAL_WARNINGS_KEY = "com.sslexplorer.GLOBAL_WARNINGS";
120 
121     /**
122      * Comment for <code>BUNDLE_MESSAGES_KEY</code>
123      */
124     public final static String   BUNDLE_MESSAGES_KEY = "com.sslexplorer.BUNDLE_MESSAGES";
125 
126     /**
127      * Comment for <code>BUNDLE_ERRORS_KEY</code>
128      */
129     public final static String   BUNDLE_ERRORS_KEY = "com.sslexplorer.BUNDLE_ERRORS";
130 
131     /**
132      * Comment for <code>LOGOFF_HOOK</code>
133      */
134     public static final String   LOGOFF_HOOK = "logoffHook";
135 
136     /**
137      * Comment for <code>PROFILES</code>
138      */
139     public static final String   PROFILES = "profiles";
140 
141     /**
142      * Comment for <code>SELECTED_PROFILE</code>
143      */
144     public static final String   SELECTED_PROFILE = "selectedProfile";
145 
146     /**
147      * Comment for <code>ATTR_GET_HISTORY</code>
148      */
149     public static final String   ATTR_GET_HISTORY = "getHistory";
150 
151     /**
152      * Comment for <code>EXCEPTION</code>
153      */
154     public static final String   EXCEPTION = "exception";
155 
156     /**
157      * Comment for <code>ORIGINAL_REQUEST</code>
158      */
159     public static final String   ORIGINAL_REQUEST = "originalRequest";
160 
161     /**
162      * Comment for <code>SESSION_TIMEOUT_BLOCKS</code>
163      */
164     public static final String   SESSION_TIMEOUT_BLOCKS = "sessionTimeoutBlocks";
165 
166     /**
167      * Comment for <code>SCOPE_PERSONAL</code>
168      */
169     public static final String   SCOPE_PERSONAL = "personal";
170 
171     /**
172      * Comment for <code>CONTACTING_APPLICATION_STORE</code>
173      */
174     public static final String   CONTACTING_APPLICATION_STORE = "contactingApplicationStore";
175 
176     /**
177      * Comment for <code>SCOPE_GLOBAL</code>
178      */
179     public static final String   SCOPE_GLOBAL = "global";
180 
181     /**
182      * Comment for <code>FORCE_WEBDAV_METHOD</code>
183      */
184     public static final String   FORCE_WEBDAV_METHOD = "forceWebdavMethod"; // TODO
185                                                                           // horrid
186                                                                           // hack
187 
188     /**
189      * Comment for <code>SCOPE_SETUP</code>
190      */
191     public static final String   SCOPE_SETUP = "setup";
192 
193     /**
194      * Comment for <code>AGENT_SESSION_TIMEOUT_BLOCK_ID</code>
195      */
196     public static final String   AGENT_SESSION_TIMEOUT_BLOCK_ID = "vpnClientSessionTimeoutBlockId";
197 
198     /**
199      * Comment for <code>ATTR_CACHE</code>
200      */
201     public static final String   ATTR_CACHE = "sslexplorer.cache";
202 
203     /**
204      * Comment for <code>ATTR_COOKIE_MAP</code>
205      */
206     public static final String   ATTR_COOKIE_MAP = "sslexplorer.cookieMap";
207 
208     /**
209      * Comment for <code>AUTH_SESSION</code>
210      */
211     public static final String   AUTH_SESSION = "authSession";
212 
213     /**
214      * Comment for <code>SESSION_INFO</code>
215      */
216     public static final String   SESSION_INFO = "sessionInfo";
217 
218     /**
219      * Comment for <code>RESTARTING</code>
220      */
221     public static final String   RESTARTING = "restarting";
222 
223     /**
224      * Key used to store the current navigation menu tree  menu items.
225      */
226     public static final String   MENU_TREE = "menuTree";
227 
228     /**
229      * Key used to store any page task menu items available for this page
230      */
231     public static final String   PAGE_TASKS = "pageTasks";
232 
233     /**
234      * Key used to store any tool bar menu items available for this page
235      */
236     public static final String   TOOL_BAR_ITEMS = "toolBarItems";
237     
238     /**
239      * Key user to store the navigation bar menu items
240      */
241     public static final String   NAV_BAR = "navBar";
242 
243     /**
244      * Comment for <code>HOST</code>
245      */
246     public static final String   HOST = "host";
247 
248     /**
249      * Comment for <code>PASSWORD_CHANGE_REASON_MESSAGE</code>
250      */
251     public static final String   PASSWORD_CHANGE_REASON_MESSAGE = "passwordChangeReasonMessage";
252 
253     /**
254      * Comment for <code>PAGE_INTERCEPT_LISTENERS</code>
255      */
256     public static final String   PAGE_INTERCEPT_LISTENERS = "pageInterceptListeners";
257 
258     /**
259      * Comment for <code>PAGE_INTERCEPTED</code>
260      */
261     public static final String   PAGE_INTERCEPTED = "pageIntercepted";
262 
263     /**
264      * Comment for <code>SESSION_HOOK</code>
265      */
266     public static final String   SESSION_HOOK = "sessionHook";
267 
268     /**
269      * Comment for <code>LICENSE_AGREEMENTS</code>
270      */
271     public static final String   LICENSE_AGREEMENTS = "licenseAgreement";
272 
273     /**
274      * Comment for <code>PERSONAL_QUESTION</code>
275      */
276     public static final String   PERSONAL_QUESTION = "personalQuestion";
277 
278     /**
279      * Key used to access {@link com.sslexplorer.vfs.clipboard.Clipboard} 
280      * object used to move and copy files in the VFS
281      */
282     public static final String   CLIPBOARD = "clipboard";
283 
284     /**
285      * A user session may have a single wizard sequence active at any
286      * time. 
287      */
288     public static final String   WIZARD_SEQUENCE = "wizardSequence";
289 
290     /**
291      * A wizard may be suspended and returned to later. This key is 
292      * used to store the sequence object temporarily. 
293      */
294     public static final String   SUSPENDED_WIZARD_SEQUENCE = "suspendedWizardSequence";
295 
296     /**
297      * Each session may have a number of HTTP clients active (
298      * currently only used for reverse proxy).
299      */
300     public static final String   HTTP_CLIENTS = "httpClients";
301 
302     /**
303      * Holds any resources that may have been launched in the session. This
304      * is currently used by the reverse proxy handler to avoide having to lookup in the
305      * database for every request.
306      */
307     public static final String   LAUNCH_SESSIONS = "launchSessions";
308 
309     /**
310      * Attribute set on the session to indicate that the home page can be redirected
311      */
312     public static final String   REDIRECT_HOME = "redirectHomePage";
313 
314     /**
315      * Contacks the current stack of editing resources. See {@link ResourceStack}.
316      */
317     public static final String   EDITING_RESOURCE_STACK = "editingResourceStack";
318 
319     /**
320      * Used to pass arbitrary entities between a list type action to an
321      * edit type action
322      */
323     public static final String   EDITING_ITEM = "editingItem";
324     
325     /*
326      * Request attributes (generally passed from one action to another via a
327      * forward
328      */
329     
330     /**
331      * Stores a {@link LaunchSession} between requests
332      */
333     public static final String   REQ_ATTR_LAUNCH_SESSION = "launchSession";
334 
335     /**
336      * Stores the referering page when launching the VPN client. The browse will
337      * be directed back to this page when the client has launched.
338      */
339     public static final String   REQ_ATTR_LAUNCH_AGENT_REFERER = "launchAgentReferer";
340 
341     /**
342      * Stores the message resources key to display when the personal answers must
343      * be changed.
344      */
345     public static final String   REQ_ATTR_PERSONAL_ANSWERS_CHANGE_REASON_MESSAGE = "personalAnswersChangeReason";
346 
347     /**
348      * {@link com.sslexplorer.navigation.actions.HelpAction} stores this 
349      * attribute in the request. It contains the {@link com.sslexplorer.boot.PropertyDefinition}
350      * that help has been requsted for.
351      */
352     public static final String   REQ_ATTR_PROPERTY_DEFINITION = "propertyDefinition";
353 
354     /**
355      * Contains the current {@link com.sslexplorer.vfs.UploadDetails}  to be
356      * passed on to {@link com.sslexplorer.vfs.actions.ShowUploadAction}.
357      */
358     public static final String   REQ_ATTR_UPLOAD_DETAILS = "uploadDetails";
359 
360     /**
361      * This request attribute should be set to {@link Boolean#FALSE} if 
362      * you want to prevent the stream being gzipped by the compress filter.
363      */
364     public static final String   REQ_ATTR_COMPRESS = "compress";
365     
366     /**
367      * Pages may specify that the <i>Header</i> component of the layout be
368      * hidden when the page is displayed by setting the request attribute.
369      */
370     public static final String   REQ_ATTR_HIDE_HEADER = "layout.hideHeader";
371     
372     /**
373      * Pages may specify that the <i>Side Bar</i> component of the layout be
374      * hidden when the page is displayed by setting the request attribute.
375      */
376     public static final String   REQ_ATTR_HIDE_SIDE_BAR = "layout.hideSideBar";
377     
378     /**
379      * Key to store action messages for warnings
380      */
381     public static final String   REQ_ATTR_WARNINGS = "warnings";
382 
383     /**
384      * Full url used for {@link RedirectAction}.
385      */
386     public static final String   REQ_ATTR_FORWARD_TO = "url";
387     
388     /**
389      * Target used for {@link RedirectAction}.
390      */
391     public static final String   REQ_ATTR_TARGET = "target";
392     
393     /**
394      * Fragment of javascript to execute on load
395      */
396     public static final String   REQ_ATTR_EXEC_ON_LOAD = "execOnLoad";
397     
398     /**
399      * Folder used for {@link RedirectAction} (Web folders).
400      */
401     public static final String   REQ_ATTR_FOLDER = "folder";
402 
403     /**
404      * Stores the current action mapping object 
405      */
406     public static final String   REQ_ATTR_ACTION_MAPPING = "actionMapping";
407 
408     /**
409      * Stores the current actions form
410      */
411     public static final String   REQ_ATTR_FORM = "form";
412 
413     /**
414      * A {@link Resource} object should be stored under this attribute 
415      * in the request prior to a redirect to <i>resourceInformation</i>.
416      */
417     public static final String   REQ_ATTR_INFO_RESOURCE = "infoResource";
418 
419     /**
420      * This request attribute will contain {@link Boolean#TRUE} if the
421      * current page is in a popup window.
422      */
423     public static final String   REQ_ATTR_POPUP = "popup";
424     
425     /*
426      * Launch session attributes
427      */
428     
429     /**
430      * Stores {@link ExtensionDescriptor} to launch 
431      */
432     public static final String   LAUNCH_ATTR_AGENT_EXTENSION = "launchAgentExtensions";
433     
434     /**
435      * Stores URL to return to after launch 
436      */
437     public static final String   LAUNCH_ATTR_AGENT_RETURN_TO = "launchAgentReturnTo";
438 
439     /**
440      * Agent launch ticket
441      */
442     public static final String   LAUNCH_ATTR_AGENT_TICKET = "launchAgentTicket";
443 
444 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags