GUACAMOLE-919: More updates to style and comments.

This commit is contained in:
Douglas Heriot
2020-07-15 18:46:45 +10:00
parent 6cf9787f7b
commit 20b1dbf00f
3 changed files with 26 additions and 17 deletions

View File

@@ -73,7 +73,10 @@ public class PostgreSQLAuthenticationProviderModule implements Module {
// Only set if > 0. Underlying backend does not take 0 as not-set. // Only set if > 0. Underlying backend does not take 0 as not-set.
int defaultStatementTimeout = environment.getPostgreSQLDefaultStatementTimeout(); int defaultStatementTimeout = environment.getPostgreSQLDefaultStatementTimeout();
if (defaultStatementTimeout > 0) { if (defaultStatementTimeout > 0) {
myBatisProperties.setProperty("mybatis.configuration.defaultStatementTimeout", String.valueOf(defaultStatementTimeout)); myBatisProperties.setProperty(
"mybatis.configuration.defaultStatementTimeout",
String.valueOf(defaultStatementTimeout)
);
} }
// Use UTF-8 in database // Use UTF-8 in database
@@ -117,7 +120,10 @@ public class PostgreSQLAuthenticationProviderModule implements Module {
} }
// Handle case where TCP connection to database is silently dropped // Handle case where TCP connection to database is silently dropped
driverProperties.setProperty("socketTimeout", String.valueOf(environment.getPostgreSQLSocketTimeout())); driverProperties.setProperty(
"socketTimeout",
String.valueOf(environment.getPostgreSQLSocketTimeout())
);
} }

View File

@@ -50,17 +50,14 @@ public class PostgreSQLEnvironment extends JDBCEnvironment {
/** /**
* The default number of seconds the driver will wait for a response from * The default number of seconds the driver will wait for a response from
* the database. A value of 0 (the default) means the timeout is disabled. * the database, before aborting the query.
* A value of 0 (the default) means the timeout is disabled.
*/ */
private static final int DEFAULT_STATEMENT_TIMEOUT = 0; private static final int DEFAULT_STATEMENT_TIMEOUT = 0;
/** /**
* The default timeout (in seconds) used for socket read operations. * The default number of seconds to wait for socket read operations.
* If reading from the server takes longer than this value, the * A value of 0 (the default) means the timeout is disabled.
* connection is closed. This can be used to handle network problems
* such as a dropped connection to the database. Similar to
* DEFAULT_STATEMENT_TIMEOUT, it will also abort queries that take too
* long. The value 0 (the default) means the timeout is disabled.
*/ */
private static final int DEFAULT_SOCKET_TIMEOUT = 0; private static final int DEFAULT_SOCKET_TIMEOUT = 0;
@@ -268,7 +265,7 @@ public class PostgreSQLEnvironment extends JDBCEnvironment {
/** /**
* Returns the defaultStatementTimeout set for PostgreSQL connections. * Returns the defaultStatementTimeout set for PostgreSQL connections.
* If unspecified, this will be the default 0, * If unspecified, this will default to 0,
* and should not be passed through to the backend. * and should not be passed through to the backend.
* *
* @return * @return
@@ -286,7 +283,7 @@ public class PostgreSQLEnvironment extends JDBCEnvironment {
/** /**
* Returns the socketTimeout property to set on PostgreSQL connections. * Returns the socketTimeout property to set on PostgreSQL connections.
* If unspecified, this will be the default to 0 (no timeout) * If unspecified, this will default to 0 (no timeout)
* *
* @return * @return
* The socketTimeout to use when waiting on read operations (in seconds) * The socketTimeout to use when waiting on read operations (in seconds)

View File

@@ -95,11 +95,12 @@ public class PostgreSQLGuacamoleProperties {
}; };
/** /**
* The number of seconds the driver will wait for * The number of seconds the driver will wait for a response from
* a response from the database. * the database, before aborting the query.
* A value of 0 (the default) means the timeout is disabled.
*/ */
public static final IntegerGuacamoleProperty public static final IntegerGuacamoleProperty
POSTGRESQL_DEFAULT_STATEMENT_TIMEOUT = new IntegerGuacamoleProperty(){ POSTGRESQL_DEFAULT_STATEMENT_TIMEOUT = new IntegerGuacamoleProperty() {
@Override @Override
public String getName() { return "postgresql-default-statement-timeout"; } public String getName() { return "postgresql-default-statement-timeout"; }
@@ -107,11 +108,16 @@ public class PostgreSQLGuacamoleProperties {
}; };
/** /**
* The number of seconds the driver will wait in a read() call * The number of seconds to wait for socket read operations.
* on the TCP connection to the database. * If reading from the server takes longer than this value, the
* connection will be closed. This can be used to handle network problems
* such as a dropped connection to the database. Similar to
* postgresql-default-statement-timeout, it will have the effect of
* aborting queries that take too long.
* A value of 0 (the default) means the timeout is disabled.
*/ */
public static final IntegerGuacamoleProperty public static final IntegerGuacamoleProperty
POSTGRESQL_SOCKET_TIMEOUT = new IntegerGuacamoleProperty(){ POSTGRESQL_SOCKET_TIMEOUT = new IntegerGuacamoleProperty() {
@Override @Override
public String getName() { return "postgresql-socket-timeout"; } public String getName() { return "postgresql-socket-timeout"; }