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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.tomcat.dbcp.dbcp2.managed;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.Map;
import java.util.Objects;
import java.util.WeakHashMap;
import javax.transaction.xa.XAResource;
import jakarta.transaction.SystemException;
import jakarta.transaction.Transaction;
import jakarta.transaction.TransactionManager;
import jakarta.transaction.TransactionSynchronizationRegistry;
import org.apache.tomcat.dbcp.dbcp2.DelegatingConnection;
/**
* TransactionRegistry tracks Connections and XAResources in a transacted environment for a single XAConnectionFactory.
* <p>
* The TransactionRegistry hides the details of transaction processing from the existing DBCP pooling code, and gives
* the ManagedConnection a way to enlist connections in a transaction, allowing for the maximal rescue of DBCP.
* </p>
*
* @since 2.0
*/
public class TransactionRegistry {
private final TransactionManager transactionManager;
private final Map<Transaction, TransactionContext> caches = new WeakHashMap<>();
private final Map<Connection, XAResource> xaResources = new WeakHashMap<>();
private final TransactionSynchronizationRegistry transactionSynchronizationRegistry;
/**
* Provided for backwards compatibility
* @param transactionManager the transaction manager used to enlist connections
*/
public TransactionRegistry(final TransactionManager transactionManager) {
this (transactionManager, null);
}
/**
* Creates a TransactionRegistry for the specified transaction manager.
*
* @param transactionManager
* the transaction manager used to enlist connections.
* @param transactionSynchronizationRegistry
* The optional TSR to register synchronizations with
* @since 2.6.0
*/
public TransactionRegistry(final TransactionManager transactionManager, final TransactionSynchronizationRegistry transactionSynchronizationRegistry) {
this.transactionManager = transactionManager;
this.transactionSynchronizationRegistry = transactionSynchronizationRegistry;
}
/**
* Gets the active TransactionContext or null if not Transaction is active.
*
* @return The active TransactionContext or null if no Transaction is active.
* @throws SQLException
* Thrown when an error occurs while fetching the transaction.
*/
public TransactionContext getActiveTransactionContext() throws SQLException {
Transaction transaction = null;
try {
transaction = transactionManager.getTransaction();
// was there a transaction?
if (transaction == null) {
return null;
}
// This is the transaction on the thread so no need to check its status - we should try to use it and
// fail later based on the subsequent status
} catch (final SystemException e) {
throw new SQLException("Unable to determine current transaction ", e);
}
// register the context (or create a new one)
synchronized (this) {
return caches.computeIfAbsent(transaction, k -> new TransactionContext(this, k, transactionSynchronizationRegistry));
}
}
private Connection getConnectionKey(final Connection connection) {
final Connection result;
if (connection instanceof DelegatingConnection) {
result = ((DelegatingConnection<?>) connection).getInnermostDelegateInternal();
} else {
result = connection;
}
return result;
}
/**
* Gets the XAResource registered for the connection.
*
* @param connection
* the connection
* @return The XAResource registered for the connection; never null.
* @throws SQLException
* Thrown when the connection does not have a registered XAResource.
*/
public synchronized XAResource getXAResource(final Connection connection) throws SQLException {
Objects.requireNonNull(connection, "connection");
final Connection key = getConnectionKey(connection);
final XAResource xaResource = xaResources.get(key);
if (xaResource == null) {
throw new SQLException("Connection does not have a registered XAResource " + connection);
}
return xaResource;
}
/**
* Registers the association between a Connection and a XAResource. When a connection is enlisted in a transaction,
* it is actually the XAResource that is given to the transaction manager.
*
* @param connection
* The JDBC connection.
* @param xaResource
* The XAResource which managed the connection within a transaction.
*/
public synchronized void registerConnection(final Connection connection, final XAResource xaResource) {
Objects.requireNonNull(connection, "connection");
Objects.requireNonNull(xaResource, "xaResource");
xaResources.put(connection, xaResource);
}
/**
* Unregisters a destroyed connection from {@link TransactionRegistry}.
*
* @param connection
* A destroyed connection from {@link TransactionRegistry}.
*/
public synchronized void unregisterConnection(final Connection connection) {
xaResources.remove(getConnectionKey(connection));
}
}
|
