software.amazon.jdbc.targetdriverdialect

Class PgTargetDriverDialect

java.lang.Object

software.amazon.jdbc.targetdriverdialect.GenericTargetDriverDialect

software.amazon.jdbc.targetdriverdialect.PgTargetDriverDialect

All Implemented Interfaces:

TargetDriverDialect

public class PgTargetDriverDialect
extends GenericTargetDriverDialect

Field Summary

Fields inherited from class software.amazon.jdbc.targetdriverdialect.GenericTargetDriverDialect

ALLOWED_ON_CLOSED_METHODS, NETWORK_BOUND_METHODS_FOR_ENTIRE_RESULTSET

Constructor Summary

Constructors

Constructor and Description
PgTargetDriverDialect()

Method Summary

Modifier and Type	Method and Description
void	abortConnection(@NonNull java.sql.Connection connectionToAbort, @NonNull java.util.concurrent.Executor abortExecutor)
java.util.Set<java.lang.String>	getAllowedOnConnectionMethodNames()
byte[]	getEncryptedBytes(@NonNull java.sql.ResultSet rs, java.lang.Object columnRef)
@Nullable java.lang.String	getSQLQueryString(java.sql.PreparedStatement ps)
boolean	isDialect(java.sql.Driver driver)
boolean	isDialect(java.lang.String dataSourceClass)
boolean	isDriverRegistered()
ConnectInfo	prepareConnectInfo(@NonNull java.lang.String protocol, @NonNull HostSpec hostSpec, @NonNull java.util.Properties props)
void	prepareDataSource(@NonNull javax.sql.DataSource dataSource, @NonNull java.lang.String protocol, @NonNull HostSpec hostSpec, @NonNull java.util.Properties props)
java.lang.String	prepareTargetDataSource(@NonNull javax.sql.CommonDataSource dataSource, @NonNull java.lang.String url, @NonNull java.util.Properties props) Applies AWS Wrapper connection settings that a target data source can only receive through driver-specific bean setters (for example connect/socket timeouts, whose unit differs per driver), and returns the connection URL to apply to that data source.
void	registerDataType(@NonNull java.sql.Connection connection, @NonNull java.lang.String typeName, @NonNull java.lang.String className)
void	registerDriver()
java.util.Set<java.lang.String>	removeHostSelectionProperties(@NonNull java.util.Properties props) Removes properties that restrict which database node the target driver is willing to accept a connection to, and returns the names of the properties that were removed.
void	setEncryptedParameter(@NonNull java.sql.PreparedStatement ps, int paramIndex, byte[] encrypted)
void	updateInternalState(@NonNull PluginService pluginService, @NonNull java.util.Properties props) Allows each target driver dialect to perform last-minute adjustments to the wrapper's internal state after the initial connection is established.

Methods inherited from class software.amazon.jdbc.targetdriverdialect.GenericTargetDriverDialect

findSQLQueryString, getNetworkBoundMethodNames, getSQLState, ping

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PgTargetDriverDialect

public PgTargetDriverDialect()

Method Detail

isDialect

public boolean isDialect(java.sql.Driver driver)

Specified by:

isDialect in interface TargetDriverDialect

Overrides:

isDialect in class GenericTargetDriverDialect

isDialect

public boolean isDialect(java.lang.String dataSourceClass)

Specified by:

isDialect in interface TargetDriverDialect

Overrides:

isDialect in class GenericTargetDriverDialect

prepareConnectInfo

public ConnectInfo prepareConnectInfo(@NonNull java.lang.String protocol,
                                      @NonNull HostSpec hostSpec,
                                      @NonNull java.util.Properties props)

Specified by:

prepareConnectInfo in interface TargetDriverDialect

Overrides:

prepareConnectInfo in class GenericTargetDriverDialect

prepareDataSource

public void prepareDataSource(@NonNull javax.sql.DataSource dataSource,
                              @NonNull java.lang.String protocol,
                              @NonNull HostSpec hostSpec,
                              @NonNull java.util.Properties props)
                       throws java.sql.SQLException

Specified by:

prepareDataSource in interface TargetDriverDialect

Overrides:

prepareDataSource in class GenericTargetDriverDialect

Throws:

java.sql.SQLException

prepareTargetDataSource

public java.lang.String prepareTargetDataSource(@NonNull javax.sql.CommonDataSource dataSource,
                                                @NonNull java.lang.String url,
                                                @NonNull java.util.Properties props)

Description copied from interface: TargetDriverDialect

Applies AWS Wrapper connection settings that a target data source can only receive through driver-specific bean setters (for example connect/socket timeouts, whose unit differs per driver), and returns the connection URL to apply to that data source.

This is used by the XA datasource path, which configures a target driver XADataSource directly instead of going through TargetDriverDialect.prepareConnectInfo(String, HostSpec, Properties). Because that path hands the target only its own (non-wrapper) properties, wrapper properties such as socketTimeout would otherwise be dropped. Dialects whose target data source cannot express a setting as a bean property may instead add it to the returned URL.

