forked from oracle-samples/oracle-db-examples
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathUCPMaxConnReuse.java
More file actions
executable file
·317 lines (248 loc) · 10.6 KB
/
UCPMaxConnReuse.java
File metadata and controls
executable file
·317 lines (248 loc) · 10.6 KB
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
/* Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.*/
/*
* DESCRIPTION
*
* This code sample illustrates how applications use the MaxConnectionReuseTime
* and MaxConnectionReuseCount features of Oracle Universal Connection Pool
* (UCP).
*
* The maximum connection reuse time allows connections to be gracefully
* closed and removed from the pool after a connection has been in use for
* a specific amount of time. The timer for this property starts when a
* connection is physically created. Borrowed connections are closed only
* after they are returned to the pool and the reuse time is exceeded.
*
* This feature is typically used when a firewall exists between the pool tier
* and the database tier and is setup to block connections based on time
* restrictions. The blocked connections remain in the pool even though
* they are unusable. In such scenarios, the connection reuse time can be
* set to a smaller value than the firewall timeout policy.
*
* The time is measured in seconds. 0 disables the feature, which is
* the default.
*
* The maximum connection reuse count works similarly, allowing a connection
* to be closed and removed from the pool after it has been borrowed
* a specific number of times.
*
* Value 0 disables the feature, which is the default.
*
* It is required that applications have both ucp.jar and Oracle JDBC
* driver jar(s) (such as ojdbc8.jar or ojdbc7.jar) on the classpath,
* and that the database backend supports SQL (this sample uses an
* Oracle Database and the default HR schema).
*
* To run the sample, you must provide non-default and working values
* for ALL 3 of user, password, and URL. This can be done by either updating
* this file directly or supplying the 3 values as command-line options
* and user input. The password is read from console or standard input.
* java UCPMaxConnReuse -l <url> -u <user>
* If you do not update all the defaults, the program proceeds but
* will hit error when connecting.
*/
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.sql.Connection;
import java.sql.SQLException;
import oracle.ucp.admin.UniversalConnectionPoolManagerImpl;
import oracle.ucp.jdbc.PoolDataSource;
import oracle.ucp.jdbc.PoolDataSourceFactory;
public class UCPMaxConnReuse {
final static String DEFAULT_URL = "jdbc:oracle:thin:@//myhost:myport/myservice";
final static String DEFAULT_USER = "myuser";
final static String DEFAULT_PASSWORD = "mypassword";
final static String CONN_FACTORY_CLASS = "oracle.jdbc.pool.OracleDataSource";
// You must provide non-default values for ALL 3 to execute the program
static String url = DEFAULT_URL;
static String user = DEFAULT_USER;
static String password = DEFAULT_PASSWORD;
public static void main(String args[]) throws Exception {
UCPMaxConnReuse sample = new UCPMaxConnReuse();
getRealUserPasswordUrl(args);
sample.run();
}
void run() throws Exception {
demoMaxConnectionReuseTime();
demoMaxConnectionReuseCount();
}
public void demoMaxConnectionReuseTime() throws Exception {
show("\n*** Demo MaxConnectionReuseTime ***");
try {
final String POOL_NAME = "UCPMaxConnReuse_pool1";
Connection[] conns = new Connection[3];
String[] connStrs = new String[3];
PoolDataSource pds = createPoolDataSource(POOL_NAME);
// Each connection in the pool will be reusable for 25 seconds after
// its creation. Then it will be gracefully closed and removed on
// its next return to the pool.
pds.setMaxConnectionReuseTime(25);
show("Connection pool " + POOL_NAME + " configured");
show("\nBorrow conns[0] from pool.");
conns[0] = pds.getConnection();
connStrs[0] = ((Object)conns[0]).toString();
showPoolStatistics("After conns[0] is borrowed", pds);
show("\nReturn conns[0] to pool.");
conns[0].close();
showPoolStatistics("After conns[0] is returned", pds);
show("\nBorrow conns[1] from pool.");
conns[1] = pds.getConnection();
connStrs[1] = ((Object)conns[1]).toString();
show("conns[0] and conns[1] should be equal : " +
connStrs[0].equals(connStrs[1]));
show("\nSleep for 30 seconds that exceeds MaxConnnectionReuseTime.");
Thread.sleep(30000);
show("\nconns[1] is not closed, since it's still borrowed.");
showPoolStatistics("Just before conns[1] is returned to pool", pds);
show("\nReturn conns[1] to pool.");
show("This will close the physical connection in the pool.");
// Close the second connection. Since this connection has exceeded
// MaxConnectionReuseTime, it will be closed and removed from the pool.
conns[1].close();
showPoolStatistics("\nAfter conns[1] is returned", pds);
// Get the third connection. This should be a new physical connection
// from conns[1].
show("\nBorrow conns[2] from pool.");
conns[2] = pds.getConnection();
connStrs[2] = ((Object)conns[2]).toString();
show("conns[0] and conns[2] should not be equal : " +
!connStrs[0].equals(connStrs[2]));
show("conns[1] and conns[2] should not be equal : " +
!connStrs[1].equals(connStrs[2]));
show("\nReturn conns[2] to pool.");
conns[2].close();
destroyConnectionPool(POOL_NAME);
} catch (Throwable e) {
showError("demoMaxConnectionReuseTime", e);
}
show("\n*** Demo MaxConnectionReuseTime completes ***");
}
public void demoMaxConnectionReuseCount() throws Exception {
show("\n*** Demo MaxConnectionReuseCount ***");
try {
final String POOL_NAME = "UCPMaxConnReuse_pool2";
Connection[] conns = new Connection[3];
String[] connStrs = new String[3];
PoolDataSource pds = createPoolDataSource(POOL_NAME);
// Each connection in the pool will be reusable for 2 borrow's
// after its creation. Then it will be gracefully closed and
// removed on its next (i.e., 2nd) return to the pool.
pds.setMaxConnectionReuseCount(2);
show("Connection pool " + POOL_NAME + " configured");
show("\nBorrow conns[0] from pool.");
conns[0] = pds.getConnection();
connStrs[0] = ((Object)conns[0]).toString();
showPoolStatistics("After conns[0] is borrowed", pds);
show("\nReturn conns[0] to pool.");
conns[0].close();
showPoolStatistics("After conns[0] is returned", pds);
show("\nBorrow conns[1] from pool.");
conns[1] = pds.getConnection();
connStrs[1] = ((Object)conns[1]).toString();
show("conns[0] and conns[1] should be equal : " +
connStrs[0].equals(connStrs[1]));
show("\nconns[1]'s physical connection has reached MaxConnnectionReuseCount.");
show("It is not closed right away, since it's still borrowed.");
showPoolStatistics("\nJust before conns[1] is returned to pool", pds);
show("\nReturn conns[1] to pool.");
show("This will close the physical connection in the pool.");
// Close the second connection. Since this connection has exceeded
// MaxConnectionReuseCount, it will be closed and removed from the pool.
conns[1].close();
showPoolStatistics("\nAfter conns[1] is returned", pds);
// Get the third connection. This should be a new physical connection
// from conns[1].
show("\nBorrow conns[2] from pool.");
conns[2] = pds.getConnection();
connStrs[2] = ((Object)conns[2]).toString();
show("conns[0] and conns[2] should not be equal : " +
!connStrs[0].equals(connStrs[2]));
show("conns[1] and conns[2] should not be equal : " +
!connStrs[1].equals(connStrs[2]));
show("\nReturn conns[2] to pool.");
conns[2].close();
destroyConnectionPool(POOL_NAME);
} catch (Throwable e) {
showError("demoMaxConnectionReuseCount", e);
}
show("\n*** Demo MaxConnectionReuseCount completes ***");
}
// See sample UCPBasic.java for basic steps to set up a connection pool.
PoolDataSource createPoolDataSource(String poolName) throws Exception {
PoolDataSource pds = PoolDataSourceFactory.getPoolDataSource();
pds.setConnectionFactoryClassName(CONN_FACTORY_CLASS);
pds.setURL(url);
pds.setUser(user);
pds.setPassword(password);
pds.setConnectionPoolName(poolName);
return pds;
}
void destroyConnectionPool(String poolName) {
try {
UniversalConnectionPoolManagerImpl.getUniversalConnectionPoolManager()
.destroyConnectionPool(poolName);
show("\nConnection pool " + poolName + " destroyed");
} catch (Throwable e) {
showError("destroyConnectinoPool", e);
}
}
void showPoolStatistics(String prompt, PoolDataSource pds)
throws SQLException {
show(prompt + " -");
show(" Available connections: " + pds.getAvailableConnectionsCount());
show(" Borrowed connections: " + pds.getBorrowedConnectionsCount());
}
static void show(String msg) {
System.out.println(msg);
}
static void showError(String msg, Throwable exc) {
System.out.println(msg + " hit error: " + exc.getMessage());
}
static void getRealUserPasswordUrl(String args[]) throws Exception {
// URL can be modified in file, or taken from command-line
url = getOptionValue(args, "-l", DEFAULT_URL);
// DB user can be modified in file, or taken from command-line
user = getOptionValue(args, "-u", DEFAULT_USER);
// DB user's password can be modified in file, or explicitly entered
readPassword(" Password for " + user + ": ");
}
// Get specified option value from command-line.
static String getOptionValue(
String args[], String optionName, String defaultVal) {
String argValue = "";
try {
int i = 0;
String arg = "";
boolean found = false;
while (i < args.length) {
arg = args[i++];
if (arg.equals(optionName)) {
if (i < args.length)
argValue = args[i++];
if (argValue.startsWith("-") || argValue.equals("")) {
argValue = defaultVal;
}
found = true;
}
}
if (!found) {
argValue = defaultVal;
}
} catch (Exception e) {
showError("getOptionValue", e);
}
return argValue;
}
static void readPassword(String prompt) throws Exception {
if (System.console() != null) {
char[] pchars = System.console().readPassword("\n[%s]", prompt);
if (pchars != null) {
password = new String(pchars);
java.util.Arrays.fill(pchars, ' ');
}
} else {
BufferedReader r = new BufferedReader(new InputStreamReader(System.in));
show(prompt);
password = r.readLine();
}
}
}