Class ConnectionFactoryImpl

java.lang.Object

org.postgresql.core.ConnectionFactory

org.postgresql.core.v3.ConnectionFactoryImpl

public class ConnectionFactoryImpl
extends ConnectionFactory

ConnectionFactory implementation for version 3 (7.4+) connections.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ConnectionFactoryImpl.StartupParam

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	AUTH_REQ_CRYPT
private static final int	AUTH_REQ_GSS
private static final int	AUTH_REQ_GSS_CONTINUE
private static final int	AUTH_REQ_KRB4
private static final int	AUTH_REQ_KRB5
private static final int	AUTH_REQ_MD5
private static final int	AUTH_REQ_OK
private static final int	AUTH_REQ_PASSWORD
private static final int	AUTH_REQ_SASL
private static final int	AUTH_REQ_SASL_CONTINUE
private static final int	AUTH_REQ_SASL_FINAL
private static final int	AUTH_REQ_SCM
private static final int	AUTH_REQ_SSPI
private static final String	IN_HOT_STANDBY
private static final Logger	LOGGER

Constructor Summary

Constructors

Constructor	Description
ConnectionFactoryImpl()

Method Summary

Modifier and Type	Method	Description
private static String	createPostgresTimeZone()	Convert Java time zone to postgres time zone.
private static ISSPIClient	createSSPI(PGStream pgStream, String spnServiceClass, boolean enableNegotiate)
private static void	doAuthentication(PGStream pgStream, String host, String user, Properties info)
private static PGStream	enableGSSEncrypted(PGStream pgStream, GSSEncMode gssEncMode, String host, Properties info, int connectTimeout)
private static PGStream	enableSSL(PGStream pgStream, SslMode sslMode, Properties info, int connectTimeout)
private static String	getAuthenticationMethodName(int authReq)
private static List<ConnectionFactoryImpl.StartupParam>	getParametersForStartup(String user, String database, Properties info)
private static boolean	isPrimary(QueryExecutor queryExecutor)	Since PG14 there is GUC_REPORT ParamStatus in_hot_standby which is set to "on" when the server is in archive recovery or standby mode.
private static void	log(Level level, String msg, Throwable thrown, Object... params)
QueryExecutor	openConnectionImpl(HostSpec[] hostSpecs, Properties info)	Implementation of ConnectionFactory.openConnection(HostSpec[], Properties) for a particular protocol version.
private static void	runInitialQueries(QueryExecutor queryExecutor, Properties info)
private static void	sendStartupPacket(PGStream pgStream, ProtocolVersion protocolVersion, List<ConnectionFactoryImpl.StartupParam> params)
private PGStream	tryConnect(Properties info, SocketFactory socketFactory, HostSpec hostSpec, SslMode sslMode, GSSEncMode gssEncMode)

Methods inherited from class ConnectionFactory

closeStream, openConnection

Methods inherited from class Object

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

Field Details

LOGGER

private static final Logger LOGGER

AUTH_REQ_OK

private static final int AUTH_REQ_OK

See Also:

• Constant Field Values

AUTH_REQ_KRB4

private static final int AUTH_REQ_KRB4

See Also:

• Constant Field Values

AUTH_REQ_KRB5

private static final int AUTH_REQ_KRB5

See Also:

• Constant Field Values

AUTH_REQ_PASSWORD

private static final int AUTH_REQ_PASSWORD

See Also:

• Constant Field Values

AUTH_REQ_CRYPT

private static final int AUTH_REQ_CRYPT

See Also:

• Constant Field Values

AUTH_REQ_MD5

private static final int AUTH_REQ_MD5

See Also:

• Constant Field Values

AUTH_REQ_SCM

private static final int AUTH_REQ_SCM

See Also:

• Constant Field Values

AUTH_REQ_GSS

private static final int AUTH_REQ_GSS

See Also:

• Constant Field Values

AUTH_REQ_GSS_CONTINUE

private static final int AUTH_REQ_GSS_CONTINUE

See Also:

• Constant Field Values

AUTH_REQ_SSPI

private static final int AUTH_REQ_SSPI

See Also:

• Constant Field Values

AUTH_REQ_SASL

private static final int AUTH_REQ_SASL

See Also:

• Constant Field Values

AUTH_REQ_SASL_CONTINUE

private static final int AUTH_REQ_SASL_CONTINUE

See Also:

• Constant Field Values

AUTH_REQ_SASL_FINAL

private static final int AUTH_REQ_SASL_FINAL

