/
EjbBundleDescriptor.java
642 lines (509 loc) · 19.6 KB
/
EjbBundleDescriptor.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
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
/*
* Copyright (c) 2022, 2023 Contributors to the Eclipse Foundation
* 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 com.sun.enterprise.deployment;
import com.sun.enterprise.deployment.types.EjbReferenceContainer;
import com.sun.enterprise.deployment.types.EntityManagerFactoryReference;
import com.sun.enterprise.deployment.types.EntityManagerReference;
import com.sun.enterprise.deployment.types.MessageDestinationReferenceContainer;
import com.sun.enterprise.deployment.types.ResourceEnvReferenceContainer;
import com.sun.enterprise.deployment.types.ResourceReferenceContainer;
import com.sun.enterprise.deployment.types.ServiceReferenceContainer;
import com.sun.enterprise.deployment.util.ComponentVisitor;
import com.sun.enterprise.deployment.util.DOLUtils;
import java.lang.System.Logger;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.glassfish.api.deployment.archive.ArchiveType;
import org.glassfish.security.common.Role;
import static java.lang.System.Logger.Level.DEBUG;
/**
* I represent all the configurable deployment information contained in an EJB JAR.
*
* @author Danny Coward
* @author David Matejcek
*/
public abstract class EjbBundleDescriptor extends CommonResourceBundleDescriptor
implements WritableJndiNameEnvironment, EjbReferenceContainer, ResourceEnvReferenceContainer,
ResourceReferenceContainer, ServiceReferenceContainer, MessageDestinationReferenceContainer {
private static final long serialVersionUID = 1L;
private static final Logger LOG = DOLUtils.getLogger();
private Boolean disableNonportableJndiNames;
private final Map<String, EjbApplicationExceptionInfo> applicationExceptions = new HashMap<>();
private final Set<EjbDescriptor> ejbs = new HashSet<>();
/** EJB module level dependencies */
private final Set<EjbReferenceDescriptor> ejbReferences = new HashSet<>();
private final Set<EntityManagerFactoryReferenceDescriptor> entityManagerFactoryReferences = new HashSet<>();
private final Set<EntityManagerReferenceDescriptor> entityManagerReferences = new HashSet<>();
private final Set<EnvironmentProperty> environmentProperties = new HashSet<>();
/** All interceptor classes defined within this ejb module, keyed by interceptor class name. */
private final Map<String, EjbInterceptor> interceptors = new HashMap<>();
private final Set<MessageDestinationReferenceDescriptor> messageDestReferences = new HashSet<>();
private final Set<ResourceEnvReferenceDescriptor> resourceEnvReferences = new HashSet<>();
private final Set<ResourceReferenceDescriptor> resourceReferences = new HashSet<>();
private final Set<ServiceReferenceDescriptor> serviceReferences = new HashSet<>();
/**
* Creates a dummy {@link EjbDescriptor} instance of the given name.
*
* @param ejbName
* @return {@link EjbDescriptor}, never null.
*/
protected abstract EjbDescriptor createDummyEjbDescriptor(String ejbName);
@Override
public ArchiveType getModuleType() {
return DOLUtils.ejbType();
}
/**
* @return value of the disable-nonportable-jndi-names element. May be null.
*/
public Boolean getDisableNonportableJndiNames() {
return disableNonportableJndiNames;
}
/**
* @param disable value of the disable-nonportable-jndi-names element.May be null.
*/
public void setDisableNonportableJndiNames(String disable) {
disableNonportableJndiNames = Boolean.valueOf(disable);
}
/**
* @return always new {@link HashMap} with mappings of the class name
* and the {@link EjbApplicationExceptionInfo}.
*/
public Map<String, EjbApplicationExceptionInfo> getApplicationExceptions() {
return new HashMap<>(applicationExceptions);
}
/**
* Adds the mapping of the class name and the exception info.
*
* @param appExc
*/
// Reflection in EjbBundleNode
public void addApplicationException(EjbApplicationExceptionInfo appExc) {
applicationExceptions.put(appExc.getExceptionClassName(), appExc);
}
@Override
public boolean isEmpty() {
return ejbs.isEmpty();
}
/**
* @return unmodifiable set of ejb descriptors.
*/
public Set<? extends EjbDescriptor> getEjbs() {
return Collections.unmodifiableSet(ejbs);
}
/**
* @param name
* @return true if I have an ejb descriptor by that name.
*/
public boolean hasEjbByName(String name) {
for (EjbDescriptor ejb : ejbs) {
if (ejb.getName().equals(name)) {
return true;
}
}
return false;
}
/**
* @param name name of the {@link EjbDescriptor}
* @return an ejb descriptor that I have by the same name, otherwise throws
* an IllegalArgumentException
*/
public EjbDescriptor getEjbByName(String name) {
return getEjbByName(name, false);
}
/**
* Returns an ejb descriptor of the given name.
*
* @param name name of the {@link EjbDescriptor}
* @param isCreateDummy
* @return {@link EjbDescriptor} found by the name OR a dummy {@link EjbDescriptor}
* if requested.
* @throws IllegalArgumentException if isCreateDummy is false and we don't have such EJB
*/
public EjbDescriptor getEjbByName(String name, boolean isCreateDummy) {
for (EjbDescriptor next : ejbs) {
if (next.getName().equals(name)) {
return next;
}
}
if (!isCreateDummy) {
throw new IllegalArgumentException("Referencing error: this bundle has no bean of name: " + name);
}
// there could be cases where the annotation defines the ejb component
// and the ejb-jar.xml just uses it
// we have to create a dummy version of the ejb descriptor in this
// case as we process xml before annotations.
EjbDescriptor dummyEjbDesc = createDummyEjbDescriptor(name);
addEjb(dummyEjbDesc);
return dummyEjbDesc;
}
/**
* @param className {@link EjbDescriptor#getEjbClassName()}
* @return all ejb descriptors that has a given class name.
* It returns an empty list if no ejb is found.
*/
public EjbDescriptor[] getEjbByClassName(String className) {
List<EjbDescriptor> ejbList = new ArrayList<>();
for (EjbDescriptor ejb : ejbs) {
if (className.equals(ejb.getEjbClassName())) {
ejbList.add(ejb);
}
}
return ejbList.toArray(EjbDescriptor[]::new);
}
/**
* @param className
* @return all ejb descriptors that have a given class name as the web service endpoint
* interface. It returns an empty list if no ejb is found.
*/
public EjbDescriptor[] getEjbBySEIName(String className) {
ArrayList<EjbDescriptor> ejbList = new ArrayList<>();
for (EjbDescriptor ejb : ejbs) {
if (className.equals(ejb.getWebServiceEndpointInterfaceName())) {
ejbList.add(ejb);
}
}
return ejbList.toArray(EjbDescriptor[]::new);
}
/**
* @return set of service-ref from ejbs contained in this bundle this bundle or empty set
* if none
*/
public Set<ServiceReferenceDescriptor> getEjbServiceReferenceDescriptors() {
Set<ServiceReferenceDescriptor> serviceRefs = new OrderedSet<>();
for (EjbDescriptor ejb : ejbs) {
serviceRefs.addAll(ejb.getServiceReferenceDescriptors());
}
return serviceRefs;
}
/**
* @return true if this bundle descriptor defines web service clients
*/
@Override
public boolean hasWebServiceClients() {
for (EjbDescriptor next : ejbs) {
Collection<ServiceReferenceDescriptor> serviceRefs = next.getServiceReferenceDescriptors();
if (!serviceRefs.isEmpty()) {
return true;
}
}
return false;
}
/**
* Add the given ejb descriptor to my (uses equals).
*
* @param ejbDescriptor
*/
public void addEjb(EjbDescriptor ejbDescriptor) {
ejbDescriptor.setEjbBundleDescriptor(this);
ejbs.add(ejbDescriptor);
}
/**
* Remove the given ejb descriptor from my (uses equals).
*
* @param ejbDescriptor
*/
public void removeEjb(EjbDescriptor ejbDescriptor) {
ejbDescriptor.setEjbBundleDescriptor(null);
ejbs.remove(ejbDescriptor);
}
/**
* Returns the generated XML directory feturn the set of ejb references this ejb declares.
*/
@Override
public Set<EjbReferenceDescriptor> getEjbReferenceDescriptors() {
return ejbReferences;
}
@Override
public EjbReferenceDescriptor getEjbReference(String name) {
for (EjbReferenceDescriptor reference : ejbReferences) {
if (reference.getName().equals(name)) {
return reference;
}
}
throw new IllegalArgumentException(
MessageFormat.format("This ejb jar [{0}] has no ejb reference by the name of [{1}] ", getName(), name));
}
@Override
public void addEjbReferenceDescriptor(EjbReferenceDescriptor ejbReference) {
ejbReferences.add(ejbReference);
ejbReference.setReferringBundleDescriptor(this);
}
@Override
public void removeEjbReferenceDescriptor(EjbReferenceDescriptor ejbReference) {
ejbReferences.remove(ejbReference);
}
@Override
public Collection<? extends PersistenceUnitDescriptor> findReferencedPUs() {
Collection<PersistenceUnitDescriptor> persistenceUnits = new HashSet<>();
// Iterate through all the ejbs
for (EjbDescriptor ejb : ejbs) {
persistenceUnits.addAll(findReferencedPUsViaPURefs(ejb));
persistenceUnits.addAll(findReferencedPUsViaPCRefs(ejb));
}
// Add bundle level artifacts added by e.g. CDDI
for (EntityManagerFactoryReference emfRef : getEntityManagerFactoryReferenceDescriptors()) {
persistenceUnits.add(findReferencedPUViaEMFRef(emfRef));
}
for (EntityManagerReference emRef : getEntityManagerReferenceDescriptors()) {
persistenceUnits.add(findReferencedPUViaEMRef(emRef));
}
return persistenceUnits;
}
@Override
public Set<EntityManagerFactoryReferenceDescriptor> getEntityManagerFactoryReferenceDescriptors() {
return entityManagerFactoryReferences;
}
@Override
public EntityManagerFactoryReferenceDescriptor getEntityManagerFactoryReferenceByName(String name) {
for (EntityManagerFactoryReferenceDescriptor reference : getEntityManagerFactoryReferenceDescriptors()) {
if (reference.getName().equals(name)) {
return reference;
}
}
throw new IllegalArgumentException("No entity manager factory reference of name " + name);
}
@Override
public void addEntityManagerFactoryReferenceDescriptor(EntityManagerFactoryReferenceDescriptor reference) {
reference.setReferringBundleDescriptor(this);
entityManagerFactoryReferences.add(reference);
}
@Override
public Set<EntityManagerReferenceDescriptor> getEntityManagerReferenceDescriptors() {
return entityManagerReferences;
}
@Override
public EntityManagerReferenceDescriptor getEntityManagerReferenceByName(String name) {
for (EntityManagerReferenceDescriptor reference : entityManagerReferences) {
if (reference.getName().equals(name)) {
return reference;
}
}
throw new IllegalArgumentException("No entity manager reference of name " + name);
}
@Override
public void addEntityManagerReferenceDescriptor(EntityManagerReferenceDescriptor reference) {
reference.setReferringBundleDescriptor(this);
entityManagerReferences.add(reference);
}
@Override
public Set<EnvironmentProperty> getEnvironmentProperties() {
return environmentProperties;
}
@Override
public EnvironmentProperty getEnvironmentPropertyByName(String name) {
for (EnvironmentProperty ev : environmentProperties) {
if (ev.getName().equals(name)) {
return ev;
}
}
throw new IllegalArgumentException("no env-entry of name " + name);
}
@Override
public void addEnvironmentProperty(EnvironmentProperty environmentProperty) {
environmentProperties.add(environmentProperty);
}
@Override
public void removeEnvironmentProperty(EnvironmentProperty environmentProperty) {
environmentProperties.remove(environmentProperty);
}
/**
* @return new {@link Set} with all our {@link EjbInterceptor}s
*/
public Set<EjbInterceptor> getInterceptors() {
return new HashSet<>(interceptors.values());
}
/**
* @param className
* @return {@link EjbInterceptor} or null
*/
public EjbInterceptor getInterceptorByClassName(String className) {
return interceptors.get(className);
}
/**
* Adds the interceptor. If there already is another interceptor with the same
* {@link EjbInterceptor#getInterceptorClassName()}, the call is ignored.
*
* @param interceptor
*/
public void addInterceptor(EjbInterceptor interceptor) {
EjbInterceptor ic = getInterceptorByClassName(interceptor.getInterceptorClassName());
if (ic == null) {
interceptor.setEjbBundleDescriptor(this);
interceptors.put(interceptor.getInterceptorClassName(), interceptor);
}
}
@Override
public Set<MessageDestinationReferenceDescriptor> getMessageDestinationReferenceDescriptors() {
return messageDestReferences;
}
@Override
public MessageDestinationReferenceDescriptor getMessageDestinationReferenceByName(String name) {
for (MessageDestinationReferenceDescriptor mdr : messageDestReferences) {
if (mdr.getName().equals(name)) {
return mdr;
}
}
throw new IllegalArgumentException("No message destination ref of name " + name);
}
@Override
public void addMessageDestinationReferenceDescriptor(MessageDestinationReferenceDescriptor messageDestRef) {
messageDestRef.setReferringBundleDescriptor(this);
messageDestReferences.add(messageDestRef);
}
@Override
public void removeMessageDestinationReferenceDescriptor(MessageDestinationReferenceDescriptor msgDestRef) {
messageDestReferences.remove(msgDestRef);
}
@Override
public Set<ResourceEnvReferenceDescriptor> getResourceEnvReferenceDescriptors() {
return resourceEnvReferences;
}
@Override
public ResourceEnvReferenceDescriptor getResourceEnvReferenceByName(String name) {
for (ResourceEnvReferenceDescriptor element : resourceEnvReferences) {
if (element.getName().equals(name)) {
return element;
}
}
throw new IllegalArgumentException("No resource env ref of name " + name);
}
@Override
public void addResourceEnvReferenceDescriptor(ResourceEnvReferenceDescriptor resourceEnvReference) {
resourceEnvReferences.add(resourceEnvReference);
}
@Override
public void removeResourceEnvReferenceDescriptor(ResourceEnvReferenceDescriptor resourceEnvReference) {
resourceEnvReferences.remove(resourceEnvReference);
}
@Override
public Set<ResourceReferenceDescriptor> getResourceReferenceDescriptors() {
return resourceReferences;
}
@Override
public ResourceReferenceDescriptor getResourceReferenceByName(String name) {
for (ResourceReferenceDescriptor reference : resourceReferences) {
if (reference.getName().equals(name)) {
return reference;
}
}
throw new IllegalArgumentException("No resource ref of name " + name);
}
@Override
public void addResourceReferenceDescriptor(ResourceReferenceDescriptor resourceReference) {
resourceReferences.add(resourceReference);
}
@Override
public void removeResourceReferenceDescriptor(ResourceReferenceDescriptor resourceReference) {
resourceReferences.remove(resourceReference);
}
@Override
public Set<ServiceReferenceDescriptor> getServiceReferenceDescriptors() {
return serviceReferences;
}
@Override
public ServiceReferenceDescriptor getServiceReferenceByName(String name) {
for (ServiceReferenceDescriptor reference : getServiceReferenceDescriptors()) {
if (reference.getName().equals(name)) {
return reference;
}
}
throw new IllegalArgumentException("No service ref of name " + name);
}
@Override
public void addServiceReferenceDescriptor(ServiceReferenceDescriptor serviceRef) {
serviceRef.setBundleDescriptor(this);
serviceReferences.add(serviceRef);
}
@Override
public void removeServiceReferenceDescriptor(ServiceReferenceDescriptor serviceRef) {
serviceReferences.remove(serviceRef);
}
@Override
public void removeRole(Role role) {
LOG.log(DEBUG, "removeRole(role={0})", role);
if (getRoles().contains(role)) {
for (EjbDescriptor ejb : ejbs) {
ejb.removeRole(role);
}
super.removeRole(role);
}
}
/**
* @return null if not overriden
*/
@Override
public ComponentVisitor getBundleVisitor() {
return null;
}
@Override
public List<InjectionCapable> getInjectableResourcesByClass(String className) {
return getInjectableResourcesByClass(className, this);
}
@Override
public InjectionInfo getInjectionInfoByClass(Class clazz) {
return getInjectionInfoByClass(clazz, this);
}
/**
* Always empty immutable {@link Set}.
*/
@Override
public Set<LifecycleCallbackDescriptor> getPostConstructDescriptors() {
return Collections.emptySet();
}
/**
* Ignored.
*/
@Override
public void addPostConstructDescriptor(LifecycleCallbackDescriptor postConstructDesc) {
// no-op
}
/**
* Always null.
*/
@Override
public LifecycleCallbackDescriptor getPostConstructDescriptorByClass(String className) {
return null;
}
/**
* Always empty immutable {@link Set}.
*/
@Override
public Set<LifecycleCallbackDescriptor> getPreDestroyDescriptors() {
return Collections.emptySet();
}
/**
* Ignored.
*/
@Override
public void addPreDestroyDescriptor(LifecycleCallbackDescriptor preDestroyDesc) {
// no-op
}
/**
* Always null.
*/
@Override
public LifecycleCallbackDescriptor getPreDestroyDescriptorByClass(String className) {
return null;
}
}