-
Notifications
You must be signed in to change notification settings - Fork 49
/
BeanELResolver.java
625 lines (562 loc) · 26.8 KB
/
BeanELResolver.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
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
/*
* Copyright (c) 1997, 2021 Oracle and/or its affiliates and others.
* All rights reserved.
* Copyright 2004 The Apache Software Foundation
*
* Licensed 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.
*/
package jakarta.el;
import static java.lang.Boolean.TRUE;
import static jakarta.el.ELUtil.getExceptionMessageString;
import java.beans.BeanInfo;
import java.beans.FeatureDescriptor;
import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.lang.ref.ReferenceQueue;
import java.lang.ref.SoftReference;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
* Defines property resolution behavior on objects using the JavaBeans component architecture.
*
* <p>
* This resolver handles base objects of any type, as long as the base is not <code>null</code>. It accepts any object
* as a property or method, and coerces it to a string.
*
* <p>
* For property resolution, the property string is used to find a JavaBeans compliant property on the base object. The
* value is accessed using JavaBeans getters and setters.
* </p>
*
* <p>
* For method resolution, the method string is the name of the method in the bean. The parameter types can be optionally
* specified to identify the method. If the parameter types are not specified, the parameter objects are used in the
* method resolution.
* </p>
*
* <p>
* The JavaBeans specification predates the introduction of default method implementations defined on an interface. In
* addition to the JavaBeans specification requirements for looking up property getters, property setters and methods,
* this resolver also considers default methods and includes them in the results.
* </p>
*
* <p>
* This resolver can be constructed in read-only mode, which means that {@link #isReadOnly} will always return
* <code>true</code> and {@link #setValue} will always throw <code>PropertyNotWritableException</code>.
* </p>
*
* <p>
* <code>ELResolver</code>s are combined together using {@link CompositeELResolver}s, to define rich semantics for
* evaluating an expression. See the javadocs for {@link ELResolver} for details.
* </p>
*
* <p>
* Because this resolver handles base objects of any type, it should be placed near the end of a composite resolver.
* Otherwise, it will claim to have resolved a property before any resolvers that come after it get a chance to test if
* they can do so as well.
* </p>
*
* @see CompositeELResolver
* @see ELResolver
*
* @since Jakarta Server Pages 2.1
*/
public class BeanELResolver extends ELResolver {
static private class BPSoftReference extends SoftReference<BeanProperties> {
final Class<?> key;
BPSoftReference(Class<?> key, BeanProperties beanProperties, ReferenceQueue<BeanProperties> refQ) {
super(beanProperties, refQ);
this.key = key;
}
}
static private class SoftConcurrentHashMap extends ConcurrentHashMap<Class<?>, BeanProperties> {
private static final long serialVersionUID = -178867497897782229L;
private static final int CACHE_INIT_SIZE = 1024;
private ConcurrentHashMap<Class<?>, BPSoftReference> map = new ConcurrentHashMap<>(CACHE_INIT_SIZE);
private ReferenceQueue<BeanProperties> refQ = new ReferenceQueue<>();
// Remove map entries that have been placed on the queue by GC.
private void cleanup() {
BPSoftReference BPRef = null;
while ((BPRef = (BPSoftReference) refQ.poll()) != null) {
map.remove(BPRef.key);
}
}
@Override
public BeanProperties put(Class<?> key, BeanProperties value) {
cleanup();
BPSoftReference prev = map.put(key, new BPSoftReference(key, value, refQ));
return prev == null ? null : prev.get();
}
@Override
public BeanProperties putIfAbsent(Class<?> key, BeanProperties value) {
cleanup();
BPSoftReference prev = map.putIfAbsent(key, new BPSoftReference(key, value, refQ));
return prev == null ? null : prev.get();
}
@Override
public BeanProperties get(Object key) {
cleanup();
BPSoftReference BPRef = map.get(key);
if (BPRef == null) {
return null;
}
if (BPRef.get() == null) {
// value has been garbage collected, remove entry in map
map.remove(key);
return null;
}
return BPRef.get();
}
}
private boolean isReadOnly;
private final SoftConcurrentHashMap properties = new SoftConcurrentHashMap();
/*
* Defines a property for a bean.
*/
final static class BeanProperty {
private Method readMethod;
private Method writeMethod;
private PropertyDescriptor descriptor;
public BeanProperty(Class<?> baseClass, PropertyDescriptor descriptor) {
this.descriptor = descriptor;
readMethod = ELUtil.getMethod(baseClass, descriptor.getReadMethod());
writeMethod = ELUtil.getMethod(baseClass, descriptor.getWriteMethod());
}
public Class<?> getPropertyType() {
return descriptor.getPropertyType();
}
public boolean isReadOnly() {
return getWriteMethod() == null;
}
public Method getReadMethod() {
return readMethod;
}
public Method getWriteMethod() {
return writeMethod;
}
}
/*
* Defines the properties for a bean.
*/
final static class BeanProperties {
private final Map<String, BeanProperty> propertyMap = new HashMap<>();
public BeanProperties(Class<?> baseClass) {
PropertyDescriptor[] descriptors;
try {
BeanInfo info = Introspector.getBeanInfo(baseClass);
descriptors = info.getPropertyDescriptors();
for (PropertyDescriptor descriptor : descriptors) {
propertyMap.put(descriptor.getName(), new BeanProperty(baseClass, descriptor));
}
/**
* Populating from any interfaces solves two distinct problems:
* 1. When running under a security manager, classes may be
* unaccessible but have accessible interfaces.
* 2. It enables default methods to be included.
*/
populateFromInterfaces(baseClass, baseClass);
} catch (IntrospectionException ie) {
throw new ELException(ie);
}
}
private void populateFromInterfaces(Class<?> baseClass, Class<?> aClass) throws IntrospectionException {
Class<?> interfaces[] = aClass.getInterfaces();
if (interfaces.length > 0) {
for (Class<?> ifs : interfaces) {
BeanInfo info = Introspector.getBeanInfo(ifs);
PropertyDescriptor[] pds = info.getPropertyDescriptors();
for (PropertyDescriptor pd : pds) {
if (!this.propertyMap.containsKey(pd.getName())) {
this.propertyMap.put(pd.getName(), new BeanProperty(
baseClass, pd));
}
}
}
}
Class<?> superclass = aClass.getSuperclass();
if (superclass != null) {
populateFromInterfaces(baseClass, superclass);
}
}
public BeanProperty getBeanProperty(String property) {
return propertyMap.get(property);
}
}
/**
* Creates a new read/write <code>BeanELResolver</code>.
*/
public BeanELResolver() {
this.isReadOnly = false;
}
/**
* Creates a new <code>BeanELResolver</code> whose read-only status is determined by the given parameter.
*
* @param isReadOnly <code>true</code> if this resolver cannot modify beans; <code>false</code> otherwise.
*/
public BeanELResolver(boolean isReadOnly) {
this.isReadOnly = isReadOnly;
}
/**
* If the base object is not <code>null</code>, returns the most general acceptable type that can be set on this bean
* property.
*
* <p>
* If the base is not <code>null</code>, the <code>propertyResolved</code> property of the <code>ELContext</code> object
* must be set to <code>true</code> by this resolver, before returning. If this property is not <code>true</code> after
* this method is called, the caller should ignore the return value.
* </p>
*
* <p>
* The provided property will first be coerced to a <code>String</code>. If there is a <code>BeanInfoProperty</code>
* for this property, there were no errors retrieving it and neither the property nor the resolver are read-only,
* the <code>propertyType</code> of the <code>propertyDescriptor</code> is returned. If the property is resolved but
* either the property or the resolver is read-only then {@code null} will be returned. Otherwise, a
* <code>PropertyNotFoundException</code> is thrown.
* </p>
*
* @param context The context of this evaluation.
* @param base The bean to analyze.
* @param property The name of the property to analyze. Will be coerced to a <code>String</code>.
* @return If the <code>propertyResolved</code> property of <code>ELContext</code> was set to <code>true</code>, then
* the most general acceptable type which must be {@code null} if the either the property or the resolver is
* read-only; otherwise undefined
* @throws NullPointerException if context is <code>null</code>
* @throws PropertyNotFoundException if <code>base</code> is not <code>null</code> and the specified property does not
* exist or is not readable.
* @throws ELException if an exception was thrown while performing the property or variable resolution. The thrown
* exception must be included as the cause property of this exception, if available.
*/
@Override
public Class<?> getType(ELContext context, Object base, Object property) {
if (context == null) {
throw new NullPointerException();
}
if (base == null || property == null) {
return null;
}
BeanProperty beanProperty = getBeanProperty(context, base, property);
context.setPropertyResolved(true);
if (isReadOnly || beanProperty.isReadOnly()) {
return null;
}
return beanProperty.getPropertyType();
}
/**
* If the base object is not <code>null</code>, returns the current value of the given property on this bean.
*
* <p>
* If the base is not <code>null</code>, the <code>propertyResolved</code> property of the <code>ELContext</code> object
* must be set to <code>true</code> by this resolver, before returning. If this property is not <code>true</code> after
* this method is called, the caller should ignore the return value.
* </p>
*
* <p>
* The provided property name will first be coerced to a <code>String</code>. If the property is a readable property of
* the base object, as per the JavaBeans specification, then return the result of the getter call. If the getter throws
* an exception, it is propagated to the caller. If the property is not found or is not readable, a
* <code>PropertyNotFoundException</code> is thrown.
* </p>
*
* @param context The context of this evaluation.
* @param base The bean on which to get the property.
* @param property The name of the property to get. Will be coerced to a <code>String</code>.
* @return If the <code>propertyResolved</code> property of <code>ELContext</code> was set to <code>true</code>, then
* the value of the given property. Otherwise, undefined.
* @throws NullPointerException if context is <code>null</code>.
* @throws PropertyNotFoundException if <code>base</code> is not <code>null</code> and the specified property does not
* exist or is not readable.
* @throws ELException if an exception was thrown while performing the property or variable resolution. The thrown
* exception must be included as the cause property of this exception, if available.
*/
@Override
public Object getValue(ELContext context, Object base, Object property) {
if (context == null) {
throw new NullPointerException();
}
if (base == null || property == null) {
return null;
}
Method method = getBeanProperty(context, base, property).getReadMethod();
if (method == null) {
throw new PropertyNotFoundException(
getExceptionMessageString(context, "propertyNotReadable", new Object[] { base.getClass().getName(), property.toString() }));
}
Object value;
try {
value = method.invoke(base, new Object[0]);
context.setPropertyResolved(base, property);
} catch (ELException ex) {
throw ex;
} catch (InvocationTargetException ite) {
throw new ELException(ite.getCause());
} catch (Exception ex) {
throw new ELException(ex);
}
return value;
}
/**
* If the base object is not <code>null</code>, attempts to set the value of the given property on this bean.
*
* <p>
* If the base is not <code>null</code>, the <code>propertyResolved</code> property of the <code>ELContext</code> object
* must be set to <code>true</code> by this resolver, before returning. If this property is not <code>true</code> after
* this method is called, the caller can safely assume no value was set.
* </p>
*
* <p>
* If this resolver was constructed in read-only mode, this method will always throw
* <code>PropertyNotWritableException</code>.
* </p>
*
* <p>
* The provided property name will first be coerced to a <code>String</code>. If property is a writable property of
* <code>base</code> (as per the JavaBeans Specification), the setter method is called (passing <code>value</code>). If
* the property exists but does not have a setter, then a <code>PropertyNotFoundException</code> is thrown. If the
* property does not exist, a <code>PropertyNotFoundException</code> is thrown.
* </p>
*
* @param context The context of this evaluation.
* @param base The bean on which to set the property.
* @param property The name of the property to set. Will be coerced to a <code>String</code>.
* @param val The value to be associated with the specified key.
* @throws NullPointerException if context is <code>null</code>.
* @throws PropertyNotFoundException if <code>base</code> is not <code>null</code> and the specified property does not
* exist.
* @throws PropertyNotWritableException if this resolver was constructed in read-only mode, or if there is no setter for
* the property.
* @throws ELException if an exception was thrown while performing the property or variable resolution. The thrown
* exception must be included as the cause property of this exception, if available.
*/
@Override
public void setValue(ELContext context, Object base, Object property, Object val) {
if (context == null) {
throw new NullPointerException();
}
if (base == null || property == null) {
return;
}
if (isReadOnly) {
throw new PropertyNotWritableException(getExceptionMessageString(context, "resolverNotwritable", new Object[] { base.getClass().getName() }));
}
Method method = getBeanProperty(context, base, property).getWriteMethod();
if (method == null) {
throw new PropertyNotWritableException(
getExceptionMessageString(context, "propertyNotWritable", new Object[] { base.getClass().getName(), property.toString() }));
}
try {
method.invoke(base, new Object[] { val });
context.setPropertyResolved(base, property);
} catch (ELException ex) {
throw ex;
} catch (InvocationTargetException ite) {
throw new ELException(ite.getCause());
} catch (Exception ex) {
if (null == val) {
val = "null";
}
String message = getExceptionMessageString(context, "setPropertyFailed", new Object[] { property.toString(), base.getClass().getName(), val });
throw new ELException(message, ex);
}
}
/**
* If the base object is not <code>null</code>, invoke the method, with the given parameters on this bean. The return
* value from the method is returned.
*
* <p>
* If the base is not <code>null</code>, the <code>propertyResolved</code> property of the <code>ELContext</code> object
* must be set to <code>true</code> by this resolver, before returning. If this property is not <code>true</code> after
* this method is called, the caller should ignore the return value.
* </p>
*
* <p>
* The provided method object will first be coerced to a <code>String</code>. The methods in the bean is then examined
* and an attempt will be made to select one for invocation. If no suitable can be found, a
* <code>MethodNotFoundException</code> is thrown.
*
* If the given paramTypes is not <code>null</code>, select the method with the given name and parameter types.
*
* Else select the method with the given name that has the same number of parameters. If there are more than one such
* method, the method selection process is undefined.
*
* Else select the method with the given name that takes a variable number of arguments.
*
* Note the resolution for overloaded methods will likely be clarified in a future version of the spec.
*
* The provide parameters are coerced to the corresponding parameter types of the method, and the method is then
* invoked.
*
* @param context The context of this evaluation.
* @param base The bean on which to invoke the method
* @param methodName The simple name of the method to invoke. Will be coerced to a <code>String</code>. If method is
* "<init>"or "<clinit>" a MethodNotFoundException is thrown.
* @param paramTypes An array of Class objects identifying the method's formal parameter types, in declared order. Use
* an empty array if the method has no parameters. Can be <code>null</code>, in which case the method's formal parameter
* types are assumed to be unknown.
* @param params The parameters to pass to the method, or <code>null</code> if no parameters.
* @return The result of the method invocation (<code>null</code> if the method has a <code>void</code> return type).
* @throws MethodNotFoundException if no suitable method can be found.
* @throws ELException if an exception was thrown while performing (base, method) resolution. The thrown exception must
* be included as the cause property of this exception, if available. If the exception thrown is an
* <code>InvocationTargetException</code>, extract its <code>cause</code> and pass it to the <code>ELException</code>
* constructor.
* @since Jakarta Expression Language 2.2
*/
@Override
public Object invoke(ELContext context, Object base, Object methodName, Class<?>[] paramTypes, Object[] params) {
if (base == null || methodName == null) {
return null;
}
Method method = ELUtil.findMethod(base.getClass(), methodName.toString(), paramTypes, params, false);
for (Object param : params) {
// If the parameters is a LambdaExpression, set the ELContext
// for its evaluation
if (param instanceof LambdaExpression) {
((LambdaExpression) param).setELContext(context);
}
}
Object ret = ELUtil.invokeMethod(context, method, base, params);
context.setPropertyResolved(base, methodName);
return ret;
}
/**
* If the base object is not <code>null</code>, returns whether a call to {@link #setValue} will always fail.
*
* <p>
* If the base is not <code>null</code>, the <code>propertyResolved</code> property of the <code>ELContext</code> object
* must be set to <code>true</code> by this resolver, before returning. If this property is not <code>true</code> after
* this method is called, the caller can safely assume no value was set.
* </p>
*
* <p>
* If this resolver was constructed in read-only mode, this method will always return <code>true</code>.
* </p>
*
* <p>
* The provided property name will first be coerced to a <code>String</code>. If property is a writable property of
* <code>base</code>, <code>false</code> is returned. If the property is found but is not writable, <code>true</code> is
* returned. If the property is not found, a <code>PropertyNotFoundException</code> is thrown.
* </p>
*
* @param context The context of this evaluation.
* @param base The bean to analyze.
* @param property The name of the property to analyzed. Will be coerced to a <code>String</code>.
* @return If the <code>propertyResolved</code> property of <code>ELContext</code> was set to <code>true</code>, then
* <code>true</code> if calling the <code>setValue</code> method will always fail or <code>false</code> if it is
* possible that such a call may succeed; otherwise undefined.
* @throws NullPointerException if context is <code>null</code>
* @throws PropertyNotFoundException if <code>base</code> is not <code>null</code> and the specified property does not
* exist.
* @throws ELException if an exception was thrown while performing the property or variable resolution. The thrown
* exception must be included as the cause property of this exception, if available.
*/
@Override
public boolean isReadOnly(ELContext context, Object base, Object property) {
if (context == null) {
throw new NullPointerException();
}
if (base == null || property == null) {
return false;
}
context.setPropertyResolved(true);
if (isReadOnly) {
return true;
}
return getBeanProperty(context, base, property).isReadOnly();
}
/**
* If the base object is not <code>null</code>, returns an <code>Iterator</code> containing the set of JavaBeans
* properties available on the given object. Otherwise, returns <code>null</code>.
*
* <p>
* The <code>Iterator</code> returned must contain zero or more instances of {@link java.beans.FeatureDescriptor}. Each
* info object contains information about a property in the bean, as obtained by calling the
* <code>BeanInfo.getPropertyDescriptors</code> method. The <code>FeatureDescriptor</code> is initialized using the same
* fields as are present in the <code>PropertyDescriptor</code>, with the additional required named attributes
* "<code>type</code>" and "<code>resolvableAtDesignTime</code>" set as follows:
* <ul>
* <li>{@link ELResolver#TYPE} - The runtime type of the property, from
* <code>PropertyDescriptor.getPropertyType()</code>.</li>
* <li>{@link ELResolver#RESOLVABLE_AT_DESIGN_TIME} - <code>true</code>.</li>
* </ul>
*
*
* @param context The context of this evaluation.
* @param base The bean to analyze.
* @return An <code>Iterator</code> containing zero or more <code>FeatureDescriptor</code> objects, each representing a
* property on this bean, or <code>null</code> if the <code>base</code> object is <code>null</code>.
*
* @deprecated This method will be removed without replacement in EL 6.0
*/
@Deprecated(forRemoval = true, since = "5.0")
@Override
public Iterator<FeatureDescriptor> getFeatureDescriptors(ELContext context, Object base) {
if (base == null) {
return null;
}
BeanInfo info = null;
try {
info = Introspector.getBeanInfo(base.getClass());
} catch (Exception ex) {
}
if (info == null) {
return null;
}
ArrayList<FeatureDescriptor> featureDescriptors = new ArrayList<>(info.getPropertyDescriptors().length);
for (PropertyDescriptor propertyDescriptor : info.getPropertyDescriptors()) {
propertyDescriptor.setValue("type", propertyDescriptor.getPropertyType());
propertyDescriptor.setValue("resolvableAtDesignTime", TRUE);
featureDescriptors.add(propertyDescriptor);
}
return featureDescriptors.iterator();
}
/**
* If the base object is not <code>null</code>, returns the most general type that this resolver accepts for the
* <code>property</code> argument. Otherwise, returns <code>null</code>.
*
* <p>
* Assuming the base is not <code>null</code>, this method will always return <code>Object.class</code>. This is because
* any object is accepted as a key and is coerced into a string.
* </p>
*
* @param context The context of this evaluation.
* @param base The bean to analyze.
* @return <code>null</code> if base is <code>null</code>; otherwise <code>Object.class</code>.
*/
@Override
public Class<?> getCommonPropertyType(ELContext context, Object base) {
if (base == null) {
return null;
}
return Object.class;
}
private BeanProperty getBeanProperty(ELContext context, Object base, Object prop) {
String property = prop.toString();
Class<?> baseClass = base.getClass();
BeanProperties beanProperties = properties.get(baseClass);
if (beanProperties == null) {
beanProperties = new BeanProperties(baseClass);
properties.put(baseClass, beanProperties);
}
BeanProperty beanProperty = beanProperties.getBeanProperty(property);
if (beanProperty == null) {
throw new PropertyNotFoundException(getExceptionMessageString(context, "propertyNotFound", new Object[] { baseClass.getName(), property }));
}
return beanProperty;
}
}