source: main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/GSParams.java@ 27087

Last change on this file since 27087 was 27087, checked in by ak19, 11 years ago

Implemented RSS support for GS3. At present, can see this with a=rss in the url, when a collection is built. Soon will have a button (at least for the GS3 demo collection).
  • Property svn:keywords set to Author Date Id Revision
File size: 6.6 KB
Line 
1/*
2 * GSParams.java
3 * Copyright (C) 2008 New Zealand Digital Library, http://www.nzdl.org
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
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 License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19package org.greenstone.gsdl3.util;
20
21import java.util.HashMap;
22
23/** keeps track of the servlet parameters, and their defaults */
24public class GSParams
25{
26
27 // cgi parameter names
28 public static final String ACTION = "a"; // the major type of action- eg query or browse or process
29 public static final String SUBACTION = "sa"; // subtype of action if we want different processing than the default
30 public static final String REQUEST_TYPE = "rt"; // whether the request is just to display the service form, or to actually do a request to the service
31 public static final String RESPONSE_ONLY = "ro"; // if == 1 do the request and pass back the response xml - no page formatting
32 public static final String OUTPUT = "o"; // if processing is to be done, what type of output - html/xml/other??
33 public static final String SERVICE = "s"; // the name of the service
34
35 public static final String CLUSTER = "c"; // these two are the same
36 public static final String COLLECTION = "c";
37 public static final String COLLECTION_TYPE = "ct"; // collection type - mg, mgpp, lucene etc
38
39 public static final String LANGUAGE = "l";
40 public static final String DOCUMENT = "d";
41 public static final String DOCUMENT_TYPE = "dt";
42 public static final String START_PAGE = "startPage";
43 public static final String S_START_PAGE = "s1.startPage";
44 public static final String HREF = "href"; // url. might be an external url, or a relative one that needs translating
45 public static final String RELATIVE_LINK = "rl"; // whether the href url is relative to the collection or not.
46 public static final String EXTERNAL_LINK_TYPE = "el"; // for an external link, go direct to the page or frame it in the collection
47 public static final String PROCESS_ID = "pid"; // if a request wasn't completed, this identifies the request - used when asking for a status update
48
49 public static final String HTTP_HEADER_FIELDS = "hhf";
50 public static final String QUICK_SEARCH = "qs";
51
52 // internal configure args
53 public static final String SYSTEM_SUBSET = "ss";
54 public static final String SYSTEM_CLUSTER = "sc";
55 public static final String SYSTEM_MODULE_NAME = "sn";
56 public static final String SYSTEM_MODULE_TYPE = "st";
57
58 // used for filtering out a piece of the final page
59 public static final String EXCERPT_ID = "excerptid";
60 public static final String EXCERPT_TAG = "excerpttag";
61
62 public static final String INLINE_TEMPLATE = "ilt";
63 public static final String DISPLAY_METADATA = "dmd";
64 public static final String FILE_LOCATION = "fl";
65 public static final String DOC_EDIT = "docEdit";
66 public static final String AJAX_LOAD_BYPASS = "alb";
67
68 //Administration
69 public static final String PASSWORD = "password";
70 public static final String S_PASSWORD = "s1.password";
71 public static final String S_NEW_PASSWORD = "s1.newPassword";
72 public static final String S_OLD_PASSWORD = "s1.oldPassword";
73
74 //Facets
75 public static final String S_FACETS = "s1.facets";
76 public static final String S_FACETS_QUERIES = "s1.facetQueries";
77
78 // some standard arg values
79 public static final String SYSTEM_ACTION = "s";
80
81 // rss feeds
82 public static final String RSS_ACTION = "rss";
83
84 public static final String EXTERNAL_LINK_TYPE_DIRECT = "direct";
85 public static final String EXTERNAL_LINK_TYPE_FRAMED = "frame";
86
87 public static final String DEBUG = "debug";
88
89 protected HashMap<String, Param> param_map = null;
90
91 public GSParams()
92 {
93 this.param_map = new HashMap<String, Param>(30);
94
95 // add in all the standard params
96 addParameter(ACTION, false);
97 addParameter(SUBACTION, false);
98 addParameter(REQUEST_TYPE, false);
99 addParameter(RESPONSE_ONLY, false);
100 addParameter(CLUSTER, false); // we don't want to save cluster/collection
101 addParameter(LANGUAGE, true);
102 addParameter(DOCUMENT, true);
103 addParameter(DOCUMENT_TYPE, false);
104 addParameter(QUICK_SEARCH, false);
105 addParameter(START_PAGE, false);
106 addParameter(S_START_PAGE, false);
107 // should the following two just be in doc action??
108 addParameter(HREF, false);
109 addParameter(RELATIVE_LINK, false);
110 addParameter(OUTPUT, false);
111 addParameter(SERVICE, false);
112 addParameter(PROCESS_ID, true);
113 addParameter(SYSTEM_SUBSET, false);
114 addParameter(SYSTEM_CLUSTER, false);
115 addParameter(SYSTEM_MODULE_NAME, false);
116 addParameter(SYSTEM_MODULE_TYPE, false);
117 addParameter(INLINE_TEMPLATE, false);
118 addParameter(DISPLAY_METADATA, false);
119 addParameter(AJAX_LOAD_BYPASS, false);
120 addParameter(DOC_EDIT, false);
121 addParameter(PASSWORD, false);
122 addParameter(S_PASSWORD, false);
123 addParameter(S_NEW_PASSWORD, false);
124 addParameter(S_OLD_PASSWORD, false);
125
126 addParameter(S_FACETS, false);
127 addParameter(S_FACETS_QUERIES, false);
128
129 addParameter(COLLECTION_TYPE, true);
130 addParameter(EXTERNAL_LINK_TYPE, false);
131 // filtering args must be specified each time
132 addParameter(EXCERPT_ID, false);
133 addParameter(EXCERPT_TAG, false);
134
135 addParameter(DEBUG, true);
136 }
137
138 public boolean addParameter(String name, boolean save)
139 {
140 return addParameter(name, "", save);
141 }
142
143 public boolean addParameter(String name, String default_value, boolean save)
144 {
145 if (this.param_map.containsKey(name))
146 {
147 // already there so could not add
148 return false;
149 }
150
151 this.param_map.put(name, new Param(default_value, save));
152 return true;
153 }
154
155 public boolean setParamDefault(String name, String default_value)
156 {
157 Param p = this.param_map.get(name);
158 if (p == null)
159 return false;
160 p.default_value = default_value;
161 return true;
162 }
163
164 public boolean shouldSave(String name)
165 {
166 // p. is used to store previous settings
167 if (name.startsWith("p."))
168 return false;
169 Param p = this.param_map.get(name);
170 if (p == null)
171 return true; // if things are not in here, always save.
172 return p.save;
173 }
174
175 private class Param
176 {
177
178 public String default_value = null;
179 public boolean save = true;
180
181 public Param(String default_value, boolean save)
182 {
183 this.default_value = default_value;
184 this.save = save;
185 }
186 }
187}
Note: See TracBrowser for help on using the repository browser.