/
package-info.java
507 lines (507 loc) · 20.6 KB
/
package-info.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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Provides a framework for evaluating JEXL expressions.
* <ul>
* <li><a href="#intro">Introduction</a></li>
* <li><a href="#example">Brief Example</a></li>
* <li><a href="#usage">Using JEXL</a></li>
* <li><a href="#configuration">Configuring JEXL</a></li>
* <li><a href="#customization">Customizing JEXL</a></li>
* <li><a href="#extension">Extending JEXL</a></li>
* </ul>
* <h2><a id="intro">Introduction</a></h2>
* <p>
* JEXL is a library intended to facilitate the implementation of dynamic and scripting features in applications
* and frameworks.
* </p>
* <h2><a id="example">A Brief Example</a></h2>
* <p>
* In its simplest form, JEXL merges an
* {@link org.apache.commons.jexl3.JexlExpression}
* with a
* {@link org.apache.commons.jexl3.JexlContext} when evaluating expressions.
* An Expression is created using
* {@link org.apache.commons.jexl3.JexlEngine#createExpression(String)},
* passing a String containing valid JEXL syntax. A simple JexlContext can be created using
* a {@link org.apache.commons.jexl3.MapContext} instance;
* a map of variables that will be internally wrapped can be optionally provided through its constructor.
* The following example, takes a variable named 'car', and
* invokes the checkStatus() method on the property 'engine'
* </p>
* <pre>
* // Create a JexlEngine (could reuse one instead)
* JexlEngine jexl = new JexlBuilder().create();
* // Create an expression object equivalent to 'car.getEngine().checkStatus()':
* String jexlExp = "car.engine.checkStatus()";
* Expression e = jexl.createExpression( jexlExp );
* // The car we have to handle coming as an argument...
* Car car = theCarThatWeHandle;
* // Create a context and add data
* JexlContext jc = new MapContext();
* jc.set("car", car );
* // Now evaluate the expression, getting the result
* Object o = e.evaluate(jc);
* </pre>
* <h2><a id="usage">Using JEXL</a></h2>
* The API is composed of three levels addressing different functional needs:
* <ul>
* <li>Dynamic invocation of setters, getters, methods and constructors</li>
* <li>Script expressions known as JEXL expressions</li>
* <li>JSP/JSF like expression known as JXLT expressions</li>
* </ul>
* <h3><a id="usage_note">Important note</a></h3>
* The public API classes reside in the 2 packages:
* <ul>
* <li>org.apache.commons.jexl3</li>
* <li>org.apache.commons.jexl3.introspection</li>
* </ul>
* <p>
* The following packages follow a "use at your own maintenance cost" policy; these are only intended to be used
* for extending JEXL.
* Their classes and methods are not guaranteed to remain compatible in subsequent versions.
* If you think you need to use directly some of their features or methods, it might be a good idea to check with
* the community through the mailing list first.
* </p>
* <ul>
* <li>org.apache.commons.jexl3.parser</li>
* <li>org.apache.commons.jexl3.scripting</li>
* <li>org.apache.commons.jexl3.internal</li>
* <li>org.apache.commons.jexl3.internal.introspection</li>
* </ul>
* <h3><a id="usage_api">Dynamic Invocation</a></h3>
* <p>
* These functionalities are close to the core level utilities found in
* <a href="https://commons.apache.org/beanutils/">BeanUtils</a>.
* For basic dynamic property manipulations and method invocation, you can use the following
* set of methods:
* </p>
* <ul>
* <li>{@link org.apache.commons.jexl3.JexlEngine#newInstance}</li>
* <li>{@link org.apache.commons.jexl3.JexlEngine#setProperty}</li>
* <li>{@link org.apache.commons.jexl3.JexlEngine#getProperty}</li>
* <li>{@link org.apache.commons.jexl3.JexlEngine#invokeMethod}</li>
* </ul>
* The following example illustrate their usage:
* <pre>
* // test outer class
* public static class Froboz {
* int value;
* public Froboz(int v) { value = v; }
* public void setValue(int v) { value = v; }
* public int getValue() { return value; }
* }
* // test inner class
* public static class Quux {
* String str;
* Froboz froboz;
* public Quux(String str, int fro) {
* this.str = str;
* froboz = new Froboz(fro);
* }
* public Froboz getFroboz() { return froboz; }
* public void setFroboz(Froboz froboz) { this.froboz = froboz; }
* public String getStr() { return str; }
* public void setStr(String str) { this.str = str; }
* }
* // test API
* JexlEngine jexl = new JexlBuilder().create();
* Quux quux = jexl.newInstance(Quux.class, "xuuq", 100);
* jexl.setProperty(quux, "froboz.value", Integer.valueOf(100));
* Object o = jexl.getProperty(quux, "froboz.value");
* assertEquals("Result is not 100", new Integer(100), o);
* jexl.setProperty(quux, "['froboz'].value", Integer.valueOf(1000));
* o = jexl.getProperty(quux, "['froboz']['value']");
* assertEquals("Result is not 1000", new Integer(1000), o);
* </pre>
* <h3><a id="usage_jexl">Expressions and Scripts</a></h3>
* <p>
* If your needs require simple expression evaluation capabilities, the core JEXL features
* will most likely fit.
* The main methods are:
* </p>
* <ul>
* <li>{@link org.apache.commons.jexl3.JexlEngine#createScript}</li>
* <li>{@link org.apache.commons.jexl3.JexlScript#execute}</li>
* <li>{@link org.apache.commons.jexl3.JexlEngine#createExpression}</li>
* <li>{@link org.apache.commons.jexl3.JexlExpression#evaluate}</li>
* </ul>
* The following example illustrates their usage:
* <pre>
* JexlEngine jexl = new JexlBuilder().create();
* JexlContext jc = new MapContext();
* jc.set("quuxClass", quux.class);
* JexlExpression create = jexl.createExpression("quux = new(quuxClass, 'xuuq', 100)");
* JelxExpression assign = jexl.createExpression("quux.froboz.value = 10");
* JexlExpression check = jexl.createExpression("quux[\"froboz\"].value");
* Quux quux = (Quux) create.evaluate(jc);
* Object o = assign.evaluate(jc);
* assertEquals("Result is not 10", new Integer(10), o);
* o = check.evaluate(jc);
* assertEquals("Result is not 10", new Integer(10), o);
* </pre>
* <h3><a id="usage_ujexl">Unified Expressions and Templates</a></h3>
* <p>
* If you are looking for JSP-EL like and basic templating features, you can
* use Expression from a JxltEngine.
* </p>
* The main methods are:
* <ul>
* <li>{@link org.apache.commons.jexl3.JxltEngine#createExpression}</li>
* <li>{@link org.apache.commons.jexl3.JxltEngine.Expression#prepare}</li>
* <li>{@link org.apache.commons.jexl3.JxltEngine.Expression#evaluate}</li>
* <li>{@link org.apache.commons.jexl3.JxltEngine#createTemplate}</li>
* <li>{@link org.apache.commons.jexl3.JxltEngine.Template#prepare}</li>
* <li>{@link org.apache.commons.jexl3.JxltEngine.Template#evaluate}</li>
* </ul>
* The following example illustrates their usage:
* <pre>
* JexlEngine jexl = new JexlBuilder().create();
* JxltEngine jxlt = jexl.createJxltEngine();
* JxltEngine.Expression expr = jxlt.createExpression("Hello ${user}");
* String hello = expr.evaluate(context).toString();
* </pre>
* <h3>JexlExpression, JexlScript, Expression and Template: summary</h3>
* <h4>JexlExpression </h4>
* <p>
* These are the most basic form of JexlEngine expressions and only allow for a single command
* to be executed and its result returned. If you try to use multiple commands, it ignores
* everything after the first semi-colon and just returns the result from
* the first command.
* </p>
* <p>
* Also note that expressions are not statements (which is what scripts are made of) and do not allow
* using the flow control (if, while, for), variables or lambdas syntactic elements.
* </p>
* <h4>JexlScript</h4>
* <p>
* These allow you to use multiple statements and you can
* use variable assignments, loops, calculations, etc. More or less what can be achieved in Shell or
* JavaScript at its basic level. The result from the last command is returned from the script.
* </p>
* <h4>JxltEngine.Expression</h4>
* <p>
* These are ideal to produce "one-liner" text, like a 'toString()' on steroids.
* To get a calculation you use the EL-like syntax
* as in ${someVariable}. The expression that goes between the brackets
* behaves like a JexlScript, not an expression. You can use semi-colons to
* execute multiple commands and the result from the last command is
* returned from the script. You also have the ability to use a 2-pass evaluation using
* the #{someScript} syntax.
* </p>
* <h4>JxltEngine.Template</h4>
* <p>
* These produce text documents. Each line beginning with '$$' (as a default) is
* considered JEXL code and all others considered as JxltEngine.Expression.
* Think of those as simple Velocity templates. A rewritten MudStore initial Velocity sample looks like this:
* </p>
* <pre><code>
* <html>
* <body>
* Hello ${customer.name}!
* <table>
* $$ for(var mud : mudsOnSpecial ) {
* $$ if (customer.hasPurchased(mud) ) {
* <tr>
* <td>
* ${flogger.getPromo( mud )}
* </td>
* </tr>
* $$ }
* $$ }
* </table>
* </body>
* </html>
* </code></pre>
* <h2><a id="configuration">JEXL Configuration</a></h2>
* <p>
* The JexlEngine can be configured through a few parameters that will drive how it reacts
* in case of errors.
* These configuration methods are embedded through a {@link org.apache.commons.jexl3.JexlBuilder}.
* </p>
* <h3><a id="static_configuration">Static & Shared Configuration</a></h3>
* <p>
* Both JexlEngine and JxltEngine are thread-safe, most of their inner fields are final; the same instance can
* be shared between different threads and proper synchronization is enforced in critical areas (introspection caches).
* </p>
* <p>
* Of particular importance is {@link org.apache.commons.jexl3.JexlBuilder#loader(java.lang.ClassLoader)} which indicates
* to the JexlEngine being built which class loader to use to solve a class name;
* this directly affects how JexlEngine.newInstance and the 'new' script method operates.
* </p>
* <p>
* This can also be very useful in cases where you rely on JEXL to dynamically load and call plugins for your application.
* To avoid having to restart the server in case of a plugin implementation change, you can call
* {@link org.apache.commons.jexl3.JexlEngine#setClassLoader} and all the scripts created through this engine instance
* will automatically point to the newly loaded classes.
* </p>
* <p>
* You can state what can be manipulated through scripting by the {@link org.apache.commons.jexl3.annotations.NoJexl}
* annotation that completely shield classes and methods from JEXL introspection.
* The other configurable way to restrict JEXL is by using a
* {@link org.apache.commons.jexl3.introspection.JexlSandbox} which allows finer control over what is exposed; the sandbox
* can be set through {@link org.apache.commons.jexl3.JexlBuilder#sandbox(org.apache.commons.jexl3.introspection.JexlSandbox)}.
* </p>
* <p>
* {@link org.apache.commons.jexl3.JexlBuilder#namespaces} extends JEXL scripting by registering your own classes as
* namespaces allowing your own functions to be exposed at will.
* </p>
* This can be used as in:
* <pre><code>
* public static MyMath {
* public double cos(double x) {
* return Math.cos(x);
* }
* }
* Map<String, Object> funcs = new HashMap<String, Object>();
* funcs.put("math", new MyMath());
* JexlEngine jexl = new JexlBuilder().namespaces(funcs).create();
* JexlContext jc = new MapContext();
* jc.set("pi", Math.PI);
* JexlExpression e = JEXL.createExpression("math:cos(pi)");
* o = e.evaluate(jc);
* assertEquals(Double.valueOf(-1),o);
* </code></pre>
* <p>
* If the <i>namespace</i> is a Class and that class declares a constructor that takes a JexlContext (or
* a class extending JexlContext), one <i>namespace</i> instance is created on first usage in an
* expression; this instance lifetime is limited to the expression evaluation.
* </p>
* <p>
* JexlEngine and JxltEngine expression caches can be configured as well. If you intend to use JEXL
* repeatedly in your application, these are worth configuring since expression parsing is quite heavy.
* Note that all caches created by JEXL are held through SoftReference; under high memory pressure, the GC will be able
* to reclaim those caches and JEXL will rebuild them if needed. By default, a JexlEngine does create a cache for
* "small" expressions and a JxltEngine does create one for Expression .
* </p>
* <p>{@link org.apache.commons.jexl3.JexlBuilder#cache(int)} will set how many expressions can be simultaneously cached by the
* JEXL engine. JxltEngine allows to define the cache size through its constructor.
* </p>
* <p>
* {@link org.apache.commons.jexl3.JexlBuilder#debug(boolean)}
* makes stacktraces carried by JExlException more meaningful; in particular, these
* traces will carry the exact caller location the Expression was created from.
* </p>
* <h3><a id="dynamic_configuration">Dynamic Configuration</a></h3>
* <p>
* Those configuration options can be overridden during evaluation by implementing a
* {@link org.apache.commons.jexl3.JexlContext}
* that also implements {@link org.apache.commons.jexl3.JexlEngine.Options} to carry evaluation options.
* An example of such a class exists in the test package.
* </p>
* <p>
* {@link org.apache.commons.jexl3.JexlBuilder#strict} or {@link org.apache.commons.jexl3.JexlEngine.Options#isStrict}
* configures when JEXL considers 'null' as an error or not in various situations;
* when facing an unreferenceable variable, using null as an argument to an arithmetic operator or failing to call
* a method or constructor. The lenient mode is close to JEXL-1.1 behavior.
* </p>
* <p>
* {@link org.apache.commons.jexl3.JexlBuilder#silent} or {@link org.apache.commons.jexl3.JexlEngine.Options#isSilent}
* configures how JEXL reacts to errors; if silent, the engine will not throw exceptions
* but will warn through loggers and return null in case of errors. Note that when non-silent, JEXL throws
* JexlException which are unchecked exception.
* </p>
* <p>
* Implementing a {@link org.apache.commons.jexl3.JexlContext.NamespaceResolver} through a JexlContext - look at
* JexlEvalContext in the test directory
* as an example - allows to override the namespace resolution and the default namespace map defined
* through {@link org.apache.commons.jexl3.JexlBuilder#namespaces}.
* </p>
* <h2><a id="customization">JEXL Customization</a></h2>
* <p>
* The {@link org.apache.commons.jexl3.JexlContext}, {@link org.apache.commons.jexl3.JexlBuilder} and
* {@link org.apache.commons.jexl3.JexlEngine.Options} are
* the most likely interfaces you'll want to implement for customization. Since they expose variables and options,
* they are the primary targets. Before you do so, have a look at JexlEvalContext in the test directory
* and {@link org.apache.commons.jexl3.ObjectContext} which may already cover some of your needs.
* </p>
* <p>
* {@link org.apache.commons.jexl3.JexlArithmetic}
* is the class to derive if you need to change how operators behave or add types upon which they
* operate.
* There are 3 entry points that allow customizing the type of objects created:
* </p>
* <ul>
* <li>array literals: {@link org.apache.commons.jexl3.JexlArithmetic#arrayBuilder}</li>
* <li>map literals: {@link org.apache.commons.jexl3.JexlArithmetic#mapBuilder}</li>
* <li>set literals: {@link org.apache.commons.jexl3.JexlArithmetic#setBuilder}</li>
* <li>range objects: {@link org.apache.commons.jexl3.JexlArithmetic#createRange}</li>
* </ul>
* <p>
* You can also overload operator methods; by convention, each operator has a method name associated to it.
* If you overload some in your JexlArithmetic derived implementation, these methods will be called when the
* arguments match your method signature.
* For example, this would be the case if you wanted '+' to operate on arrays; you'd need to derive
* JexlArithmetic and implement 'public Object add(Set<?;> x, Set<?;> y)' method.
* Note however that you can <em>not</em> change the operator precedence.
* The list of operator / method matches is the following:
* </p>
* <table><caption>Operators</caption>
* <tr>
* <th>Operator</th>
* <th>Method Name</th>
* <th>Example</th>
* </tr>
* <tr>
* <td>+</td>
* <td>add</td>
* <td>add(x, y)</td>
* </tr>
* <tr>
* <td>-</td>
* <td>subtract</td>
* <td>subtract(x, y)</td>
* </tr>
* <tr>
* <td>*</td>
* <td>multiply</td>
* <td>multiply(x, y)</td>
* </tr>
* <tr>
* <td>/</td>
* <td>divide</td>
* <td>divide(x, y)</td>
* </tr>
* <tr>
* <td>%</td>
* <td>mod</td>
* <td>mod(x, y)</td>
* </tr>
* <tr>
* <td>&</td>
* <td>bitwiseAnd</td>
* <td>bitwiseAnd(x, y)</td>
* </tr>
* <tr>
* <td>|</td>
* <td>bitwiseOr</td>
* <td>bitwiseOr(x, y)</td>
* </tr>
* <tr>
* <td>^</td>
* <td>bitwiseXor</td>
* <td>bitwiseXor(x, y)</td>
* </tr>
* <tr>
* <td>!</td>
* <td>logicalNot</td>
* <td>logicalNot(x)</td>
* </tr>
* <tr>
* <td>-</td>
* <td>bitwiseComplement</td>
* <td>bitiwiseComplement(x)</td>
* </tr>
* <tr>
* <td>==</td>
* <td>equals</td>
* <td>equals(x, y)</td>
* </tr>
* <tr>
* <td><</td>
* <td>lessThan</td>
* <td>lessThan(x, y)</td>
* </tr>
* <tr>
* <td><=</td>
* <td>lessThanOrEqual</td>
* <td>lessThanOrEqual(x, y)</td>
* </tr>
* <tr>
* <td>></td>
* <td>greaterThan</td>
* <td>greaterThan(x, y)</td>
* </tr>
* <tr>
* <td>>=</td>
* <td>greaterThanOrEqual</td>
* <td>greaterThanOrEqual(x, y)</td>
* </tr>
* <tr>
* <td>-</td>
* <td>negate</td>
* <td>negate(x)</td>
* </tr>
* <tr>
* <td>size</td>
* <td>size</td>
* <td>size(x)</td>
* </tr>
* <tr>
* <td>empty</td>
* <td>empty</td>
* <td>empty(x)</td>
* </tr>
* </table>
* <p>
* You can also add methods to overload property getters and setters operators behaviors.
* Public methods of the JexlArithmetic instance named propertyGet/propertySet/arrayGet/arraySet are potential
* overrides that will be called when appropriate.
* The following table is an overview of the relation between a syntactic form and the method to call
* where V is the property value class, O the object class and P the property identifier class (usually String or Integer).
* </p>
* <table><caption>Property Accessors</caption>
* <tr>
* <th>Expression</th>
* <th>Method Template</th>
* </tr>
* <tr>
* <td>foo.property</td>
* <td>public V propertyGet(O obj, P property);</td>
* </tr>
* <tr>
* <td>foo.property = value</td>
* <td>public V propertySet(O obj, P property, V value);</td>
* </tr>
* <tr>
* <td>foo[property]</td>
* <td>public V arrayGet(O obj, P property, V value);</td>
* </tr>
* <tr>
* <td>foo[property] = value</td>
* <td>public V arraySet(O obj, P property, V value);</td>
* </tr>
* </table>
* <p>
* You can also override the base operator methods, those whose arguments are Object which gives you total
* control.
* </p>
* <h2><a id="extension">Extending JEXL</a></h2>
* If you need to make JEXL treat some objects in a specialized manner or tweak how it
* reacts to some settings, you can derive most of its inner-workings. The classes and methods are rarely private or
* final - only when the inner contract really requires it. However, using the protected methods
* and internal package classes imply you might have to re-adapt your code when new JEXL versions are released.
* <p>
* {@link org.apache.commons.jexl3.internal.Engine} can be
* extended to let you capture your own configuration defaults wrt cache sizes and various flags.
* Implementing your own cache - instead of the basic LinkedHashMap based one - would be
* another possible extension.
* </p>
* <p>
* {@link org.apache.commons.jexl3.internal.Interpreter}
* is the class to derive if you need to add more features to the evaluation
* itself; for instance, you want pre- and post- resolvers for variables or nested scopes for
* for variable contexts.
* </p>
* <p>
* {@link org.apache.commons.jexl3.internal.introspection.Uberspect}
* is the class to derive if you need to add introspection or reflection capabilities for some objects, for
* instance adding factory based support to the 'new' operator.
* The code already reflects public fields as properties on top of Java-beans conventions.
* </p>
*/
package org.apache.commons.jexl3;