| 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 | */
|
|---|
| 19 | package org.greenstone.gsdl3.util;
|
|---|
| 20 |
|
|---|
| 21 | import java.util.HashMap;
|
|---|
| 22 |
|
|---|
| 23 | /** keeps track of the interface parameters, and their defaults */
|
|---|
| 24 | public 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 HREF = "href"; // url. might be an external url, or a relative one that needs translating
|
|---|
| 43 | public static final String RELATIVE_LINK = "rl"; // whether the href url is relative to the collection or not.
|
|---|
| 44 | public static final String EXTERNAL_LINK_TYPE = "el"; // for an external link, go direct to the page or frame it in the collection
|
|---|
| 45 | public static final String PROCESS_ID = "pid"; // if a request wasn't completed, this identifies the request - used when asking for a status update
|
|---|
| 46 |
|
|---|
| 47 | public static final String HTTPHEADERFIELDS = "hhf";
|
|---|
| 48 |
|
|---|
| 49 | // internal configure args
|
|---|
| 50 | public static final String SYSTEM_SUBSET = "ss";
|
|---|
| 51 | public static final String SYSTEM_CLUSTER = "sc";
|
|---|
| 52 | public static final String SYSTEM_MODULE_NAME = "sn";
|
|---|
| 53 | public static final String SYSTEM_MODULE_TYPE = "st";
|
|---|
| 54 |
|
|---|
| 55 | // used for filtering out a piece of the final page
|
|---|
| 56 | public static final String EXCERPT_ID = "excerptid";
|
|---|
| 57 | public static final String EXCERPT_TAG = "excerpttag";
|
|---|
| 58 |
|
|---|
| 59 | public static final String INLINE_TEMPLATE = "ilt";
|
|---|
| 60 | public static final String DISPLAY_METADATA = "dmd";
|
|---|
| 61 | public static final String FILE_LOCATION = "fl";
|
|---|
| 62 |
|
|---|
| 63 | //Administration
|
|---|
| 64 | public static final String PASSWORD = "password";
|
|---|
| 65 | public static final String S_PASSWORD = "s1.password";
|
|---|
| 66 | public static final String S_NEW_PASSWORD = "s1.newPassword";
|
|---|
| 67 | public static final String S_OLD_PASSWORD = "s1.oldPassword";
|
|---|
| 68 |
|
|---|
| 69 | // some standard arg values
|
|---|
| 70 | public static final String SYSTEM_ACTION = "s";
|
|---|
| 71 |
|
|---|
| 72 | public static final String EXTERNAL_LINK_TYPE_DIRECT = "direct";
|
|---|
| 73 | public static final String EXTERNAL_LINK_TYPE_FRAMED = "frame";
|
|---|
| 74 |
|
|---|
| 75 | protected HashMap param_map = null;
|
|---|
| 76 |
|
|---|
| 77 | public GSParams()
|
|---|
| 78 | {
|
|---|
| 79 | this.param_map = new HashMap(30);
|
|---|
| 80 |
|
|---|
| 81 | // add in all the standard params
|
|---|
| 82 | addParameter(ACTION, false);
|
|---|
| 83 | addParameter(SUBACTION, false);
|
|---|
| 84 | addParameter(REQUEST_TYPE, false);
|
|---|
| 85 | addParameter(RESPONSE_ONLY, false);
|
|---|
| 86 | addParameter(CLUSTER, false); // we don't want to save cluster/collection
|
|---|
| 87 | addParameter(LANGUAGE, true);
|
|---|
| 88 | addParameter(DOCUMENT, true);
|
|---|
| 89 | addParameter(DOCUMENT_TYPE, true);
|
|---|
| 90 | // should the following two just be in doc action??
|
|---|
| 91 | addParameter(HREF, false);
|
|---|
| 92 | addParameter(RELATIVE_LINK, false);
|
|---|
| 93 | addParameter(OUTPUT, false);
|
|---|
| 94 | addParameter(SERVICE, false);
|
|---|
| 95 | addParameter(PROCESS_ID, true);
|
|---|
| 96 | addParameter(SYSTEM_SUBSET, false);
|
|---|
| 97 | addParameter(SYSTEM_CLUSTER, false);
|
|---|
| 98 | addParameter(SYSTEM_MODULE_NAME, false);
|
|---|
| 99 | addParameter(SYSTEM_MODULE_TYPE, false);
|
|---|
| 100 | addParameter(INLINE_TEMPLATE, false);
|
|---|
| 101 | addParameter(DISPLAY_METADATA, false);
|
|---|
| 102 | addParameter(PASSWORD, false);
|
|---|
| 103 | addParameter(S_PASSWORD, false);
|
|---|
| 104 | addParameter(S_NEW_PASSWORD, false);
|
|---|
| 105 | addParameter(S_OLD_PASSWORD, false);
|
|---|
| 106 |
|
|---|
| 107 | addParameter(COLLECTION_TYPE, true);
|
|---|
| 108 | addParameter(EXTERNAL_LINK_TYPE, false);
|
|---|
| 109 | // filtering args must be specified each time
|
|---|
| 110 | addParameter(EXCERPT_ID, false);
|
|---|
| 111 | addParameter(EXCERPT_TAG, false);
|
|---|
| 112 | }
|
|---|
| 113 |
|
|---|
| 114 | public boolean addParameter(String name, boolean save)
|
|---|
| 115 | {
|
|---|
| 116 | return addParameter(name, "", save);
|
|---|
| 117 | }
|
|---|
| 118 |
|
|---|
| 119 | public boolean addParameter(String name, String default_value, boolean save)
|
|---|
| 120 | {
|
|---|
| 121 | if (this.param_map.containsKey(name))
|
|---|
| 122 | {
|
|---|
| 123 | // already there so could not add
|
|---|
| 124 | return false;
|
|---|
| 125 | }
|
|---|
| 126 |
|
|---|
| 127 | this.param_map.put(name, new Param(default_value, save));
|
|---|
| 128 | return true;
|
|---|
| 129 | }
|
|---|
| 130 |
|
|---|
| 131 | public boolean setParamDefault(String name, String default_value)
|
|---|
| 132 | {
|
|---|
| 133 | Param p = (Param) this.param_map.get(name);
|
|---|
| 134 | if (p == null)
|
|---|
| 135 | return false;
|
|---|
| 136 | p.default_value = default_value;
|
|---|
| 137 | return true;
|
|---|
| 138 | }
|
|---|
| 139 |
|
|---|
| 140 | public boolean shouldSave(String name)
|
|---|
| 141 | {
|
|---|
| 142 | // p. is used to store previous settings
|
|---|
| 143 | if (name.startsWith("p."))
|
|---|
| 144 | return false;
|
|---|
| 145 | Param p = (Param) this.param_map.get(name);
|
|---|
| 146 | if (p == null)
|
|---|
| 147 | return true; // if things are not in here, always save.
|
|---|
| 148 | return p.save;
|
|---|
| 149 | }
|
|---|
| 150 |
|
|---|
| 151 | private class Param
|
|---|
| 152 | {
|
|---|
| 153 |
|
|---|
| 154 | public String default_value = null;
|
|---|
| 155 | public boolean save = true;
|
|---|
| 156 |
|
|---|
| 157 | public Param(String default_value, boolean save)
|
|---|
| 158 | {
|
|---|
| 159 | this.default_value = default_value;
|
|---|
| 160 | this.save = save;
|
|---|
| 161 | }
|
|---|
| 162 | }
|
|---|
| 163 | }
|
|---|