See Also:

• Constant Field Values

IN_HOT_STANDBY

private static final String IN_HOT_STANDBY

See Also:

• Constant Field Values

Constructor Details

ConnectionFactoryImpl

public ConnectionFactoryImpl()

Method Details

createSSPI

private static ISSPIClient createSSPI(PGStream pgStream,
 String spnServiceClass,
 boolean enableNegotiate)

tryConnect

private PGStream tryConnect(Properties info,
 SocketFactory socketFactory,
 HostSpec hostSpec,
 SslMode sslMode,
 GSSEncMode gssEncMode)
                     throws SQLException,
IOException

Throws:

SQLException

IOException

openConnectionImpl

public QueryExecutor openConnectionImpl(HostSpec[] hostSpecs,
 Properties info)
                                 throws SQLException

Description copied from class: ConnectionFactory

Implementation of ConnectionFactory.openConnection(HostSpec[], Properties) for a particular protocol version. Implemented by subclasses of ConnectionFactory.

Specified by:

openConnectionImpl in class ConnectionFactory

Parameters:

hostSpecs - at least one host and port to connect to; multiple elements for round-robin failover

info - extra properties controlling the connection; notably, "password" if present supplies the password to authenticate with.

Returns:

the new, initialized, connection, or null if this protocol version is not supported by the server.

Throws:

SQLException - if the connection could not be established for a reason other than protocol version incompatibility.

getParametersForStartup

private static List<ConnectionFactoryImpl.StartupParam> getParametersForStartup(String user,
 String database,
 Properties info)

log

private static void log(Level level,
 String msg,
 Throwable thrown,
 Object... params)

createPostgresTimeZone

private static String createPostgresTimeZone()

Convert Java time zone to postgres time zone. All others stay the same except that GMT+nn changes to GMT-nn and vise versa. If you provide GMT+/-nn postgres uses POSIX rules which has a positive sign for west of Greenwich JAVA uses ISO rules which the positive sign is east of Greenwich To make matters more interesting postgres will always report in ISO

Returns:

The current JVM time zone in postgresql format.

enableGSSEncrypted

private static PGStream enableGSSEncrypted(PGStream pgStream,
 GSSEncMode gssEncMode,
 String host,
 Properties info,
 int connectTimeout)
                                    throws IOException,
PSQLException

Throws:

IOException

PSQLException

enableSSL

private static PGStream enableSSL(PGStream pgStream,
 SslMode sslMode,
 Properties info,
 int connectTimeout)
                           throws IOException,
PSQLException

Throws:

IOException

PSQLException

sendStartupPacket

private static void sendStartupPacket(PGStream pgStream,
 ProtocolVersion protocolVersion,
 List<ConnectionFactoryImpl.StartupParam> params)
                               throws SQLException,
IOException

Throws:

SQLException

IOException

getAuthenticationMethodName

private static String getAuthenticationMethodName(int authReq)

doAuthentication

private static void doAuthentication(PGStream pgStream,
 String host,
 String user,
 Properties info)
                              throws IOException,
SQLException

Throws:

IOException

SQLException

runInitialQueries

private static void runInitialQueries(QueryExecutor queryExecutor,
 Properties info)
                               throws SQLException

Throws:

SQLException

isPrimary

private static boolean isPrimary(QueryExecutor queryExecutor)
                          throws SQLException,
IOException

Since PG14 there is GUC_REPORT ParamStatus in_hot_standby which is set to "on" when the server is in archive recovery or standby mode. In driver's lingo such server is called HostRequirement.secondary. Previously transaction_read_only was used as a workable substitute. However transaction_read_only could have been manually overridden on the primary server by database user leading to a false positives: ie server is effectively read-only but technically is "primary" (not in a recovery/standby mode).

This method checks whether in_hot_standby GUC was reported by the server during initial connection:

• in_hot_standby was reported and the value was "on" then the server is a replica and database is read-only by definition, false is returned.
• in_hot_standby was reported and the value was "off" then the server is indeed primary but database may be in read-only mode nevertheless. We proceed to conservatively show transaction_read_only since users may not be expecting a readonly connection for targetServerType=primary
• If in_hot_standby has not been reported we fallback to pre v14 behavior.

Do not confuse hot_standby and in_hot_standby ParamStatuses

Throws:

SQLException

IOException

See Also:

• GUC_REPORT documentation
• Hot standby documentation
• in_hot_standby patch thread v10
• in_hot_standby patch thread v14