/
GadgetHandlers.java
243 lines (220 loc) · 9.53 KB
/
GadgetHandlers.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.admingui.common.gadget;
import com.sun.jsftemplating.annotation.Handler;
import com.sun.jsftemplating.annotation.HandlerInput;
import com.sun.jsftemplating.annotation.HandlerOutput;
import com.sun.jsftemplating.layout.LayoutDefinitionManager;
import com.sun.jsftemplating.layout.descriptors.handler.HandlerContext;
import com.sun.jsftemplating.layout.descriptors.handler.HandlerDefinition;
import com.sun.jsftemplating.layout.descriptors.handler.OutputTypeManager;
import com.sun.jsftemplating.util.FileUtil;
import java.io.UnsupportedEncodingException;
import java.net.URL;
import java.net.URLDecoder;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.StringTokenizer;
import org.glassfish.admingui.common.util.GuiUtil;
import org.glassfish.admingui.common.util.JSONUtil;
import org.glassfish.admingui.connector.GadgetModule;
import org.jvnet.hk2.config.ConfigParser;
import org.jvnet.hk2.config.DomDocument;
/**
* <p>This class provides access to {@link GadgetModule}s. It also has a
* nice JSON utility for converting JavaBean Objects (and primitives,
* Collections, Maps, Strings, etc.) to JSON.</p>
*
* @author Ken Paulsen (ken.paulsen@sun.com)
*/
public class GadgetHandlers {
/**
* <p> Default constructor.</p>
*/
public GadgetHandlers() {
}
/**
* <p> This handler returns a {@link GadgetModule} for the named
* gadget. The <code>name</code> should either be a complete URL,
* or a context-root relative path to the gadget XML file (this
* also includes .xml files stored in .jar's / plugins).</p>
*/
@Handler(id="gf.getGadgetModule",
input = {
@HandlerInput(name="name", type=String.class, required=true)
},
output = {
@HandlerOutput(name="module", type=GadgetModule.class)
})
public static void getGadgetModule(HandlerContext handlerCtx) {
String gadgetName = (String) handlerCtx.getInputValue("name");
URL url = null;
try {
if (!gadgetName.contains("://")) {
// Treat as a path...
url = FileUtil.searchForFile(gadgetName, null);
}
if (url == null) {
url = new URL(gadgetName);
}
} catch (Exception ex) {
throw new IllegalArgumentException("Cannot creaqte URL from '"
+ gadgetName + "'!", ex);
}
GadgetModule module = getGadgetModule(url);
handlerCtx.setOutputValue("module", module);
}
/**
* <p> This method returns a {@link GadgetModule} for the given URL.</p>
*/
public static GadgetModule getGadgetModule(URL url) {
if (url == null) {
return null;
}
// FIXME: Cache?
// Get our parser...
ConfigParser parser = new ConfigParser(GuiUtil.getHabitat());
// Read the document...
DomDocument doc = parser.parse(url);
// Get the GadgetModule
GadgetModule module = (GadgetModule) doc.getRoot().get();
return module;
}
/**
* <p> This handler will invoke another handler. This allows a generic
* handler to invoke another one and return the response(s), if
* any.</p>
*
* <p> The following are the inputs are supported:</p>
* <ul><li><b>handler</b> - (required) This input specifies the
* handler which should be invoked.</li>
* <li><b>args</b> - (required) This specifies all of the
* arguments to be passed to the handler (both input and
* output arguments). The value of this should be a String
* formatted as a comma separated list of name-value pairs
* (which are themselves separated by colons (:). The value
* of the name-value pairs should be URL encoded (so that
* commas are escaped).</li>
* <li><b>depth</b> - (optional) This property specifies the max
* depth of nesting for any output values from the handler.
* Output values are encoded in JSON. This prevents infinite
* looping in the case where an Object refers to itself (or in
* the case wehre there is unnecessarily deep data
* structures).</li></ul>
*/
@Handler(id="gf.invokeHandler",
input = {
@HandlerInput(name="handler", type=String.class, required=true),
@HandlerInput(name="args", type=String.class, required=true),
@HandlerInput(name="depth", type=Integer.class, required=false)
},
output = {
@HandlerOutput(name="values", type=String.class)
})
public static Object invokeHandler(HandlerContext handlerCtx) {
// First find the HandlerDefinition
String handlerName = (String) handlerCtx.getInputValue("handler");
HandlerDefinition handlerDef = LayoutDefinitionManager.getGlobalHandlerDefinition(handlerName);
if (handlerDef == null) {
throw new IllegalArgumentException("Handler '" + handlerName
+ "' not found!");
}
// Before working with the new Handler, save the old Handler...
com.sun.jsftemplating.layout.descriptors.handler.Handler oldHandler =
handlerCtx.getHandler();
// Create the Handler to invoke...
com.sun.jsftemplating.layout.descriptors.handler.Handler handler =
new com.sun.jsftemplating.layout.descriptors.handler.Handler(handlerDef);
// Now try to get the inputs / outputs
List<String> outputNames = new ArrayList<String>();
String args = (String) handlerCtx.getInputValue("args");
StringTokenizer tok = new StringTokenizer(args, ",");
String nvp, name, value;
Object val = null;
int colon;
while (tok.hasMoreTokens()) {
// Get the NVP...
nvp = tok.nextToken();
colon = nvp.indexOf(':');
if (colon == -1) {
throw new IllegalArgumentException(
"Handler I/O name:value must be separated by a ':'!");
}
name = nvp.substring(0, colon).trim();
value = nvp.substring(colon+1).trim();
// URL decode 'value'...
try {
value = URLDecoder.decode(value, "UTF-8");
} catch (UnsupportedEncodingException ex) {
throw new IllegalArgumentException(
"Unable to decode value, this is not normal!", ex);
}
// See if it is an input...
if (handlerDef.getInputDef(name) != null) {
// It's an input...
if (value.startsWith("{") && value.endsWith("}")) {
Object t = parseString(value.substring(1, (value.length()) - 1));
val = t;
} else {
val = value;
}
handler.setInputValue(name, val);
} else {
// Assume it's an output mapping...
handler.setOutputMapping(name, val.toString(), OutputTypeManager.EL_TYPE);
outputNames.add(name);
}
}
// We have the new handler (yea!), invoke it...
List<com.sun.jsftemplating.layout.descriptors.handler.Handler> handlers =
new ArrayList<com.sun.jsftemplating.layout.descriptors.handler.Handler>(1);
handlers.add(handler);
Object result = handlerCtx.getLayoutElement().
dispatchHandlers(handlerCtx, handlers);
// Now... lets get the output values from the "child" handler...
Map<String, Object> outputValues = new HashMap<String, Object>();
String outName;
Iterator<String> it = outputNames.iterator();
while (it.hasNext()) {
// For each output specified, save it in a Map to be encoded later
outName = it.next();
outputValues.put(outName, handler.getOutputValue(handlerCtx, outName));
}
// Now we're done with the "child" Handler, restore this Handler...
handlerCtx.setHandler(oldHandler);
// Finally, translate the Map to JSON and set the String as an output
Integer depth = (Integer) handlerCtx.getInputValue("depth");
if (depth == null) {
depth = 10;
}
handlerCtx.setOutputValue("values", JSONUtil.javaToJSON(outputValues, depth));
return result;
}
public static Object parseString(String test) {
Map newMap = new HashMap();
String[] strs = test.split(",");
for (String str : strs) {
str = str.trim();
int end = str.length();
int index = str.indexOf("=");
newMap.put(str.substring(0, index), str.substring(index+1, end));
}
return newMap;
}
}