forked from liferay/liferay-portal
/
DataSourceFactoryImpl.java
641 lines (484 loc) · 16.3 KB
/
DataSourceFactoryImpl.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
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.dao.jdbc;
import com.liferay.portal.dao.jdbc.util.DataSourceWrapper;
import com.liferay.portal.kernel.configuration.Filter;
import com.liferay.portal.kernel.dao.jdbc.DataSourceFactory;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.jndi.JNDIUtil;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.security.pacl.DoPrivileged;
import com.liferay.portal.kernel.util.ClassLoaderUtil;
import com.liferay.portal.kernel.util.PropertiesUtil;
import com.liferay.portal.kernel.util.PropsKeys;
import com.liferay.portal.kernel.util.ServerDetector;
import com.liferay.portal.kernel.util.SortedProperties;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.util.JarUtil;
import com.liferay.portal.util.PropsUtil;
import com.liferay.portal.util.PropsValues;
import com.liferay.registry.Registry;
import com.liferay.registry.RegistryUtil;
import com.liferay.registry.ServiceReference;
import com.liferay.registry.ServiceTracker;
import com.liferay.registry.ServiceTrackerCustomizer;
import com.mchange.v2.c3p0.ComboPooledDataSource;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Enumeration;
import java.util.Map;
import java.util.Properties;
import javax.management.MBeanServer;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;
import javax.naming.Context;
import javax.naming.InitialContext;
import javax.sql.DataSource;
import jodd.bean.BeanUtil;
import org.apache.commons.dbcp.BasicDataSourceFactory;
import org.apache.tomcat.jdbc.pool.PoolProperties;
import org.apache.tomcat.jdbc.pool.jmx.ConnectionPool;
/**
* @author Brian Wing Shun Chan
* @author Shuyang Zhou
*/
@DoPrivileged
public class DataSourceFactoryImpl implements DataSourceFactory {
@Override
public void destroyDataSource(DataSource dataSource) throws Exception {
while (dataSource instanceof DataSourceWrapper) {
DataSourceWrapper dataSourceWrapper = (DataSourceWrapper)dataSource;
dataSource = dataSourceWrapper.getWrappedDataSource();
}
if (dataSource instanceof ComboPooledDataSource) {
ComboPooledDataSource comboPooledDataSource =
(ComboPooledDataSource)dataSource;
comboPooledDataSource.close();
}
else if (dataSource instanceof org.apache.tomcat.jdbc.pool.DataSource) {
org.apache.tomcat.jdbc.pool.DataSource tomcatDataSource =
(org.apache.tomcat.jdbc.pool.DataSource)dataSource;
if (_serviceTracker != null) {
_serviceTracker.close();
}
tomcatDataSource.close();
}
}
@Override
public DataSource initDataSource(Properties properties) throws Exception {
Properties defaultProperties = PropsUtil.getProperties(
"jdbc.default.", true);
PropertiesUtil.merge(defaultProperties, properties);
properties = defaultProperties;
String jndiName = properties.getProperty("jndi.name");
if (Validator.isNotNull(jndiName)) {
try {
Properties jndiEnvironmentProperties = PropsUtil.getProperties(
PropsKeys.JNDI_ENVIRONMENT, true);
Context context = new InitialContext(jndiEnvironmentProperties);
return (DataSource)JNDIUtil.lookup(context, jndiName);
}
catch (Exception e) {
_log.error("Unable to lookup " + jndiName, e);
}
}
if (_log.isDebugEnabled()) {
_log.debug("Data source properties:\n");
SortedProperties sortedProperties = new SortedProperties(
properties);
_log.debug(PropertiesUtil.toString(sortedProperties));
}
testDatabaseClass(properties);
DataSource dataSource = null;
String liferayPoolProvider =
PropsValues.JDBC_DEFAULT_LIFERAY_POOL_PROVIDER;
if (StringUtil.equalsIgnoreCase(liferayPoolProvider, "c3p0") ||
StringUtil.equalsIgnoreCase(liferayPoolProvider, "c3po")) {
if (_log.isDebugEnabled()) {
_log.debug("Initializing C3P0 data source");
}
dataSource = initDataSourceC3PO(properties);
}
else if (StringUtil.equalsIgnoreCase(liferayPoolProvider, "dbcp")) {
if (_log.isDebugEnabled()) {
_log.debug("Initializing DBCP data source");
}
dataSource = initDataSourceDBCP(properties);
}
else if (StringUtil.equalsIgnoreCase(liferayPoolProvider, "hikaricp")) {
if (_log.isDebugEnabled()) {
_log.debug("Initializing HikariCP data source");
}
dataSource = initDataSourceHikariCP(properties);
}
else {
if (_log.isDebugEnabled()) {
_log.debug("Initializing Tomcat data source");
}
dataSource = initDataSourceTomcat(properties);
}
if (_log.isDebugEnabled()) {
_log.debug("Created data source " + dataSource.getClass());
}
return _pacl.getDataSource(dataSource);
}
@Override
public DataSource initDataSource(
String driverClassName, String url, String userName,
String password, String jndiName)
throws Exception {
Properties properties = new Properties();
properties.setProperty("driverClassName", driverClassName);
properties.setProperty("url", url);
properties.setProperty("username", userName);
properties.setProperty("password", password);
properties.setProperty("jndi.name", jndiName);
return initDataSource(properties);
}
public interface PACL {
public DataSource getDataSource(DataSource dataSource);
}
protected DataSource initDataSourceC3PO(Properties properties)
throws Exception {
ComboPooledDataSource comboPooledDataSource =
new ComboPooledDataSource();
String identityToken = StringUtil.randomString();
comboPooledDataSource.setIdentityToken(identityToken);
Enumeration<String> enu =
(Enumeration<String>)properties.propertyNames();
while (enu.hasMoreElements()) {
String key = enu.nextElement();
String value = properties.getProperty(key);
// Map org.apache.commons.dbcp.BasicDataSource to C3PO
if (StringUtil.equalsIgnoreCase(key, "driverClassName")) {
key = "driverClass";
}
else if (StringUtil.equalsIgnoreCase(key, "url")) {
key = "jdbcUrl";
}
else if (StringUtil.equalsIgnoreCase(key, "username")) {
key = "user";
}
// Ignore Liferay property
if (isPropertyLiferay(key)) {
continue;
}
// Ignore DBCP property
if (isPropertyDBCP(key)) {
continue;
}
// Ignore HikariCP property
if (isPropertyHikariCP(key)) {
continue;
}
// Ignore Tomcat JDBC property
if (isPropertyTomcat(key)) {
continue;
}
// Set C3PO property
try {
BeanUtil.setProperty(comboPooledDataSource, key, value);
}
catch (Exception e) {
if (_log.isWarnEnabled()) {
_log.warn(
"Property " + key + " is an invalid C3PO property");
}
}
}
return comboPooledDataSource;
}
protected DataSource initDataSourceDBCP(Properties properties)
throws Exception {
return BasicDataSourceFactory.createDataSource(properties);
}
protected DataSource initDataSourceHikariCP(Properties properties)
throws Exception {
testLiferayPoolProviderClass(_HIKARICP_DATASOURCE_CLASS_NAME);
Thread currentThread = Thread.currentThread();
ClassLoader contextClassLoader = currentThread.getContextClassLoader();
Class<?> hikariDataSourceClazz = contextClassLoader.loadClass(
_HIKARICP_DATASOURCE_CLASS_NAME);
Object hikariDataSource = hikariDataSourceClazz.newInstance();
for (Map.Entry<Object, Object> entry : properties.entrySet()) {
String key = (String)entry.getKey();
String value = (String)entry.getValue();
// Map org.apache.commons.dbcp.BasicDataSource to Hikari CP
if (StringUtil.equalsIgnoreCase(key, "url")) {
key = "jdbcUrl";
}
else if (StringUtil.equalsIgnoreCase(
key, "hikariConnectionCustomizerClassName")) {
key = "connectionCustomizerClassName";
}
// Ignore Liferay property
if (isPropertyLiferay(key)) {
continue;
}
// Ignore C3P0 property
if (isPropertyC3PO(key)) {
continue;
}
// Ignore DBCP property
if (isPropertyDBCP(key)) {
continue;
}
// Ignore Tomcat JDBC property
if (isPropertyTomcat(key)) {
continue;
}
// Set HikariCP property
try {
BeanUtil.setProperty(hikariDataSource, key, value);
}
catch (Exception e) {
if (_log.isWarnEnabled()) {
_log.warn(
"Property " + key + " is an invalid HikariCP property");
}
}
}
return (DataSource)hikariDataSource;
}
protected DataSource initDataSourceTomcat(Properties properties)
throws Exception {
PoolProperties poolProperties = new PoolProperties();
for (Map.Entry<Object, Object> entry : properties.entrySet()) {
String key = (String)entry.getKey();
String value = (String)entry.getValue();
// Ignore Liferay property
if (isPropertyLiferay(key)) {
continue;
}
// Ignore C3P0 property
if (isPropertyC3PO(key)) {
continue;
}
// Ignore HikariCP property
if (isPropertyHikariCP(key)) {
continue;
}
// Set Tomcat JDBC property
try {
BeanUtil.setProperty(poolProperties, key, value);
}
catch (Exception e) {
if (_log.isWarnEnabled()) {
_log.warn(
"Property " + key + " is an invalid Tomcat JDBC " +
"property");
}
}
}
String poolName = StringUtil.randomString();
poolProperties.setName(poolName);
org.apache.tomcat.jdbc.pool.DataSource dataSource =
new org.apache.tomcat.jdbc.pool.DataSource(poolProperties);
if (poolProperties.isJmxEnabled()) {
Registry registry = RegistryUtil.getRegistry();
_serviceTracker = registry.trackServices(
MBeanServer.class,
new MBeanServerServiceTrackerCustomizer(dataSource, poolName));
_serviceTracker.open();
}
return dataSource;
}
protected boolean isPropertyC3PO(String key) {
if (StringUtil.equalsIgnoreCase(key, "acquireIncrement") ||
StringUtil.equalsIgnoreCase(key, "acquireRetryAttempts") ||
StringUtil.equalsIgnoreCase(key, "acquireRetryDelay") ||
StringUtil.equalsIgnoreCase(key, "connectionCustomizerClassName") ||
StringUtil.equalsIgnoreCase(key, "idleConnectionTestPeriod") ||
StringUtil.equalsIgnoreCase(key, "maxIdleTime") ||
StringUtil.equalsIgnoreCase(key, "maxPoolSize") ||
StringUtil.equalsIgnoreCase(key, "minPoolSize") ||
StringUtil.equalsIgnoreCase(key, "numHelperThreads") ||
StringUtil.equalsIgnoreCase(key, "preferredTestQuery")) {
return true;
}
else {
return false;
}
}
protected boolean isPropertyDBCP(String key) {
if (StringUtil.equalsIgnoreCase(key, "defaultTransactionIsolation") ||
StringUtil.equalsIgnoreCase(key, "maxActive") ||
StringUtil.equalsIgnoreCase(key, "minIdle") ||
StringUtil.equalsIgnoreCase(key, "removeAbandonedTimeout")) {
return true;
}
else {
return false;
}
}
protected boolean isPropertyHikariCP(String key) {
if (StringUtil.equalsIgnoreCase(key, "autoCommit") ||
StringUtil.equalsIgnoreCase(key, "connectionTimeout") ||
StringUtil.equalsIgnoreCase(
key, "hikariConnectionCustomizerClassName") ||
StringUtil.equalsIgnoreCase(key, "idleTimeout") ||
StringUtil.equalsIgnoreCase(key, "maximumPoolSize") ||
StringUtil.equalsIgnoreCase(key, "maxLifetime") ||
StringUtil.equalsIgnoreCase(key, "minimumIdle") ||
StringUtil.equalsIgnoreCase(key, "registerMbeans")) {
return true;
}
else {
return false;
}
}
protected boolean isPropertyLiferay(String key) {
if (StringUtil.equalsIgnoreCase(key, "jndi.name") ||
StringUtil.equalsIgnoreCase(key, "liferay.pool.provider")) {
return true;
}
else {
return false;
}
}
protected boolean isPropertyTomcat(String key) {
if (StringUtil.equalsIgnoreCase(key, "fairQueue") ||
StringUtil.equalsIgnoreCase(key, "jdbcInterceptors") ||
StringUtil.equalsIgnoreCase(key, "jmxEnabled") ||
StringUtil.equalsIgnoreCase(key, "timeBetweenEvictionRunsMillis") ||
StringUtil.equalsIgnoreCase(key, "useEquals")) {
return true;
}
else {
return false;
}
}
protected void testDatabaseClass(Properties properties) throws Exception {
String driverClassName = properties.getProperty("driverClassName");
try {
Class.forName(driverClassName);
}
catch (ClassNotFoundException cnfe) {
if (!ServerDetector.isJetty() && !ServerDetector.isTomcat()) {
throw cnfe;
}
String url = PropsUtil.get(
PropsKeys.SETUP_DATABASE_JAR_URL, new Filter(driverClassName));
String name = PropsUtil.get(
PropsKeys.SETUP_DATABASE_JAR_NAME, new Filter(driverClassName));
if (Validator.isNull(url) || Validator.isNull(name)) {
throw cnfe;
}
ClassLoader classLoader = SystemException.class.getClassLoader();
if (!(classLoader instanceof URLClassLoader)) {
_log.error(
"Unable to install JAR because the system class loader " +
"is not an instance of URLClassLoader");
return;
}
JarUtil.downloadAndInstallJar(
new URL(url), PropsValues.LIFERAY_LIB_GLOBAL_DIR, name,
(URLClassLoader)classLoader);
}
}
protected void testLiferayPoolProviderClass(String className)
throws Exception {
try {
Class.forName(className);
}
catch (ClassNotFoundException cnfe) {
if (!ServerDetector.isJetty() && !ServerDetector.isTomcat()) {
throw cnfe;
}
String url = PropsUtil.get(
PropsKeys.SETUP_LIFERAY_POOL_PROVIDER_JAR_URL,
new Filter(PropsValues.JDBC_DEFAULT_LIFERAY_POOL_PROVIDER));
String name = PropsUtil.get(
PropsKeys.SETUP_LIFERAY_POOL_PROVIDER_JAR_NAME,
new Filter(PropsValues.JDBC_DEFAULT_LIFERAY_POOL_PROVIDER));
if (Validator.isNull(url) || Validator.isNull(name)) {
throw cnfe;
}
ClassLoader classLoader = ClassLoaderUtil.getPortalClassLoader();
if (!(classLoader instanceof URLClassLoader)) {
_log.error(
"Unable to install JAR because the portal class loader " +
"is not an instance of URLClassLoader");
return;
}
JarUtil.downloadAndInstallJar(
new URL(url), PropsValues.LIFERAY_LIB_PORTAL_DIR, name,
(URLClassLoader)classLoader);
}
}
private static final String _HIKARICP_DATASOURCE_CLASS_NAME =
"com.zaxxer.hikari.HikariDataSource";
private static final String _TOMCAT_JDBC_POOL_OBJECT_NAME_PREFIX =
"TomcatJDBCPool:type=ConnectionPool,name=";
private static final Log _log = LogFactoryUtil.getLog(
DataSourceFactoryImpl.class);
private static final PACL _pacl = new NoPACL();
private ServiceTracker <MBeanServer, MBeanServer> _serviceTracker;
private static class NoPACL implements PACL {
@Override
public DataSource getDataSource(DataSource dataSource) {
return dataSource;
}
}
private class MBeanServerServiceTrackerCustomizer
implements ServiceTrackerCustomizer<MBeanServer, MBeanServer> {
public MBeanServerServiceTrackerCustomizer(
org.apache.tomcat.jdbc.pool.DataSource dataSource,
String poolName)
throws MalformedObjectNameException {
_dataSource = dataSource;
_objectName = new ObjectName(
_TOMCAT_JDBC_POOL_OBJECT_NAME_PREFIX + poolName);
}
@Override
public MBeanServer addingService(
ServiceReference<MBeanServer> serviceReference) {
Registry registry = RegistryUtil.getRegistry();
MBeanServer mBeanServer = registry.getService(serviceReference);
try {
org.apache.tomcat.jdbc.pool.ConnectionPool jdbcConnectionPool =
_dataSource.createPool();
ConnectionPool jmxConnectionPool =
jdbcConnectionPool.getJmxPool();
mBeanServer.registerMBean(jmxConnectionPool, _objectName);
}
catch (Exception e) {
_log.error(e, e);
}
return mBeanServer;
}
@Override
public void modifiedService(
ServiceReference<MBeanServer> serviceReference,
MBeanServer mBeanServer) {
}
@Override
public void removedService(
ServiceReference<MBeanServer> serviceReference,
MBeanServer mBeanServer) {
Registry registry = RegistryUtil.getRegistry();
registry.ungetService(serviceReference);
try {
mBeanServer.unregisterMBean(_objectName);
}
catch (Exception e) {
_log.error(e, e);
}
}
private final org.apache.tomcat.jdbc.pool.DataSource _dataSource;
private final ObjectName _objectName;
}
}