forked from quarkusio/quarkus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
HibernateOrmProcessor.java
1619 lines (1450 loc) · 87.3 KB
/
HibernateOrmProcessor.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
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package io.quarkus.hibernate.orm.deployment;
import static io.quarkus.deployment.annotations.ExecutionTime.RUNTIME_INIT;
import static io.quarkus.deployment.annotations.ExecutionTime.STATIC_INIT;
import static io.quarkus.hibernate.orm.deployment.HibernateConfigUtil.firstPresent;
import static org.hibernate.cfg.AvailableSettings.JPA_SHARED_CACHE_MODE;
import static org.hibernate.cfg.AvailableSettings.USE_DIRECT_REFERENCE_CACHE_ENTRIES;
import static org.hibernate.cfg.AvailableSettings.USE_QUERY_CACHE;
import static org.hibernate.cfg.AvailableSettings.USE_SECOND_LEVEL_CACHE;
import java.io.IOException;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Optional;
import java.util.OptionalInt;
import java.util.Properties;
import java.util.Set;
import java.util.TreeSet;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.inject.Default;
import javax.persistence.AttributeConverter;
import javax.persistence.SharedCacheMode;
import javax.persistence.ValidationMode;
import javax.persistence.spi.PersistenceUnitTransactionType;
import javax.transaction.TransactionManager;
import javax.xml.bind.JAXBElement;
import javax.xml.namespace.QName;
import org.hibernate.boot.archive.scan.spi.ClassDescriptor;
import org.hibernate.boot.archive.scan.spi.PackageDescriptor;
import org.hibernate.cfg.AvailableSettings;
import org.hibernate.cfg.beanvalidation.BeanValidationIntegrator;
import org.hibernate.id.SequenceMismatchStrategy;
import org.hibernate.integrator.spi.Integrator;
import org.hibernate.internal.util.collections.ArrayHelper;
import org.hibernate.jpa.boot.internal.EntityManagerFactoryBuilderImpl;
import org.hibernate.jpa.boot.internal.ParsedPersistenceXmlDescriptor;
import org.hibernate.loader.BatchFetchStyle;
import org.jboss.jandex.AnnotationInstance;
import org.jboss.jandex.AnnotationTarget.Kind;
import org.jboss.jandex.AnnotationValue;
import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.CompositeIndex;
import org.jboss.jandex.DotName;
import org.jboss.jandex.IndexView;
import org.jboss.jandex.Indexer;
import org.jboss.logging.Logger;
import org.jboss.logmanager.Level;
import io.quarkus.agroal.spi.JdbcDataSourceBuildItem;
import io.quarkus.agroal.spi.JdbcDataSourceSchemaReadyBuildItem;
import io.quarkus.agroal.spi.JdbcInitialSQLGeneratorBuildItem;
import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
import io.quarkus.arc.deployment.BeanContainerBuildItem;
import io.quarkus.arc.deployment.BeanContainerListenerBuildItem;
import io.quarkus.arc.deployment.RecorderBeanInitializedBuildItem;
import io.quarkus.arc.deployment.SyntheticBeanBuildItem;
import io.quarkus.arc.deployment.SyntheticBeanBuildItem.ExtendedBeanConfigurator;
import io.quarkus.arc.deployment.SyntheticBeansRuntimeInitBuildItem;
import io.quarkus.arc.deployment.UnremovableBeanBuildItem;
import io.quarkus.arc.deployment.UnremovableBeanBuildItem.BeanTypeExclusion;
import io.quarkus.arc.deployment.ValidationPhaseBuildItem.ValidationErrorBuildItem;
import io.quarkus.arc.deployment.staticmethods.InterceptedStaticMethodsTransformersRegisteredBuildItem;
import io.quarkus.arc.processor.DotNames;
import io.quarkus.datasource.common.runtime.DataSourceUtil;
import io.quarkus.datasource.common.runtime.DatabaseKind;
import io.quarkus.deployment.Capabilities;
import io.quarkus.deployment.Capability;
import io.quarkus.deployment.IsDevelopment;
import io.quarkus.deployment.IsNormal;
import io.quarkus.deployment.annotations.BuildProducer;
import io.quarkus.deployment.annotations.BuildStep;
import io.quarkus.deployment.annotations.BuildSteps;
import io.quarkus.deployment.annotations.Consume;
import io.quarkus.deployment.annotations.Record;
import io.quarkus.deployment.builditem.AdditionalApplicationArchiveMarkerBuildItem;
import io.quarkus.deployment.builditem.AdditionalIndexedClassesBuildItem;
import io.quarkus.deployment.builditem.ApplicationArchivesBuildItem;
import io.quarkus.deployment.builditem.BytecodeRecorderConstantDefinitionBuildItem;
import io.quarkus.deployment.builditem.BytecodeTransformerBuildItem;
import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
import io.quarkus.deployment.builditem.DevServicesAdditionalConfigBuildItem;
import io.quarkus.deployment.builditem.GeneratedClassBuildItem;
import io.quarkus.deployment.builditem.HotDeploymentWatchedFileBuildItem;
import io.quarkus.deployment.builditem.LaunchModeBuildItem;
import io.quarkus.deployment.builditem.LiveReloadBuildItem;
import io.quarkus.deployment.builditem.LogCategoryBuildItem;
import io.quarkus.deployment.builditem.ServiceStartBuildItem;
import io.quarkus.deployment.builditem.SystemPropertyBuildItem;
import io.quarkus.deployment.builditem.TransformedClassesBuildItem;
import io.quarkus.deployment.builditem.nativeimage.NativeImageProxyDefinitionBuildItem;
import io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBuildItem;
import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
import io.quarkus.deployment.index.IndexingUtil;
import io.quarkus.deployment.pkg.builditem.CurateOutcomeBuildItem;
import io.quarkus.deployment.pkg.steps.NativeOrNativeSourcesBuild;
import io.quarkus.deployment.recording.RecorderContext;
import io.quarkus.deployment.util.IoUtil;
import io.quarkus.deployment.util.ServiceUtil;
import io.quarkus.dev.console.DevConsoleManager;
import io.quarkus.devconsole.spi.DevConsoleRuntimeTemplateInfoBuildItem;
import io.quarkus.hibernate.orm.PersistenceUnit;
import io.quarkus.hibernate.orm.deployment.integration.HibernateOrmIntegrationRuntimeConfiguredBuildItem;
import io.quarkus.hibernate.orm.deployment.integration.HibernateOrmIntegrationStaticConfiguredBuildItem;
import io.quarkus.hibernate.orm.deployment.spi.DatabaseKindDialectBuildItem;
import io.quarkus.hibernate.orm.runtime.HibernateOrmRecorder;
import io.quarkus.hibernate.orm.runtime.HibernateOrmRuntimeConfig;
import io.quarkus.hibernate.orm.runtime.JPAConfig;
import io.quarkus.hibernate.orm.runtime.PersistenceUnitUtil;
import io.quarkus.hibernate.orm.runtime.RequestScopedSessionHolder;
import io.quarkus.hibernate.orm.runtime.TransactionSessions;
import io.quarkus.hibernate.orm.runtime.boot.QuarkusPersistenceUnitDefinition;
import io.quarkus.hibernate.orm.runtime.boot.scan.QuarkusScanner;
import io.quarkus.hibernate.orm.runtime.boot.xml.JAXBElementSubstitution;
import io.quarkus.hibernate.orm.runtime.boot.xml.QNameSubstitution;
import io.quarkus.hibernate.orm.runtime.boot.xml.RecordableXmlMapping;
import io.quarkus.hibernate.orm.runtime.cdi.QuarkusArcBeanContainer;
import io.quarkus.hibernate.orm.runtime.devconsole.HibernateOrmDevConsoleCreateDDLSupplier;
import io.quarkus.hibernate.orm.runtime.devconsole.HibernateOrmDevConsoleIntegrator;
import io.quarkus.hibernate.orm.runtime.integration.HibernateOrmIntegrationStaticDescriptor;
import io.quarkus.hibernate.orm.runtime.migration.MultiTenancyStrategy;
import io.quarkus.hibernate.orm.runtime.proxies.PreGeneratedProxies;
import io.quarkus.hibernate.orm.runtime.schema.SchemaManagementIntegrator;
import io.quarkus.hibernate.orm.runtime.tenant.DataSourceTenantConnectionResolver;
import io.quarkus.hibernate.orm.runtime.tenant.TenantConnectionResolver;
import io.quarkus.panache.common.deployment.HibernateEnhancersRegisteredBuildItem;
import io.quarkus.panache.common.deployment.HibernateModelClassCandidatesForFieldAccessBuildItem;
import io.quarkus.runtime.LaunchMode;
import io.quarkus.runtime.configuration.ConfigUtils;
import io.quarkus.runtime.configuration.ConfigurationException;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.dynamic.ClassFileLocator;
import net.bytebuddy.dynamic.DynamicType;
import net.bytebuddy.pool.TypePool;
/**
* Simulacrum of JPA bootstrap.
* <p>
* This does not address the proper integration with Hibernate
* Rather prepare the path to providing the right metadata
*
* @author Emmanuel Bernard emmanuel@hibernate.org
* @author Sanne Grinovero <sanne@hibernate.org>
*/
@BuildSteps(onlyIf = HibernateOrmEnabled.class)
public final class HibernateOrmProcessor {
public static final String HIBERNATE_ORM_CONFIG_PREFIX = "quarkus.hibernate-orm.";
public static final String NO_SQL_LOAD_SCRIPT_FILE = "no-file";
private static final Logger LOG = Logger.getLogger(HibernateOrmProcessor.class);
private static final String INTEGRATOR_SERVICE_FILE = "META-INF/services/org.hibernate.integrator.spi.Integrator";
@BuildStep
void registerHibernateOrmMetadataForCoreDialects(
BuildProducer<DatabaseKindDialectBuildItem> producer) {
producer.produce(new DatabaseKindDialectBuildItem(DatabaseKind.DB2,
"org.hibernate.dialect.DB297Dialect"));
producer.produce(new DatabaseKindDialectBuildItem(DatabaseKind.DERBY,
"org.hibernate.dialect.DerbyTenSevenDialect"));
producer.produce(new DatabaseKindDialectBuildItem(DatabaseKind.H2,
"io.quarkus.hibernate.orm.runtime.dialect.QuarkusH2Dialect"));
producer.produce(new DatabaseKindDialectBuildItem(DatabaseKind.MARIADB,
"org.hibernate.dialect.MariaDB106Dialect"));
producer.produce(new DatabaseKindDialectBuildItem(DatabaseKind.MSSQL,
"org.hibernate.dialect.SQLServer2016Dialect"));
producer.produce(new DatabaseKindDialectBuildItem(DatabaseKind.MYSQL,
"org.hibernate.dialect.MySQL8Dialect"));
producer.produce(new DatabaseKindDialectBuildItem(DatabaseKind.ORACLE,
"org.hibernate.dialect.Oracle12cDialect"));
producer.produce(new DatabaseKindDialectBuildItem(DatabaseKind.POSTGRESQL,
"io.quarkus.hibernate.orm.runtime.dialect.QuarkusPostgreSQL10Dialect"));
}
@BuildStep
void checkTransactionsSupport(Capabilities capabilities, BuildProducer<ValidationErrorBuildItem> validationErrors) {
// JTA is necessary for blocking Hibernate ORM but not necessarily for Hibernate Reactive
if (capabilities.isMissing(Capability.TRANSACTIONS)
&& capabilities.isMissing(Capability.HIBERNATE_REACTIVE)) {
validationErrors.produce(new ValidationErrorBuildItem(
new ConfigurationException("The Hibernate ORM extension is only functional in a JTA environment.")));
}
}
@BuildStep
void includeArchivesHostingEntityPackagesInIndex(HibernateOrmConfig hibernateOrmConfig,
BuildProducer<AdditionalApplicationArchiveMarkerBuildItem> additionalApplicationArchiveMarkers) {
for (HibernateOrmConfigPersistenceUnit persistenceUnit : hibernateOrmConfig.getAllPersistenceUnitConfigsAsMap()
.values()) {
if (persistenceUnit.packages.isPresent()) {
for (String pakkage : persistenceUnit.packages.get()) {
additionalApplicationArchiveMarkers
.produce(new AdditionalApplicationArchiveMarkerBuildItem(pakkage.replace('.', '/')));
}
}
}
}
@BuildStep(onlyIf = IsDevelopment.class)
void handleMoveSql(BuildProducer<DevConsoleRuntimeTemplateInfoBuildItem> runtimeInfoProducer,
BuildProducer<JdbcInitialSQLGeneratorBuildItem> initialSQLGeneratorBuildItemBuildProducer,
HibernateOrmConfig config, CurateOutcomeBuildItem curateOutcomeBuildItem) {
DevConsoleRuntimeTemplateInfoBuildItem devConsoleRuntimeTemplateInfoBuildItem = new DevConsoleRuntimeTemplateInfoBuildItem(
"create-ddl." + PersistenceUnitUtil.DEFAULT_PERSISTENCE_UNIT_NAME,
new HibernateOrmDevConsoleCreateDDLSupplier(PersistenceUnitUtil.DEFAULT_PERSISTENCE_UNIT_NAME), this.getClass(),
curateOutcomeBuildItem);
runtimeInfoProducer.produce(devConsoleRuntimeTemplateInfoBuildItem);
for (Entry<String, HibernateOrmConfigPersistenceUnit> entry : config.getAllPersistenceUnitConfigsAsMap().entrySet()) {
handleGenerateSqlForPu(runtimeInfoProducer, initialSQLGeneratorBuildItemBuildProducer, entry.getKey(),
entry.getValue().datasource.orElse(DataSourceUtil.DEFAULT_DATASOURCE_NAME), curateOutcomeBuildItem);
}
}
private void handleGenerateSqlForPu(BuildProducer<DevConsoleRuntimeTemplateInfoBuildItem> runtimeInfoProducer,
BuildProducer<JdbcInitialSQLGeneratorBuildItem> initialSQLGeneratorBuildItemBuildProducer, String puName,
String dsName, CurateOutcomeBuildItem curateOutcomeBuildItem) {
DevConsoleRuntimeTemplateInfoBuildItem devConsoleRuntimeTemplateInfoBuildItem = new DevConsoleRuntimeTemplateInfoBuildItem(
"create-ddl." + puName, new HibernateOrmDevConsoleCreateDDLSupplier(puName), this.getClass(),
curateOutcomeBuildItem);
runtimeInfoProducer.produce(devConsoleRuntimeTemplateInfoBuildItem);
initialSQLGeneratorBuildItemBuildProducer.produce(new JdbcInitialSQLGeneratorBuildItem(dsName, new Supplier<String>() {
@Override
public String get() {
return DevConsoleManager.getTemplateInfo()
.get(devConsoleRuntimeTemplateInfoBuildItem.getGroupId() + "."
+ devConsoleRuntimeTemplateInfoBuildItem.getArtifactId())
.get(devConsoleRuntimeTemplateInfoBuildItem.getName()).toString();
}
}));
}
@Record(RUNTIME_INIT)
@Consume(ServiceStartBuildItem.class)
@BuildStep(onlyIf = IsDevelopment.class)
void warnOfSchemaProblems(HibernateOrmConfig config, HibernateOrmRecorder recorder) {
for (var e : config.getAllPersistenceUnitConfigsAsMap().entrySet()) {
if (e.getValue().validateInDevMode) {
recorder.doValidation(e.getKey());
}
}
}
@BuildStep(onlyIfNot = IsNormal.class)
void devServicesAutoGenerateByDefault(List<JdbcDataSourceSchemaReadyBuildItem> schemaReadyBuildItems,
List<PersistenceUnitDescriptorBuildItem> persistenceUnitDescriptorBuildItems,
HibernateOrmConfig config,
BuildProducer<DevServicesAdditionalConfigBuildItem> devServicesAdditionalConfigProducer) {
Set<String> managedSources = schemaReadyBuildItems.stream().map(JdbcDataSourceSchemaReadyBuildItem::getDatasourceNames)
.collect(HashSet::new, Collection::addAll, Collection::addAll);
for (Entry<String, HibernateOrmConfigPersistenceUnit> entry : config.getAllPersistenceUnitConfigsAsMap().entrySet()) {
Optional<String> dataSourceName = entry.getValue().datasource;
List<String> propertyKeysIndicatingDataSourceConfigured = DataSourceUtil
.dataSourcePropertyKeys(dataSourceName.orElse(null), "username");
if (!managedSources.contains(dataSourceName.orElse(DataSourceUtil.DEFAULT_DATASOURCE_NAME))) {
String databaseGenerationPropertyKey = HibernateOrmRuntimeConfig.puPropertyKey(entry.getKey(),
"database.generation");
if (!ConfigUtils.isAnyPropertyPresent(propertyKeysIndicatingDataSourceConfigured)
&& !ConfigUtils.isPropertyPresent(databaseGenerationPropertyKey)) {
devServicesAdditionalConfigProducer
.produce(new DevServicesAdditionalConfigBuildItem(devServicesConfig -> {
// Only force DB generation if the datasource is configured through dev services
if (propertyKeysIndicatingDataSourceConfigured.stream()
.anyMatch(devServicesConfig::containsKey)) {
String forcedValue = "drop-and-create";
LOG.infof("Setting %s=%s to initialize Dev Services managed database",
databaseGenerationPropertyKey, forcedValue);
return Map.of(databaseGenerationPropertyKey, forcedValue);
} else {
return Map.of();
}
}));
}
}
}
}
@BuildStep
AdditionalIndexedClassesBuildItem addPersistenceUnitAnnotationToIndex() {
return new AdditionalIndexedClassesBuildItem(ClassNames.QUARKUS_PERSISTENCE_UNIT.toString());
}
// We do our own enhancement during the compilation phase, so disable any
// automatic entity enhancement by Hibernate ORM
// This has to happen before Hibernate ORM classes are initialized: see
// org.hibernate.cfg.Environment#BYTECODE_PROVIDER_INSTANCE
@BuildStep
public SystemPropertyBuildItem enforceDisableRuntimeEnhancer() {
return new SystemPropertyBuildItem(AvailableSettings.BYTECODE_PROVIDER,
org.hibernate.cfg.Environment.BYTECODE_PROVIDER_NAME_NONE);
}
@BuildStep
public void enrollBeanValidationTypeSafeActivatorForReflection(Capabilities capabilities,
BuildProducer<ReflectiveClassBuildItem> reflectiveClasses) {
if (capabilities.isPresent(Capability.HIBERNATE_VALIDATOR)) {
reflectiveClasses.produce(new ReflectiveClassBuildItem(true, true,
"org.hibernate.cfg.beanvalidation.TypeSafeActivator"));
reflectiveClasses.produce(new ReflectiveClassBuildItem(false, false, false,
BeanValidationIntegrator.BV_CHECK_CLASS));
}
}
@BuildStep
List<HotDeploymentWatchedFileBuildItem> hotDeploymentWatchedFiles(LaunchModeBuildItem launchMode) {
List<HotDeploymentWatchedFileBuildItem> watchedFiles = new ArrayList<>();
if (shouldIgnorePersistenceXmlResources()) {
watchedFiles.add(new HotDeploymentWatchedFileBuildItem("META-INF/persistence.xml"));
}
watchedFiles.add(new HotDeploymentWatchedFileBuildItem(INTEGRATOR_SERVICE_FILE));
// SQL load scripts are handled when assembling the Quarkus-configured persistence units
return watchedFiles;
}
//Integration point: allow other extensions to define additional PersistenceXmlDescriptorBuildItem
@BuildStep
public void parsePersistenceXmlDescriptors(
BuildProducer<PersistenceXmlDescriptorBuildItem> persistenceXmlDescriptorBuildItemBuildProducer) {
if (!shouldIgnorePersistenceXmlResources()) {
List<ParsedPersistenceXmlDescriptor> explicitDescriptors = QuarkusPersistenceXmlParser.locatePersistenceUnits();
for (ParsedPersistenceXmlDescriptor desc : explicitDescriptors) {
persistenceXmlDescriptorBuildItemBuildProducer.produce(new PersistenceXmlDescriptorBuildItem(desc));
}
}
}
//Integration point: allow other extensions to watch for ImpliedBlockingPersistenceUnitTypeBuildItem
@BuildStep
public ImpliedBlockingPersistenceUnitTypeBuildItem defineTypeOfImpliedPU(
List<JdbcDataSourceBuildItem> jdbcDataSourcesBuildItem, //This is from Agroal SPI: safe to use even for Hibernate Reactive
List<PersistenceXmlDescriptorBuildItem> actualXmlDescriptors,
Capabilities capabilities) {
//We won't generate an implied PU if there are explicitly configured PUs
if (actualXmlDescriptors.isEmpty() == false) {
//when we have any explicitly provided Persistence Unit, disable the automatically generated ones.
return ImpliedBlockingPersistenceUnitTypeBuildItem.none();
}
// If we have some blocking datasources defined, we can have an implied PU
if (jdbcDataSourcesBuildItem.size() == 0 && capabilities.isPresent(Capability.HIBERNATE_REACTIVE)) {
// if we don't have any blocking datasources and Hibernate Reactive is present,
// we don't want a blocking persistence unit
return ImpliedBlockingPersistenceUnitTypeBuildItem.none();
} else {
// even if we don't have any JDBC datasource, we trigger the implied blocking persistence unit
// to properly trigger error conditions and error messages to guide the user
return ImpliedBlockingPersistenceUnitTypeBuildItem.generateImpliedPersistenceUnit();
}
}
@BuildStep
public void configurationDescriptorBuilding(
HibernateOrmConfig hibernateOrmConfig,
CombinedIndexBuildItem index,
ImpliedBlockingPersistenceUnitTypeBuildItem impliedPU,
List<PersistenceXmlDescriptorBuildItem> persistenceXmlDescriptors,
List<JdbcDataSourceBuildItem> jdbcDataSources,
ApplicationArchivesBuildItem applicationArchivesBuildItem,
LaunchModeBuildItem launchMode,
JpaModelBuildItem jpaModel,
Capabilities capabilities,
BuildProducer<SystemPropertyBuildItem> systemProperties,
BuildProducer<NativeImageResourceBuildItem> nativeImageResources,
BuildProducer<HotDeploymentWatchedFileBuildItem> hotDeploymentWatchedFiles,
BuildProducer<PersistenceUnitDescriptorBuildItem> persistenceUnitDescriptors,
List<DatabaseKindDialectBuildItem> dbKindMetadataBuildItems) {
if (!hasEntities(jpaModel)) {
// we can bail out early as there are no entities
LOG.warn("Hibernate ORM is disabled because no JPA entities were found");
return;
}
// First produce the PUs having a persistence.xml: these are not reactive, as we don't allow using a persistence.xml for them.
for (PersistenceXmlDescriptorBuildItem persistenceXmlDescriptorBuildItem : persistenceXmlDescriptors) {
ParsedPersistenceXmlDescriptor xmlDescriptor = persistenceXmlDescriptorBuildItem.getDescriptor();
persistenceUnitDescriptors
.produce(new PersistenceUnitDescriptorBuildItem(xmlDescriptor,
xmlDescriptor.getName(),
Optional.of(DataSourceUtil.DEFAULT_DATASOURCE_NAME),
getMultiTenancyStrategy(Optional.ofNullable(persistenceXmlDescriptorBuildItem.getDescriptor()
.getProperties().getProperty(AvailableSettings.MULTI_TENANT))),
null,
jpaModel.getXmlMappings(persistenceXmlDescriptorBuildItem.getDescriptor().getName()),
Collections.emptyMap(),
false,
true));
}
if (impliedPU.shouldGenerateImpliedBlockingPersistenceUnit()) {
handleHibernateORMWithNoPersistenceXml(hibernateOrmConfig, index, persistenceXmlDescriptors,
jdbcDataSources, applicationArchivesBuildItem, launchMode.getLaunchMode(), jpaModel, capabilities,
systemProperties, nativeImageResources, hotDeploymentWatchedFiles, persistenceUnitDescriptors,
dbKindMetadataBuildItems);
}
}
@BuildStep
public JpaModelIndexBuildItem jpaEntitiesIndexer(
CombinedIndexBuildItem index,
List<AdditionalJpaModelBuildItem> additionalJpaModelBuildItems) {
// build a composite index with additional jpa model classes
Indexer indexer = new Indexer();
Set<DotName> additionalIndex = new HashSet<>();
for (AdditionalJpaModelBuildItem jpaModel : additionalJpaModelBuildItems) {
IndexingUtil.indexClass(jpaModel.getClassName(), indexer, index.getIndex(), additionalIndex,
HibernateOrmProcessor.class.getClassLoader());
}
CompositeIndex compositeIndex = CompositeIndex.create(index.getComputingIndex(), indexer.complete());
return new JpaModelIndexBuildItem(compositeIndex);
}
@BuildStep
public void contributePersistenceXmlToJpaModel(
BuildProducer<JpaModelPersistenceUnitContributionBuildItem> jpaModelPuContributions,
List<PersistenceXmlDescriptorBuildItem> persistenceXmlDescriptors) {
for (PersistenceXmlDescriptorBuildItem persistenceXmlDescriptor : persistenceXmlDescriptors) {
ParsedPersistenceXmlDescriptor descriptor = persistenceXmlDescriptor.getDescriptor();
jpaModelPuContributions.produce(new JpaModelPersistenceUnitContributionBuildItem(
descriptor.getName(), descriptor.getPersistenceUnitRootUrl(), descriptor.getManagedClassNames(),
descriptor.getMappingFileNames()));
}
}
@BuildStep
public void contributeQuarkusConfigToJpaModel(
BuildProducer<JpaModelPersistenceUnitContributionBuildItem> jpaModelPuContributions,
HibernateOrmConfig hibernateOrmConfig) {
for (Entry<String, HibernateOrmConfigPersistenceUnit> entry : hibernateOrmConfig.getAllPersistenceUnitConfigsAsMap()
.entrySet()) {
String name = entry.getKey();
HibernateOrmConfigPersistenceUnit config = entry.getValue();
jpaModelPuContributions.produce(new JpaModelPersistenceUnitContributionBuildItem(
name, null, Collections.emptySet(),
config.mappingFiles.orElse(Collections.emptySet())));
}
}
@BuildStep
public void defineJpaEntities(
JpaModelIndexBuildItem indexBuildItem,
BuildProducer<JpaModelBuildItem> domainObjectsProducer,
List<IgnorableNonIndexedClasses> ignorableNonIndexedClassesBuildItems,
BuildProducer<ReflectiveClassBuildItem> reflectiveClass,
BuildProducer<HotDeploymentWatchedFileBuildItem> hotDeploymentWatchedFiles,
List<JpaModelPersistenceUnitContributionBuildItem> jpaModelPuContributions) {
Set<String> ignorableNonIndexedClasses = Collections.emptySet();
if (!ignorableNonIndexedClassesBuildItems.isEmpty()) {
ignorableNonIndexedClasses = new HashSet<>();
for (IgnorableNonIndexedClasses buildItem : ignorableNonIndexedClassesBuildItems) {
ignorableNonIndexedClasses.addAll(buildItem.getClasses());
}
}
JpaJandexScavenger scavenger = new JpaJandexScavenger(reflectiveClass, hotDeploymentWatchedFiles,
jpaModelPuContributions, indexBuildItem.getIndex(), ignorableNonIndexedClasses);
final JpaModelBuildItem domainObjects = scavenger.discoverModelAndRegisterForReflection();
domainObjectsProducer.produce(domainObjects);
}
@BuildStep
public BytecodeRecorderConstantDefinitionBuildItem pregenProxies(
JpaModelBuildItem jpaModel,
JpaModelIndexBuildItem indexBuildItem,
TransformedClassesBuildItem transformedClassesBuildItem,
List<PersistenceUnitDescriptorBuildItem> persistenceUnitDescriptorBuildItems,
BuildProducer<GeneratedClassBuildItem> generatedClassBuildItemBuildProducer,
LiveReloadBuildItem liveReloadBuildItem) {
Set<String> managedClassAndPackageNames = new HashSet<>(jpaModel.getEntityClassNames());
for (PersistenceUnitDescriptorBuildItem pud : persistenceUnitDescriptorBuildItems) {
// Note: getManagedClassNames() can also return *package* names
// See the source code of Hibernate ORM for proof:
// org.hibernate.boot.archive.scan.internal.ScanResultCollector.isListedOrDetectable
// is used for packages too, and it relies (indirectly) on getManagedClassNames().
managedClassAndPackageNames.addAll(pud.getManagedClassNames());
}
PreGeneratedProxies proxyDefinitions = generatedProxies(managedClassAndPackageNames,
indexBuildItem.getIndex(), transformedClassesBuildItem,
generatedClassBuildItemBuildProducer, liveReloadBuildItem);
// Make proxies available through a constant;
// this is a hack to avoid introducing circular dependencies between build steps.
//
// If we just passed the proxy definitions to #build as a normal build item,
// we would have the following dependencies:
//
// #pregenProxies => ProxyDefinitionsBuildItem => #build => BeanContainerListenerBuildItem
// => Arc container init => BeanContainerBuildItem
// => some RestEasy Reactive Method => BytecodeTransformerBuildItem
// => build step that transforms bytecode => TransformedClassesBuildItem
// => #pregenProxies
//
// Since the dependency from #preGenProxies to #build is only a static init thing
// (#build needs to pass the proxy definitions to the recorder),
// we get rid of the circular dependency by defining a constant
// to pass the proxy definitions to the recorder.
// That way, the dependency is only between #pregenProxies
// and the build step that generates the bytecode of bytecode recorders.
return new BytecodeRecorderConstantDefinitionBuildItem(PreGeneratedProxies.class, proxyDefinitions);
}
@BuildStep(onlyIf = NativeOrNativeSourcesBuild.class)
public void preGenAnnotationProxies(List<PersistenceUnitDescriptorBuildItem> persistenceUnitDescriptorBuildItems,
BuildProducer<ReflectiveClassBuildItem> reflective,
BuildProducer<NativeImageProxyDefinitionBuildItem> proxyDefinitions) {
if (hasXmlMappings(persistenceUnitDescriptorBuildItems)) {
// XML mapping may need to create annotation proxies, which requires reflection
// and pre-generation of the proxy classes.
// This probably could be optimized,
// but there are plans to make deep changes to XML mapping in ORM (to rely on Jandex directly),
// so let's not waste our time on optimizations that won't be relevant in a few months.
List<String> annotationClassNames = new ArrayList<>();
for (DotName name : HibernateOrmAnnotations.JPA_MAPPING_ANNOTATIONS) {
annotationClassNames.add(name.toString());
}
for (DotName name : HibernateOrmAnnotations.HIBERNATE_MAPPING_ANNOTATIONS) {
annotationClassNames.add(name.toString());
}
reflective.produce(new ReflectiveClassBuildItem(true, true, true, annotationClassNames.toArray(new String[0])));
for (String annotationClassName : annotationClassNames) {
proxyDefinitions.produce(new NativeImageProxyDefinitionBuildItem(annotationClassName));
}
}
}
private boolean hasXmlMappings(List<PersistenceUnitDescriptorBuildItem> persistenceUnitDescriptorBuildItems) {
for (PersistenceUnitDescriptorBuildItem descriptor : persistenceUnitDescriptorBuildItems) {
if (descriptor.hasXmlMappings()) {
return true;
}
}
return false;
}
@SuppressWarnings("unchecked")
@BuildStep
@Record(STATIC_INIT)
public void build(RecorderContext recorderContext, HibernateOrmRecorder recorder,
Capabilities capabilities,
JpaModelBuildItem jpaModel,
List<PersistenceUnitDescriptorBuildItem> persistenceUnitDescriptorBuildItems,
List<HibernateOrmIntegrationStaticConfiguredBuildItem> integrationBuildItems,
BuildProducer<BeanContainerListenerBuildItem> beanContainerListener,
LaunchModeBuildItem launchMode) throws Exception {
validateHibernatePropertiesNotUsed();
final boolean enableORM = hasEntities(jpaModel);
final boolean hibernateReactivePresent = capabilities.isPresent(Capability.HIBERNATE_REACTIVE);
//The Hibernate Reactive extension is able to handle registration of PersistenceProviders for both reactive and
//traditional blocking Hibernate, by depending on this module and delegating to this code.
//So when the Hibernate Reactive extension is present, trust that it will register its own PersistenceProvider
//which will be responsible to decide which type of ORM to bootstrap.
//But if the extension is not present, we need to register our own PersistenceProvider - even if the ORM is not enabled!
if (!hibernateReactivePresent) {
recorder.callHibernateFeatureInit(enableORM);
}
if (!enableORM) {
// we can bail out early
return;
}
recorder.enlistPersistenceUnit(jpaModel.getEntityClassNames());
final QuarkusScanner scanner = buildQuarkusScanner(jpaModel);
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
// inspect service files for additional integrators
Collection<Class<? extends Integrator>> integratorClasses = new LinkedHashSet<>();
for (String integratorClassName : ServiceUtil.classNamesNamedIn(classLoader, INTEGRATOR_SERVICE_FILE)) {
integratorClasses.add((Class<? extends Integrator>) recorderContext.classProxy(integratorClassName));
}
if (launchMode.getLaunchMode() == LaunchMode.DEVELOPMENT) {
integratorClasses.add(HibernateOrmDevConsoleIntegrator.class);
integratorClasses.add(SchemaManagementIntegrator.class);
}
Map<String, List<HibernateOrmIntegrationStaticDescriptor>> integrationStaticDescriptors = HibernateOrmIntegrationStaticConfiguredBuildItem
.collectDescriptors(integrationBuildItems);
List<QuarkusPersistenceUnitDefinition> finalStagePUDescriptors = new ArrayList<>();
for (PersistenceUnitDescriptorBuildItem pud : persistenceUnitDescriptorBuildItems) {
finalStagePUDescriptors.add(
pud.asOutputPersistenceUnitDefinition(integrationStaticDescriptors
.getOrDefault(pud.getPersistenceUnitName(), Collections.emptyList())));
}
if (hasXmlMappings(persistenceUnitDescriptorBuildItems)) {
//Make it possible to record JAXBElement as bytecode:
recorderContext.registerSubstitution(JAXBElement.class,
JAXBElementSubstitution.Serialized.class,
JAXBElementSubstitution.class);
recorderContext.registerSubstitution(QName.class,
QNameSubstitution.Serialized.class,
QNameSubstitution.class);
}
beanContainerListener
.produce(new BeanContainerListenerBuildItem(
recorder.initMetadata(finalStagePUDescriptors, scanner, integratorClasses)));
}
private void validateHibernatePropertiesNotUsed() {
try {
final Enumeration<URL> resources = Thread.currentThread().getContextClassLoader().getResources(
"hibernate.properties");
if (resources.hasMoreElements()) {
final URL url = resources.nextElement();
throw new IllegalStateException(
"The Hibernate ORM configuration in Quarkus does not support sourcing configuration properties from resources named `hibernate.properties`,"
+ " and this is now expressly prohibited as such a file could lead to unpredictable semantics. Please remove it from `"
+ url.toExternalForm() + '`');
}
} catch (IOException e) {
throw new RuntimeException(e);
}
}
@BuildStep
void handleNativeImageImportSql(BuildProducer<NativeImageResourceBuildItem> resources,
List<PersistenceUnitDescriptorBuildItem> descriptors,
JpaModelBuildItem jpaModel,
LaunchModeBuildItem launchMode) {
if (!hasEntities(jpaModel)) {
return;
}
for (PersistenceUnitDescriptorBuildItem i : descriptors) {
//add resources
String resourceName = i.getExplicitSqlImportScriptResourceName();
if (resourceName != null) {
resources.produce(new NativeImageResourceBuildItem(resourceName));
}
}
}
@BuildStep
void registerBeans(HibernateOrmConfig hibernateOrmConfig,
BuildProducer<AdditionalBeanBuildItem> additionalBeans,
BuildProducer<UnremovableBeanBuildItem> unremovableBeans,
Capabilities capabilities,
CombinedIndexBuildItem combinedIndex,
List<PersistenceUnitDescriptorBuildItem> descriptors,
JpaModelBuildItem jpaModel) {
if (!hasEntities(jpaModel)) {
return;
}
List<Class<?>> unremovableClasses = new ArrayList<>();
unremovableClasses.add(JPAConfig.class);
if (capabilities.isPresent(Capability.TRANSACTIONS)) {
unremovableClasses.add(TransactionManager.class);
unremovableClasses.add(TransactionSessions.class);
}
unremovableClasses.add(RequestScopedSessionHolder.class);
unremovableClasses.add(QuarkusArcBeanContainer.class);
additionalBeans.produce(AdditionalBeanBuildItem.builder().setUnremovable()
.addBeanClasses(unremovableClasses.toArray(new Class<?>[unremovableClasses.size()]))
.build());
// Some user-injectable beans are retrieved programmatically and shouldn't be removed
unremovableBeans.produce(UnremovableBeanBuildItem.beanTypes(AttributeConverter.class));
unremovableBeans.produce(UnremovableBeanBuildItem.beanTypes(jpaModel.getPotentialCdiBeanClassNames()));
}
@Consume(InterceptedStaticMethodsTransformersRegisteredBuildItem.class)
@BuildStep
public HibernateEnhancersRegisteredBuildItem enhancerDomainObjects(JpaModelBuildItem jpaModel,
BuildProducer<BytecodeTransformerBuildItem> transformers,
List<AdditionalJpaModelBuildItem> additionalJpaModelBuildItems,
BuildProducer<GeneratedClassBuildItem> additionalClasses) {
// Modify the bytecode of all entities to enable lazy-loading, dirty checking, etc..
enhanceEntities(jpaModel, transformers, additionalJpaModelBuildItems, additionalClasses);
// this allows others to register their enhancers after Hibernate, so they run before ours
return new HibernateEnhancersRegisteredBuildItem();
}
@BuildStep
public HibernateModelClassCandidatesForFieldAccessBuildItem candidatesForFieldAccess(JpaModelBuildItem jpaModel) {
// Ask Panache to replace direct access to public fields with calls to accessors for all model classes.
return new HibernateModelClassCandidatesForFieldAccessBuildItem(jpaModel.getAllModelClassNames());
}
@BuildStep
@Record(RUNTIME_INIT)
public void build(HibernateOrmRecorder recorder, HibernateOrmConfig hibernateOrmConfig,
HibernateOrmRuntimeConfig hibernateOrmRuntimeConfig,
BuildProducer<JpaModelPersistenceUnitMappingBuildItem> jpaModelPersistenceUnitMapping,
List<PersistenceUnitDescriptorBuildItem> descriptors,
JpaModelBuildItem jpaModel) throws Exception {
if (!hasEntities(jpaModel)) {
return;
}
Map<String, Set<String>> entityPersistenceUnitMapping = new HashMap<>();
for (PersistenceUnitDescriptorBuildItem descriptor : descriptors) {
for (String entityClass : descriptor.getManagedClassNames()) {
entityPersistenceUnitMapping.putIfAbsent(entityClass, new HashSet<>());
entityPersistenceUnitMapping.get(entityClass).add(descriptor.getPersistenceUnitName());
}
}
jpaModelPersistenceUnitMapping.produce(new JpaModelPersistenceUnitMappingBuildItem(entityPersistenceUnitMapping));
}
@BuildStep
@Record(RUNTIME_INIT)
public PersistenceProviderSetUpBuildItem setupPersistenceProvider(HibernateOrmRecorder recorder,
Capabilities capabilities, HibernateOrmRuntimeConfig hibernateOrmRuntimeConfig,
List<HibernateOrmIntegrationRuntimeConfiguredBuildItem> integrationBuildItems,
BuildProducer<RecorderBeanInitializedBuildItem> orderEnforcer) {
if (capabilities.isMissing(Capability.HIBERNATE_REACTIVE)) {
recorder.setupPersistenceProvider(hibernateOrmRuntimeConfig,
HibernateOrmIntegrationRuntimeConfiguredBuildItem.collectDescriptors(integrationBuildItems));
}
return new PersistenceProviderSetUpBuildItem();
}
@BuildStep
@Consume(SyntheticBeansRuntimeInitBuildItem.class)
@Record(RUNTIME_INIT)
public ServiceStartBuildItem startPersistenceUnits(HibernateOrmRecorder recorder, BeanContainerBuildItem beanContainer,
List<JdbcDataSourceBuildItem> dataSourcesConfigured,
JpaModelBuildItem jpaModel,
List<JdbcDataSourceSchemaReadyBuildItem> schemaReadyBuildItem,
List<PersistenceProviderSetUpBuildItem> persistenceProviderSetUp) throws Exception {
if (hasEntities(jpaModel)) {
recorder.startAllPersistenceUnits(beanContainer.getValue());
}
return new ServiceStartBuildItem("Hibernate ORM");
}
@BuildStep
@Record(RUNTIME_INIT)
public void multitenancy(HibernateOrmRecorder recorder,
List<PersistenceUnitDescriptorBuildItem> persistenceUnitDescriptors,
BuildProducer<SyntheticBeanBuildItem> syntheticBeans,
BuildProducer<UnremovableBeanBuildItem> unremovableBeans) {
boolean multitenancyEnabled = false;
for (PersistenceUnitDescriptorBuildItem persistenceUnitDescriptor : persistenceUnitDescriptors) {
if (persistenceUnitDescriptor.getMultiTenancyStrategy() == MultiTenancyStrategy.NONE) {
continue;
}
multitenancyEnabled = true;
ExtendedBeanConfigurator configurator = SyntheticBeanBuildItem.configure(DataSourceTenantConnectionResolver.class)
.scope(ApplicationScoped.class)
.types(TenantConnectionResolver.class)
.setRuntimeInit()
.defaultBean()
.unremovable()
.supplier(recorder.dataSourceTenantConnectionResolver(persistenceUnitDescriptor.getPersistenceUnitName(),
persistenceUnitDescriptor.getDataSource(), persistenceUnitDescriptor.getMultiTenancyStrategy(),
persistenceUnitDescriptor.getMultiTenancySchemaDataSource()));
if (PersistenceUnitUtil.isDefaultPersistenceUnit(persistenceUnitDescriptor.getPersistenceUnitName())) {
configurator.addQualifier(Default.class);
} else {
configurator.addQualifier().annotation(DotNames.NAMED)
.addValue("value", persistenceUnitDescriptor.getPersistenceUnitName()).done();
configurator.addQualifier().annotation(PersistenceUnit.class)
.addValue("value", persistenceUnitDescriptor.getPersistenceUnitName()).done();
}
syntheticBeans.produce(configurator.done());
}
if (multitenancyEnabled) {
unremovableBeans
.produce(new UnremovableBeanBuildItem(new BeanTypeExclusion(ClassNames.TENANT_CONNECTION_RESOLVER)));
unremovableBeans.produce(new UnremovableBeanBuildItem(new BeanTypeExclusion(ClassNames.TENANT_RESOLVER)));
}
}
@BuildStep
public void produceLoggingCategories(HibernateOrmConfig hibernateOrmConfig,
BuildProducer<LogCategoryBuildItem> categories) {
if (hibernateOrmConfig.log.bindParam || hibernateOrmConfig.log.bindParameters) {
categories.produce(new LogCategoryBuildItem("org.hibernate.type.descriptor.sql.BasicBinder", Level.TRACE, true));
}
}
@BuildStep(onlyIf = NativeOrNativeSourcesBuild.class)
public void registerStaticMetamodelClassesForReflection(CombinedIndexBuildItem index,
BuildProducer<ReflectiveClassBuildItem> reflective) {
Collection<AnnotationInstance> annotationInstances = index.getIndex().getAnnotations(ClassNames.STATIC_METAMODEL);
if (!annotationInstances.isEmpty()) {
String[] metamodel = annotationInstances.stream()
.map(a -> a.target().asClass().name().toString())
.toArray(String[]::new);
reflective.produce(new ReflectiveClassBuildItem(false, false, true, metamodel));
}
}
/*
* Enable reflection for methods annotated with @InjectService,
* such as org.hibernate.engine.jdbc.cursor.internal.StandardRefCursorSupport.injectJdbcServices.
*/
@BuildStep(onlyIf = NativeOrNativeSourcesBuild.class)
public void registerInjectServiceMethodsForReflection(CombinedIndexBuildItem index,
BuildProducer<ReflectiveClassBuildItem> reflective) {
Set<String> classes = new HashSet<>();
// Built-in service classes; can't rely on Jandex as Hibernate ORM is not indexed by default.
HibernateOrmAnnotations.ANNOTATED_WITH_INJECT_SERVICE.stream()
.map(DotName::toString)
.forEach(classes::add);
// Integrators relying on @InjectService.
index.getIndex().getAnnotations(ClassNames.INJECT_SERVICE).stream()
.map(a -> a.target().asMethod().declaringClass().name().toString())
.forEach(classes::add);
if (!classes.isEmpty()) {
reflective.produce(new ReflectiveClassBuildItem(false, true, false, classes.toArray(new String[0])));
}
}
private static List<String> getSqlLoadScript(Optional<List<String>> sqlLoadScript, LaunchMode launchMode) {
// Explicit file or default Hibernate ORM file.
if (sqlLoadScript.isPresent()) {
return sqlLoadScript.get().stream()
.filter(s -> !NO_SQL_LOAD_SCRIPT_FILE.equalsIgnoreCase(s))
.collect(Collectors.toList());
} else if (launchMode == LaunchMode.NORMAL) {
return Collections.emptyList();
} else {
return List.of("import.sql");
}
}
private boolean hasEntities(JpaModelBuildItem jpaModel) {
return !jpaModel.getEntityClassNames().isEmpty();
}
private void handleHibernateORMWithNoPersistenceXml(
HibernateOrmConfig hibernateOrmConfig,
CombinedIndexBuildItem index,
List<PersistenceXmlDescriptorBuildItem> descriptors,
List<JdbcDataSourceBuildItem> jdbcDataSources,
ApplicationArchivesBuildItem applicationArchivesBuildItem,
LaunchMode launchMode,
JpaModelBuildItem jpaModel,
Capabilities capabilities,
BuildProducer<SystemPropertyBuildItem> systemProperties,
BuildProducer<NativeImageResourceBuildItem> nativeImageResources,
BuildProducer<HotDeploymentWatchedFileBuildItem> hotDeploymentWatchedFiles,
BuildProducer<PersistenceUnitDescriptorBuildItem> persistenceUnitDescriptors,
List<DatabaseKindDialectBuildItem> dbKindMetadataBuildItems) {
if (!descriptors.isEmpty()) {
if (hibernateOrmConfig.isAnyPropertySet() || !hibernateOrmConfig.persistenceUnits.isEmpty()) {
throw new ConfigurationException(
"Hibernate ORM configuration present in persistence.xml and Quarkus config file at the same time\n"
+ "If you use persistence.xml remove all " + HIBERNATE_ORM_CONFIG_PREFIX
+ "* properties from the Quarkus config file.");
} else {
return;
}
}
Optional<JdbcDataSourceBuildItem> defaultJdbcDataSource = jdbcDataSources.stream()
.filter(i -> i.isDefault())
.findFirst();
boolean enableDefaultPersistenceUnit = (defaultJdbcDataSource.isPresent()
&& hibernateOrmConfig.persistenceUnits.isEmpty())
|| hibernateOrmConfig.defaultPersistenceUnit.isAnyPropertySet();
Map<String, Set<String>> modelClassesAndPackagesPerPersistencesUnits = getModelClassesAndPackagesPerPersistenceUnits(
hibernateOrmConfig, jpaModel, index.getIndex(), enableDefaultPersistenceUnit);
Set<String> modelClassesAndPackagesForDefaultPersistenceUnit = modelClassesAndPackagesPerPersistencesUnits
.getOrDefault(PersistenceUnitUtil.DEFAULT_PERSISTENCE_UNIT_NAME, Collections.emptySet());
Set<String> storageEngineCollector = new HashSet<>();
if (enableDefaultPersistenceUnit) {
producePersistenceUnitDescriptorFromConfig(
hibernateOrmConfig, PersistenceUnitUtil.DEFAULT_PERSISTENCE_UNIT_NAME,
hibernateOrmConfig.defaultPersistenceUnit,
modelClassesAndPackagesForDefaultPersistenceUnit,
jpaModel.getXmlMappings(PersistenceUnitUtil.DEFAULT_PERSISTENCE_UNIT_NAME),
jdbcDataSources, applicationArchivesBuildItem, launchMode, capabilities,
systemProperties, nativeImageResources, hotDeploymentWatchedFiles, persistenceUnitDescriptors,
storageEngineCollector, dbKindMetadataBuildItems);
} else if (!modelClassesAndPackagesForDefaultPersistenceUnit.isEmpty()
&& (!hibernateOrmConfig.defaultPersistenceUnit.datasource.isPresent()
|| DataSourceUtil.isDefault(hibernateOrmConfig.defaultPersistenceUnit.datasource.get()))
&& !defaultJdbcDataSource.isPresent()) {
throw new ConfigurationException(
"Model classes are defined for the default persistence unit, but no default datasource was found."
+ " The default EntityManagerFactory will not be created."
+ " To solve this, configure the default datasource."
+ " Refer to https://quarkus.io/guides/datasource for guidance.",
new HashSet<>(Arrays.asList("quarkus.datasource.db-kind", "quarkus.datasource.username",
"quarkus.datasource.password", "quarkus.datasource.jdbc.url")));
}
for (Entry<String, HibernateOrmConfigPersistenceUnit> persistenceUnitEntry : hibernateOrmConfig.persistenceUnits
.entrySet()) {
producePersistenceUnitDescriptorFromConfig(
hibernateOrmConfig, persistenceUnitEntry.getKey(), persistenceUnitEntry.getValue(),
modelClassesAndPackagesPerPersistencesUnits.getOrDefault(persistenceUnitEntry.getKey(),
Collections.emptySet()),
jpaModel.getXmlMappings(persistenceUnitEntry.getKey()),
jdbcDataSources, applicationArchivesBuildItem, launchMode, capabilities,
systemProperties, nativeImageResources, hotDeploymentWatchedFiles, persistenceUnitDescriptors,
storageEngineCollector, dbKindMetadataBuildItems);
}
if (storageEngineCollector.size() > 1) {
throw new ConfigurationException(
"The dialect storage engine is a global configuration property: it must be consistent across all persistence units.");
}
}
private static void producePersistenceUnitDescriptorFromConfig(
HibernateOrmConfig hibernateOrmConfig,
String persistenceUnitName,
HibernateOrmConfigPersistenceUnit persistenceUnitConfig,
Set<String> modelClassesAndPackages,
List<RecordableXmlMapping> xmlMappings,
List<JdbcDataSourceBuildItem> jdbcDataSources,
ApplicationArchivesBuildItem applicationArchivesBuildItem,
LaunchMode launchMode,
Capabilities capabilities,
BuildProducer<SystemPropertyBuildItem> systemProperties,
BuildProducer<NativeImageResourceBuildItem> nativeImageResources,
BuildProducer<HotDeploymentWatchedFileBuildItem> hotDeploymentWatchedFiles,
BuildProducer<PersistenceUnitDescriptorBuildItem> persistenceUnitDescriptors,
Set<String> storageEngineCollector,
List<DatabaseKindDialectBuildItem> dbKindMetadataBuildItems) {
Optional<JdbcDataSourceBuildItem> jdbcDataSource = findJdbcDataSource(persistenceUnitName, persistenceUnitConfig,
jdbcDataSources);
Optional<String> explicitDialect = persistenceUnitConfig.dialect.dialect;
String dialect;
MultiTenancyStrategy multiTenancyStrategy = getMultiTenancyStrategy(persistenceUnitConfig.multitenant);
if (multiTenancyStrategy == MultiTenancyStrategy.DATABASE) {
// The datasource is optional for the DATABASE multi-tenancy strategy,
// since the datasource will be resolved separately for each tenant.
if (explicitDialect.isPresent()) {
dialect = explicitDialect.get();
} else if (jdbcDataSource.isPresent()) {
dialect = Dialects.guessDialect(persistenceUnitName, jdbcDataSource.get().getDbKind(),
dbKindMetadataBuildItems);
} else {
throw new ConfigurationException(String.format(Locale.ROOT,
"The Hibernate ORM extension could not infer the dialect for persistence unit '%s'."
+ " When using database multi-tenancy, you must either configure a datasource for that persistence unit"
+ " (refer to https://quarkus.io/guides/datasource for guidance),"
+ " or set the dialect explicitly through property '"
+ HibernateOrmRuntimeConfig.puPropertyKey(persistenceUnitName, "dialect") + "'.",
persistenceUnitName));
}
} else {
if (!jdbcDataSource.isPresent()) {
throw new ConfigurationException(String.format(Locale.ROOT,
"Datasource must be defined for persistence unit '%s'."
+ " Refer to https://quarkus.io/guides/datasource for guidance.",
persistenceUnitName),
new HashSet<>(Arrays.asList("quarkus.datasource.db-kind", "quarkus.datasource.username",
"quarkus.datasource.password", "quarkus.datasource.jdbc.url")));
}
if (explicitDialect.isPresent()) {
dialect = explicitDialect.get();
} else {
dialect = Dialects.guessDialect(persistenceUnitName, jdbcDataSource.get().getDbKind(),
dbKindMetadataBuildItems);
}
}