The default implementation applies nothing and returns url unchanged.

Parameters:

dataSource - the target driver data source being configured.

url - the target driver URL, with AWS Wrapper parameters already removed.

props - the effective connection properties, including AWS Wrapper properties.

Returns:

the URL to apply to the target data source.

isDriverRegistered

public boolean isDriverRegistered()
                           throws java.sql.SQLException

Specified by:

isDriverRegistered in interface TargetDriverDialect

Overrides:

isDriverRegistered in class GenericTargetDriverDialect

Throws:

java.sql.SQLException

registerDriver

public void registerDriver()
                    throws java.sql.SQLException

Specified by:

registerDriver in interface TargetDriverDialect

Overrides:

registerDriver in class GenericTargetDriverDialect

Throws:

java.sql.SQLException

getAllowedOnConnectionMethodNames

public java.util.Set<java.lang.String> getAllowedOnConnectionMethodNames()

Specified by:

getAllowedOnConnectionMethodNames in interface TargetDriverDialect

Overrides:

getAllowedOnConnectionMethodNames in class GenericTargetDriverDialect

abortConnection

public void abortConnection(@NonNull java.sql.Connection connectionToAbort,
                            @NonNull java.util.concurrent.Executor abortExecutor)
                     throws java.sql.SQLException

Specified by:

abortConnection in interface TargetDriverDialect

Overrides:

abortConnection in class GenericTargetDriverDialect

Throws:

java.sql.SQLException

getSQLQueryString

public @Nullable java.lang.String getSQLQueryString(java.sql.PreparedStatement ps)

Specified by:

getSQLQueryString in interface TargetDriverDialect

Overrides:

getSQLQueryString in class GenericTargetDriverDialect

registerDataType

public void registerDataType(@NonNull java.sql.Connection connection,
                             @NonNull java.lang.String typeName,
                             @NonNull java.lang.String className)
                      throws java.sql.SQLException

Specified by:

registerDataType in interface TargetDriverDialect

Overrides:

registerDataType in class GenericTargetDriverDialect

Throws:

java.sql.SQLException

setEncryptedParameter

public void setEncryptedParameter(@NonNull java.sql.PreparedStatement ps,
                                  int paramIndex,
                                  byte[] encrypted)
                           throws java.sql.SQLException

Specified by:

setEncryptedParameter in interface TargetDriverDialect

Overrides:

setEncryptedParameter in class GenericTargetDriverDialect

Throws:

java.sql.SQLException

getEncryptedBytes

public byte[] getEncryptedBytes(@NonNull java.sql.ResultSet rs,
                                java.lang.Object columnRef)
                         throws java.sql.SQLException

Specified by:

getEncryptedBytes in interface TargetDriverDialect

Overrides:

getEncryptedBytes in class GenericTargetDriverDialect

Throws:

java.sql.SQLException

updateInternalState

public void updateInternalState(@NonNull PluginService pluginService,
                                @NonNull java.util.Properties props)
                         throws java.sql.SQLException

Description copied from interface: TargetDriverDialect

Allows each target driver dialect to perform last-minute adjustments to the wrapper's internal state after the initial connection is established. This includes transferring driver-specific connection properties (e.g. PostgreSQL's currentSchema) into the wrapper's session state so they are preserved across connection switches (failover, read-write splitting, initial connection strategy, etc.).

Each dialect implementation should inspect the provided properties for driver-specific settings that affect session state and register them with the appropriate services (e.g. SessionStateService).

This method is called once after the initial connection is established in ConnectionWrapper.init().

Specified by:

updateInternalState in interface TargetDriverDialect

Overrides:

updateInternalState in class GenericTargetDriverDialect

Parameters:

pluginService - the plugin service providing access to session state and other services

props - the connection properties that may contain driver-specific settings

Throws:

java.sql.SQLException - if an error occurs while updating internal state

removeHostSelectionProperties

public java.util.Set<java.lang.String> removeHostSelectionProperties(@NonNull java.util.Properties props)

Description copied from interface: TargetDriverDialect

Removes properties that restrict which database node the target driver is willing to accept a connection to, and returns the names of the properties that were removed.

Some target drivers can be told to reject a node that does not match a role, for example PostgreSQL's targetServerType, which makes the driver verify the server is writable and fail the connection otherwise. Such a setting is meaningful for an application connection, where the driver performs its own host selection, but not for the wrapper's internal monitoring connections: those are opened against one specific node that the wrapper has already chosen, and frequently against a reader or a replica on purpose. Inheriting the restriction there makes those connections fail, silently disabling the monitor that depends on them.

Implementations must only remove properties that constrain node selection. Properties affecting authentication, encryption, timeouts, or session state must be left untouched so a monitoring connection keeps behaving like an application connection in every other respect.

The default implementation removes nothing and returns an empty set, so a target driver with no such property, and any implementation outside this library, needs no change.

Parameters:

props - the properties to adjust in place; typically a copy made for a monitoring connection.

Returns:

the names of the removed properties, empty if none applied.