/
JdbcToolKit.java
559 lines (508 loc) · 15.1 KB
/
JdbcToolKit.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
/*******************************************************************************
* Copyright (c) 2004-2005 Actuate Corporation. All rights reserved. This program and
* the accompanying materials are made available under the terms of the Eclipse
* Public License v1.0 which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors: Actuate Corporation - initial API and implementation
******************************************************************************/
package org.eclipse.birt.report.data.oda.jdbc.ui.util;
import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.lang.reflect.Modifier;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.sql.Driver;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import org.eclipse.birt.report.data.oda.jdbc.ui.JdbcPlugin;
import org.eclipse.birt.report.data.oda.jdbc.ui.dialogs.JdbcDriverManagerDialog;
import org.eclipse.birt.report.data.oda.jdbc.utils.JDBCDriverInfoManager;
import org.eclipse.birt.report.data.oda.jdbc.utils.JDBCDriverInformation;
import org.eclipse.ui.PlatformUI;
public class JdbcToolKit
{
// A list of JDBCDriverInformation objects
private static List jdbcDriverInfos = null;
// A list kept failure loaded driver files
private static List failLoadFileList = null;
// A list keep the add-in drivers every time the dialog is open
private static List tempAddedInDriverInfos = null;
// A map from driverClass (String) to JDBCDriverInformation
private static HashMap driverNameMap = null;
private static Hashtable file2Drivers = null;
private static final Class DriverClass = Driver.class;
/**
* Resets cached jdbc driver list to null, force reget the information when
* required next time.
*/
public static void resetJdbcDriverNames( )
{
jdbcDriverInfos = null;
failLoadFileList = null;
driverNameMap = null;
file2Drivers = null;
tempAddedInDriverInfos = null;
}
/**
* Found drivers in the Jar file List
* @param file
* @return a List of JDBCDriverInformation
*/
public static List getJdbcDriverFromFile( List fileList )
{
if ( failLoadFileList != null )
{
boolean duplicated;
for ( int i = 0; i < failLoadFileList.size( ); i++ )
{
duplicated = false;
File failToLoadFile = (File) failLoadFileList.get( i );
for ( int j = 0; j < fileList.size( ); j++ )
{
if ( failToLoadFile.getName( )
.equals( ( (File) fileList.get( j ) ).getName( ) ) )
{
duplicated = true;
break;
}
}
if ( !duplicated )
fileList.add( failToLoadFile );
}
}
List driverInfos = getJDBCDriverInfoList( fileList );
jdbcDriverInfos.addAll( driverInfos );
tempAddedInDriverInfos.addAll( driverInfos );
return driverInfos;
}
/**
* Returns a List jdbc Drivers. The Drivers are searched from predefined
* directories in the DTE plug-in. Currently it is expected that the jdbc
* drivers are in the "drivers" directory of the DTE oda.jdbc plug-in.
* @param driverName
* @return
*/
public synchronized static List getJdbcDriversFromODADir( String driverName )
{
if ( jdbcDriverInfos != null )
{
// remove the forged driver if exists
if ( !driverNameMap.containsValue( jdbcDriverInfos.get( 0 ) ) )
jdbcDriverInfos.remove( 0 );
if ( JdbcDriverManagerDialog.needResetPreferences( ) )
{
resetPreferences( );
JdbcDriverManagerDialog.resetDriverChangedStatus( );
}
tempAddedInDriverInfos.clear( );
return getDriverList( );
}
jdbcDriverInfos = new ArrayList( );
failLoadFileList = new ArrayList( );
tempAddedInDriverInfos = new ArrayList( );
driverNameMap = new HashMap( );
file2Drivers = new Hashtable( );
// Get drivers from drivers subdirectory
addDriversFromFiles( );
final String ODBCJDBCDriverName = "sun.jdbc.odbc.JdbcOdbcDriver";
JDBCDriverInformation ODBCJDBCInfo = null;
// Merge drivers from the driverInfo extension point
JDBCDriverInformation driverInfos[] = JDBCDriverInfoManager.getInstance( ).getDriversInfo( );
for (int i = 0; i < driverInfos.length; i++)
{
JDBCDriverInformation newInfo = driverInfos[i];
// If driver already found in last step, update it; otherwise add new
JDBCDriverInformation existing =
(JDBCDriverInformation) driverNameMap.get( newInfo.getDriverClassName());
if ( existing == null )
{
if ( newInfo.getDriverClassName( )
.equalsIgnoreCase( ODBCJDBCDriverName ) )
{
ODBCJDBCInfo = newInfo;
continue;
}
jdbcDriverInfos.add( newInfo );
driverNameMap.put( newInfo.getDriverClassName(), newInfo);
}
else
{
existing.setDisplayName( newInfo.getDisplayName());
existing.setUrlFormat( newInfo.getUrlFormat());
}
}
// Put ODBC-JDBC driver to the last position of list
if ( ODBCJDBCInfo != null )
{
jdbcDriverInfos.add( ODBCJDBCInfo );
driverNameMap.put( ODBCJDBCInfo.getDriverClassName( ), ODBCJDBCInfo );
}
resetPreferences( );
return getDriverList( );
}
/**
* Read user setting from the preference store and update
*
*/
private static void resetPreferences( )
{
Map preferenceMap = Utility.getPreferenceStoredMap( JdbcPlugin.DRIVER_MAP_PREFERENCE_KEY );
for ( Iterator itr = jdbcDriverInfos.iterator( ); itr.hasNext( ); )
{
JDBCDriverInformation info = (JDBCDriverInformation) itr.next( );
Object ob = preferenceMap.get( info.toString( ) );
if ( ob != null )
{
DriverInfo driverInfo = (DriverInfo) ob;
if ( driverInfo.getDisplayName( ) != null
&& driverInfo.getDisplayName( ).length( ) >= 0 )
{
info.setDisplayName( driverInfo.getDisplayName( ) );
}
if ( driverInfo.getUrlTemplate( ) != null
&& driverInfo.getUrlTemplate( ).length( ) >= 0 )
{
info.setUrlFormat( driverInfo.getUrlTemplate( ) );
}
}
}
}
private static List getJDBCDriverInfoListFromODADir( List fileList )
{
List driverList = new ArrayList( );
List allJars = new ArrayList( );
allJars.addAll( fileList );
allJars.addAll( Arrays.asList( JarFile.getDriverLocation( )
.listFiles( new FileFilter( ) {
public boolean accept( File fileName )
{
if ( fileName.isFile( )
&& ( fileName.getName( )
.toLowerCase( )
.endsWith( ".jar" ) || fileName.getName( )
.toLowerCase( )
.endsWith( ".zip" ) ) )
{
return true;
}
return false;
}
} ) ) );
if ( allJars == null || allJars.size( ) == 0 )
return driverList;
URLClassLoader urlClassLoader = createClassLoader( allJars.toArray( ) );
for ( int i = 0; i < fileList.size( ); i++ )
{
String[] resourceNames = getAllResouceNames( (File) fileList.get( i ) );
List subDriverList = new ArrayList( );
for ( int j = 0; j < resourceNames.length; j++ )
{
String resourceName = resourceNames[j];
if ( resourceName.endsWith( ".class" ) ) //$NON-NLS-1$
{
resourceName = modifyResourceName( resourceName );
Class aClass = loadClass( urlClassLoader, resourceName );
// Do not add it, if it is a Abstract class
if ( isImplementedDriver( aClass ) )
{
JDBCDriverInformation info = JDBCDriverInformation.newInstance( aClass );
if ( info != null )
{
driverList.add( info );
subDriverList.add( info );
}
}
}
}
if ( subDriverList.isEmpty( ) )
{
if ( !failLoadFileList.contains( fileList.get( i ) ) )
failLoadFileList.add( fileList.get( i ) );
}
else
{
if ( failLoadFileList.contains( fileList.get( i ) ) )
failLoadFileList.remove( fileList.get( i ) );
}
file2Drivers.put( ( (File) fileList.get( i ) ).getName( ),
subDriverList );
}
return driverList;
}
/**
* Get a List of JDBCDriverInformations loaded from the given fileList
* @param fileList the File List
* @param urlClassLoader
* @return List of JDBCDriverInformation
*/
private static List getJDBCDriverInfoList( List fileList )
{
List driverList = new ArrayList( );
URLClassLoader urlClassLoader = createClassLoader( fileList.toArray( ) );
for ( int i = 0; i < fileList.size( ); i++ )
{
String[] resourceNames = getAllResouceNames( (File) fileList.get( i ) );
List subDriverList = new ArrayList( );
for ( int j = 0; j < resourceNames.length; j++ )
{
String resourceName = resourceNames[j];
if ( resourceName.endsWith( ".class" ) ) //$NON-NLS-1$
{
resourceName = modifyResourceName( resourceName );
Class aClass = loadClass( urlClassLoader, resourceName );
// Do not add it, if it is a Abstract class
if ( isImplementedDriver( aClass ) )
{
JDBCDriverInformation info = JDBCDriverInformation.newInstance( aClass );
if ( info != null )
{
driverList.add( info );
subDriverList.add( info );
}
}
}
}
if ( subDriverList.isEmpty( ) )
{
if ( !failLoadFileList.contains( fileList.get( i ) ) )
failLoadFileList.add( fileList.get( i ) );
}
else
{
if ( failLoadFileList.contains( fileList.get( i ) ) )
failLoadFileList.remove( fileList.get( i ) );
}
file2Drivers.put( ( (File) fileList.get( i ) ).getName( ),
subDriverList );
}
return driverList;
}
/**
* add new found driver(s) to runtime driver list
* @param fileList
*/
public static List addToDriverList( List fileList )
{
if ( fileList != null && fileList.size( ) != 0 )
return getJdbcDriverFromFile( fileList );
return null;
}
/**
* remove driver(s) from runtime driver list
* @param fileList
*/
public static List removeFromDriverList( List fileList )
{
List removedDrivers = new ArrayList( );
for ( int i = 0; i < fileList.size( ); i++ )
{
String fileName = ( (File) fileList.get( i ) ).getName( );
List driverNames = (List) file2Drivers.get( fileName );
for ( int j = 0; j < jdbcDriverInfos.size( ); j++ )
{
for ( int k = 0; k < driverNames.size( ); k++ )
if ( ( (JDBCDriverInformation) jdbcDriverInfos.get( j ) ).getDriverClassName( )
.equals( ( (JDBCDriverInformation) driverNames.get( k ) ).getDriverClassName( ) ) )
{
removedDrivers.add( jdbcDriverInfos.get( j ) );
jdbcDriverInfos.remove( j );
}
}
if ( failLoadFileList.contains( fileList.get( i ) ) )
failLoadFileList.remove( fileList.get( i ) );
}
return removedDrivers;
}
/**
*
* @return
*/
public static List getDriverList( )
{
HashSet jdbcDriverSet = new HashSet( );
for( int i = 0; i < jdbcDriverInfos.size( ); i++ )
{
jdbcDriverSet.add( jdbcDriverInfos.get( i ) );
}
return new ArrayList( jdbcDriverSet );
}
/**
* modify resourceName,prepare for loadClass()
* @param resourceName
* @return
*/
private static String modifyResourceName( String resourceName )
{
resourceName = ( resourceName.replaceAll( "/", "." ) ).substring( 0,resourceName.length( ) - 6 );
return resourceName;
}
/**
* Gets a list of JDBCDriverInformation according to the given jar list.
*
* @param jars
* @return
*/
public static List getDriverByJar( List jars )
{
List drivers = null;
if ( jars == null || jars.size( ) == 0 )
return drivers;
List jarList = new ArrayList( jars.size( ) );
for ( int i = 0; i < jars.size( ); i++ )
{
jarList.add( new File( ( (JarFile) jars.get( i ) ).getFilePath( ) ) );
}
drivers = getJDBCDriverInfoList( jarList );
return drivers;
}
/**
* Discards the temporary add-in drivers list
*
*/
public static void discardAddedInDrivers( )
{
for ( int i = 0; i < tempAddedInDriverInfos.size( ); i++ )
{
jdbcDriverInfos.remove( tempAddedInDriverInfos.get( i ) );
}
tempAddedInDriverInfos.clear( );
}
/**
* Search files under "drivers" directory for JDBC drivers. Found drivers are added
* to jdbdDriverInfos as JDBCDriverInformation instances
*/
private static void addDriversFromFiles( )
{
List jdbcDriverFiles = JdbcDriverConfigUtil.getDriverFiles( );
if ( jdbcDriverFiles == null || jdbcDriverFiles.size( ) == 0 )
return;
List driverList = getJDBCDriverInfoList( jdbcDriverFiles );
jdbcDriverInfos.addAll( driverList );
for ( int i = 0; i < driverList.size( ); i++ )
{
JDBCDriverInformation info = (JDBCDriverInformation) driverList.get( i );
driverNameMap.put( info.getDriverClassName( ), info );
}
}
/**
* Create URLClassLoader based on the given jdbcDriverFiles array
*
* @param jdbcDriverFiles
* @return
*/
private static URLClassLoader createClassLoader( Object[] jdbcDriverFiles )
{
// Create a URL Array for the class loader to use
URL[] urlList = new URL[jdbcDriverFiles.length];
try
{
for ( int i = 0; i < jdbcDriverFiles.length; i++ )
{
urlList[i] = ( (File) jdbcDriverFiles[i] ).toURI( ).toURL( );
}
}
catch ( MalformedURLException e )
{
ExceptionHandler.showException( PlatformUI.getWorkbench( )
.getDisplay( )
.getActiveShell( ),
JdbcPlugin.getResourceString( "exceptionHandler.title.error" ),
e.getLocalizedMessage( ),
e );
}
URLClassLoader urlClassLoader = new URLClassLoader( urlList,
ClassLoader.getSystemClassLoader( ) );
return urlClassLoader;
}
/**
* Load a Class using the given ClassLoader
* @param urlClassLoader
* @param resourceName
* @return
*/
private static Class loadClass( URLClassLoader urlClassLoader, String resourceName )
{
Class aClass = null;
try
{
aClass = urlClassLoader.loadClass( resourceName );
}
catch ( Throwable e )
{
// here throwable is used to catch exception and error
}
return aClass;
}
/**
* Check whether the given class implemented <tt>java.sql.Driver</tt>
* @param aClass the class to be checked
* @return <tt>true</tt> if <tt>aClass</tt> implemented
* <tt>java.sql.Driver</tt>,else <tt>false</tt>;
*/
private static boolean isImplementedDriver( Class aClass )
{
return aClass != null && implementsSQLDriverClass( aClass ) &&
! Modifier.isAbstract( aClass.getModifiers( ));
}
/**
* Get all resources included in a jar file
* @param jarFile
* @return
*/
private static String[] getAllResouceNames( File jarFile )
{
ArrayList jarEntries = new ArrayList( );
try
{
ZipFile zf = new ZipFile( jarFile );
Enumeration e = zf.entries( );
while ( e.hasMoreElements( ) )
{
ZipEntry ze = (ZipEntry) e.nextElement( );
if ( !ze.isDirectory( ) )
{
jarEntries.add( ze.getName( ) );
}
}
zf.close( );
}
catch ( IOException e1 )
{
}
catch ( Exception e )
{
ExceptionHandler.showException( PlatformUI.getWorkbench( )
.getDisplay( )
.getActiveShell( ),
JdbcPlugin.getResourceString( "exceptionHandler.title.error" ),
e.getLocalizedMessage( ),
e );
}
return (String[]) jarEntries.toArray( new String[jarEntries.size( )] );
}
/**
* Determine aClass implements java.sql.Driver interface
* @param aClass
* @return
*/
private static boolean implementsSQLDriverClass( Class aClass )
{
if ( DriverClass.isAssignableFrom( aClass ) )
{
return true;
}
return false;
}
}