-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1f0cb9b
commit 73a5abc
Showing
4 changed files
with
357 additions
and
103 deletions.
There are no files selected for viewing
233 changes: 233 additions & 0 deletions
233
wrapper/src/main/java/software/amazon/jdbc/ConnectionPluginChainBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,233 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed 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 software.amazon.jdbc; | ||
|
|
||
| import java.sql.SQLException; | ||
| import java.util.ArrayList; | ||
| import java.util.Comparator; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Properties; | ||
| import java.util.logging.Logger; | ||
| import java.util.stream.Collectors; | ||
| import software.amazon.jdbc.plugin.AuroraConnectionTrackerPluginFactory; | ||
| import software.amazon.jdbc.plugin.AuroraHostListConnectionPluginFactory; | ||
| import software.amazon.jdbc.plugin.AwsSecretsManagerConnectionPluginFactory; | ||
| import software.amazon.jdbc.plugin.ConnectTimeConnectionPluginFactory; | ||
| import software.amazon.jdbc.plugin.DataCacheConnectionPluginFactory; | ||
| import software.amazon.jdbc.plugin.DefaultConnectionPlugin; | ||
| import software.amazon.jdbc.plugin.DriverMetaDataConnectionPluginFactory; | ||
| import software.amazon.jdbc.plugin.ExecutionTimeConnectionPluginFactory; | ||
| import software.amazon.jdbc.plugin.IamAuthConnectionPluginFactory; | ||
| import software.amazon.jdbc.plugin.LogQueryConnectionPluginFactory; | ||
| import software.amazon.jdbc.plugin.dev.DeveloperConnectionPluginFactory; | ||
| import software.amazon.jdbc.plugin.efm.HostMonitoringConnectionPluginFactory; | ||
| import software.amazon.jdbc.plugin.failover.FailoverConnectionPluginFactory; | ||
| import software.amazon.jdbc.plugin.readwritesplitting.ReadWriteSplittingPluginFactory; | ||
| import software.amazon.jdbc.plugin.staledns.AuroraStaleDnsPluginFactory; | ||
| import software.amazon.jdbc.profile.DriverConfigurationProfiles; | ||
| import software.amazon.jdbc.util.Messages; | ||
| import software.amazon.jdbc.util.SqlState; | ||
| import software.amazon.jdbc.util.StringUtils; | ||
| import software.amazon.jdbc.util.WrapperUtils; | ||
|
|
||
| public class ConnectionPluginChainBuilder { | ||
|
|
||
| private static final Logger LOGGER = Logger.getLogger(ConnectionPluginChainBuilder.class.getName()); | ||
|
|
||
| private static final int WEIGHT_RELATIVE_TO_PRIOR_PLUGIN = -1; | ||
|
|
||
| protected static final Map<String, Class<? extends ConnectionPluginFactory>> pluginFactoriesByCode = | ||
| new HashMap<String, Class<? extends ConnectionPluginFactory>>() { | ||
| { | ||
| put("executionTime", ExecutionTimeConnectionPluginFactory.class); | ||
| put("auroraHostList", AuroraHostListConnectionPluginFactory.class); | ||
| put("logQuery", LogQueryConnectionPluginFactory.class); | ||
| put("dataCache", DataCacheConnectionPluginFactory.class); | ||
| put("efm", HostMonitoringConnectionPluginFactory.class); | ||
| put("failover", FailoverConnectionPluginFactory.class); | ||
| put("iam", IamAuthConnectionPluginFactory.class); | ||
| put("awsSecretsManager", AwsSecretsManagerConnectionPluginFactory.class); | ||
| put("auroraStaleDns", AuroraStaleDnsPluginFactory.class); | ||
| put("readWriteSplitting", ReadWriteSplittingPluginFactory.class); | ||
| put("auroraConnectionTracker", AuroraConnectionTrackerPluginFactory.class); | ||
| put("driverMetaData", DriverMetaDataConnectionPluginFactory.class); | ||
| put("connectTime", ConnectTimeConnectionPluginFactory.class); | ||
| put("dev", DeveloperConnectionPluginFactory.class); | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * The final list of plugins will be sorted by weight, starting from the lowest values up to | ||
| * the highest values. The first plugin of the list will have the lowest weight, and the | ||
| * last one will have the highest weight. | ||
| */ | ||
| protected static final Map<Class<? extends ConnectionPluginFactory>, Integer> pluginWeightByPluginFactory = | ||
| new HashMap<Class<? extends ConnectionPluginFactory>, Integer>() { | ||
| { | ||
| put(DriverMetaDataConnectionPluginFactory.class, 100); | ||
| put(DataCacheConnectionPluginFactory.class, 200); | ||
| put(AuroraHostListConnectionPluginFactory.class, 300); | ||
| put(AuroraConnectionTrackerPluginFactory.class, 400); | ||
| put(AuroraStaleDnsPluginFactory.class, 500); | ||
| put(ReadWriteSplittingPluginFactory.class, 600); | ||
| put(FailoverConnectionPluginFactory.class, 700); | ||
| put(HostMonitoringConnectionPluginFactory.class, 800); | ||
| put(IamAuthConnectionPluginFactory.class, 900); | ||
| put(AwsSecretsManagerConnectionPluginFactory.class, 1000); | ||
| put(LogQueryConnectionPluginFactory.class, 1100); | ||
| put(ConnectTimeConnectionPluginFactory.class, WEIGHT_RELATIVE_TO_PRIOR_PLUGIN); | ||
| put(ExecutionTimeConnectionPluginFactory.class, WEIGHT_RELATIVE_TO_PRIOR_PLUGIN); | ||
| put(DeveloperConnectionPluginFactory.class, WEIGHT_RELATIVE_TO_PRIOR_PLUGIN); | ||
| } | ||
| }; | ||
|
|
||
| protected static final String DEFAULT_PLUGINS = "auroraConnectionTracker,failover,efm"; | ||
|
|
||
| /* | ||
| Internal class used for plugin factory sorting. It holds a reference to a plugin | ||
| factory and an assigned weight. | ||
| */ | ||
| private static class PluginFactoryInfo { | ||
| public Class<? extends ConnectionPluginFactory> factory; | ||
| public int weight; | ||
|
|
||
| public PluginFactoryInfo(final Class<? extends ConnectionPluginFactory> factory, final int weight) { | ||
| this.factory = factory; | ||
| this.weight = weight; | ||
| } | ||
| } | ||
|
|
||
| public List<ConnectionPlugin> getPlugins( | ||
| final PluginService pluginService, | ||
| final ConnectionProvider defaultConnProvider, | ||
| final PluginManagerService pluginManagerService, | ||
| final Properties props) | ||
| throws SQLException { | ||
|
|
||
| List<ConnectionPlugin> plugins; | ||
| List<Class<? extends ConnectionPluginFactory>> pluginFactories; | ||
|
|
||
| final String profileName = PropertyDefinition.PROFILE_NAME.getString(props); | ||
|
|
||
| if (profileName != null) { | ||
|
|
||
| if (!DriverConfigurationProfiles.contains(profileName)) { | ||
| throw new SQLException( | ||
| Messages.get( | ||
| "ConnectionPluginManager.configurationProfileNotFound", | ||
| new Object[] {profileName})); | ||
| } | ||
| pluginFactories = DriverConfigurationProfiles.getPluginFactories(profileName); | ||
|
|
||
| } else { | ||
|
|
||
| String pluginCodes = PropertyDefinition.PLUGINS.getString(props); | ||
|
|
||
| if (pluginCodes == null) { | ||
| pluginCodes = DEFAULT_PLUGINS; | ||
| } | ||
|
|
||
| final List<String> pluginCodeList = StringUtils.split(pluginCodes, ",", true); | ||
| pluginFactories = new ArrayList<>(pluginCodeList.size()); | ||
|
|
||
| for (final String pluginCode : pluginCodeList) { | ||
| if (!pluginFactoriesByCode.containsKey(pluginCode)) { | ||
| throw new SQLException( | ||
| Messages.get( | ||
| "ConnectionPluginManager.unknownPluginCode", | ||
| new Object[] {pluginCode})); | ||
| } | ||
| pluginFactories.add(pluginFactoriesByCode.get(pluginCode)); | ||
| } | ||
| } | ||
|
|
||
| if (!pluginFactories.isEmpty()) { | ||
|
|
||
| if (PropertyDefinition.AUTO_SORT_PLUGIN_ORDER.getBoolean(props)) { | ||
| pluginFactories = this.sortPluginFactories(pluginFactories); | ||
|
|
||
| final List<Class<? extends ConnectionPluginFactory>> tempPluginFactories = pluginFactories; | ||
| LOGGER.finest(() -> | ||
| "Plugins order has been rearranged. The following order is in effect: " | ||
| + tempPluginFactories.stream() | ||
| .map(Class::getSimpleName) | ||
| .collect(Collectors.joining(", "))); | ||
| } | ||
|
|
||
| try { | ||
| final ConnectionPluginFactory[] factories = | ||
| WrapperUtils.loadClasses( | ||
| pluginFactories, | ||
| ConnectionPluginFactory.class, | ||
| "ConnectionPluginManager.unableToLoadPlugin") | ||
| .toArray(new ConnectionPluginFactory[0]); | ||
|
|
||
| // make a chain of connection plugins | ||
|
|
||
| plugins = new ArrayList<>(factories.length + 1); | ||
|
|
||
| for (final ConnectionPluginFactory factory : factories) { | ||
| plugins.add(factory.getInstance(pluginService, props)); | ||
| } | ||
|
|
||
| } catch (final InstantiationException instEx) { | ||
| throw new SQLException(instEx.getMessage(), SqlState.UNKNOWN_STATE.getState(), instEx); | ||
| } | ||
| } else { | ||
| plugins = new ArrayList<>(1); // one spot for default connection plugin | ||
| } | ||
|
|
||
| // add default connection plugin to the tail | ||
| final ConnectionPlugin defaultPlugin = | ||
| new DefaultConnectionPlugin(pluginService, defaultConnProvider, pluginManagerService); | ||
| plugins.add(defaultPlugin); | ||
|
|
||
| return plugins; | ||
| } | ||
|
|
||
| protected List<Class<? extends ConnectionPluginFactory>> sortPluginFactories( | ||
| final List<Class<? extends ConnectionPluginFactory>> unsortedPluginFactories) { | ||
|
|
||
| final ArrayList<PluginFactoryInfo> weights = new ArrayList<>(); | ||
| int lastWeight = 0; | ||
| for (Class<? extends ConnectionPluginFactory> pluginFactory : unsortedPluginFactories) { | ||
| Integer pluginFactoryWeight = pluginWeightByPluginFactory.get(pluginFactory); | ||
|
|
||
| if (pluginFactoryWeight == null || pluginFactoryWeight == WEIGHT_RELATIVE_TO_PRIOR_PLUGIN) { | ||
|
|
||
| // This plugin factory is unknown, or it has relative (to prior plugin factory) weight. | ||
| lastWeight++; | ||
| weights.add(new PluginFactoryInfo(pluginFactory, lastWeight)); | ||
|
|
||
| } else { | ||
| // Otherwise, use the wight assigned to this plugin factory | ||
| weights.add(new PluginFactoryInfo(pluginFactory, pluginFactoryWeight)); | ||
|
|
||
| // Remember this weight for next plugin factories that might have | ||
| // relative (to this plugin factory) weight. | ||
| lastWeight = pluginFactoryWeight; | ||
| } | ||
| } | ||
|
|
||
| return weights.stream() | ||
| .sorted(Comparator.comparingInt(o -> o.weight)) | ||
| .map((info) -> info.factory) | ||
| .collect(Collectors.toList()); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.