OFF, DEBUG or TRACE.
- This enable the java.util.logging.Logger Level of the driver based on the following mapping
- of levels: DEBUG -> FINE, TRACE -> FINEST. This property is intended for debug the driver and
- not for general SQL query debug.
+ This property is no longer used by the driver and will be ignored.
+ All logging configuration is handled by java.util.logging.
* **loggerFile** = String
- File name output of the Logger. If set, the Logger will use a java.util.logging.FileHandler
- to write to a specified file. If the parameter is not set or the file can’t be created the
- java.util.logging.ConsoleHandler will be used instead. This parameter should be use
- together with loggerLevel.
+ This property is no longer used by the driver and will be ignored.
+ All logging configuration is handled by java.util.logging.
* **allowEncodingChanges** = boolean
diff --git a/pgjdbc/src/main/java/org/postgresql/Driver.java b/pgjdbc/src/main/java/org/postgresql/Driver.java
index 999eabc999..6b302c7593 100644
--- a/pgjdbc/src/main/java/org/postgresql/Driver.java
+++ b/pgjdbc/src/main/java/org/postgresql/Driver.java
@@ -9,10 +9,8 @@
import org.postgresql.jdbc.PgConnection;
import org.postgresql.util.DriverInfo;
-import org.postgresql.util.ExpressionProperties;
import org.postgresql.util.GT;
import org.postgresql.util.HostSpec;
-import org.postgresql.util.LogWriterHandler;
import org.postgresql.util.PGPropertyPasswordParser;
import org.postgresql.util.PGPropertyServiceParser;
import org.postgresql.util.PGPropertyUtil;
@@ -39,12 +37,8 @@
import java.util.Properties;
import java.util.Set;
import java.util.concurrent.TimeUnit;
-import java.util.logging.ConsoleHandler;
-import java.util.logging.Formatter;
import java.util.logging.Level;
import java.util.logging.Logger;
-import java.util.logging.SimpleFormatter;
-import java.util.logging.StreamHandler;
/**
* The Java SQL framework allows for multiple database drivers. Each driver should supply a class @@ -249,8 +243,6 @@ private Properties loadDefaultProperties() throws IOException { return null; } try { - // Setup java.util.logging.Logger using connection properties. - setupLoggerFromProperties(props); LOGGER.log(Level.FINE, "Connecting with URL: {0}", url); @@ -291,73 +283,13 @@ private Properties loadDefaultProperties() throws IOException { } } - // Used to check if the handler file is the same - private static @Nullable String loggerHandlerFile; - /** - *
Setup java.util.logging.Logger using connection properties.
- * - *See {@link PGProperty#LOGGER_FILE} and {@link PGProperty#LOGGER_FILE}
- * + * this is an empty method left here for graalvm + * we removed the ability to setup the logger from properties + * due to a security issue * @param props Connection Properties */ private void setupLoggerFromProperties(final Properties props) { - final String driverLogLevel = PGProperty.LOGGER_LEVEL.get(props); - if (driverLogLevel == null) { - return; // Don't mess with Logger if not set - } - if ("OFF".equalsIgnoreCase(driverLogLevel)) { - PARENT_LOGGER.setLevel(Level.OFF); - return; // Don't mess with Logger if set to OFF - } else if ("DEBUG".equalsIgnoreCase(driverLogLevel)) { - PARENT_LOGGER.setLevel(Level.FINE); - } else if ("TRACE".equalsIgnoreCase(driverLogLevel)) { - PARENT_LOGGER.setLevel(Level.FINEST); - } - - ExpressionProperties exprProps = new ExpressionProperties(props, System.getProperties()); - final String driverLogFile = PGProperty.LOGGER_FILE.get(exprProps); - if (driverLogFile != null && driverLogFile.equals(loggerHandlerFile)) { - return; // Same file output, do nothing. - } - - for (java.util.logging.Handler handlers : PARENT_LOGGER.getHandlers()) { - // Remove previously set Handlers - handlers.close(); - PARENT_LOGGER.removeHandler(handlers); - loggerHandlerFile = null; - } - - java.util.logging.Handler handler = null; - if (driverLogFile != null) { - try { - handler = new java.util.logging.FileHandler(driverLogFile); - loggerHandlerFile = driverLogFile; - } catch (Exception ex) { - System.err.println("Cannot enable FileHandler, fallback to ConsoleHandler."); - } - } - - Formatter formatter = new SimpleFormatter(); - - if ( handler == null ) { - if (DriverManager.getLogWriter() != null) { - handler = new LogWriterHandler(DriverManager.getLogWriter()); - } else if ( DriverManager.getLogStream() != null) { - handler = new StreamHandler(DriverManager.getLogStream(), formatter); - } else { - handler = new ConsoleHandler(); - } - } else { - handler.setFormatter(formatter); - } - - Level loggerLevel = PARENT_LOGGER.getLevel(); - if (loggerLevel != null) { - handler.setLevel(loggerLevel); - } - PARENT_LOGGER.setUseParentHandlers(false); - PARENT_LOGGER.addHandler(handler); } /** diff --git a/pgjdbc/src/main/java/org/postgresql/PGProperty.java b/pgjdbc/src/main/java/org/postgresql/PGProperty.java index 9f9fd3d7f7..f234c2a286 100644 --- a/pgjdbc/src/main/java/org/postgresql/PGProperty.java +++ b/pgjdbc/src/main/java/org/postgresql/PGProperty.java @@ -293,11 +293,8 @@ public enum PGProperty { "If disabled hosts are connected in the given order. If enabled hosts are chosen randomly from the set of suitable candidates"), /** - *File name output of the Logger, if set, the Logger will use a - * {@link java.util.logging.FileHandler} to write to a specified file. If the parameter is not set - * or the file can't be created the {@link java.util.logging.ConsoleHandler} will be used instead.
- * - *Parameter should be use together with {@link PGProperty#LOGGER_LEVEL}
+ * This property is no longer used by the driver and will be ignored. + * Logging is configured via java.util.logging. */ LOGGER_FILE( "loggerFile", @@ -305,19 +302,8 @@ public enum PGProperty { "File name output of the Logger"), /** - *Logger level of the driver. Allowed values: {@code OFF}, {@code DEBUG} or {@code TRACE}.
- * - *This enable the {@link java.util.logging.Logger} of the driver based on the following mapping - * of levels:
- *NOTE: The recommended approach to enable java.util.logging is using a - * {@code logging.properties} configuration file with the property - * {@code -Djava.util.logging.config.file=myfile} or if your are using an application server - * you should use the appropriate logging subsystem.
+ * This property is no longer used by the driver and will be ignored. + * Logging is configured via java.util.logging. */ LOGGER_LEVEL( "loggerLevel", diff --git a/pgjdbc/src/main/java/org/postgresql/ds/common/BaseDataSource.java b/pgjdbc/src/main/java/org/postgresql/ds/common/BaseDataSource.java index 254bfb2d3a..cd4a6b891b 100644 --- a/pgjdbc/src/main/java/org/postgresql/ds/common/BaseDataSource.java +++ b/pgjdbc/src/main/java/org/postgresql/ds/common/BaseDataSource.java @@ -1208,34 +1208,38 @@ public void setEscapeSyntaxCallMode(@Nullable String callMode) { } /** - * @return Logger Level of the JDBC Driver - * @see PGProperty#LOGGER_LEVEL + * This property is no longer used by the driver and will be ignored. + * @deprecated Configure via java.util.logging */ + @Deprecated public @Nullable String getLoggerLevel() { return PGProperty.LOGGER_LEVEL.get(properties); } /** - * @param loggerLevel of the JDBC Driver - * @see PGProperty#LOGGER_LEVEL + * This property is no longer used by the driver and will be ignored. + * @deprecated Configure via java.util.logging */ + @Deprecated public void setLoggerLevel(@Nullable String loggerLevel) { PGProperty.LOGGER_LEVEL.set(properties, loggerLevel); } /** - * @return File output of the Logger. - * @see PGProperty#LOGGER_FILE + * This property is no longer used by the driver and will be ignored. + * @deprecated Configure via java.util.logging */ + @Deprecated public @Nullable String getLoggerFile() { ExpressionProperties exprProps = new ExpressionProperties(properties, System.getProperties()); return PGProperty.LOGGER_FILE.get(exprProps); } /** - * @param loggerFile File output of the Logger. - * @see PGProperty#LOGGER_LEVEL + * This property is no longer used by the driver and will be ignored. + * @deprecated Configure via java.util.logging */ + @Deprecated public void setLoggerFile(@Nullable String loggerFile) { PGProperty.LOGGER_FILE.set(properties, loggerFile); } diff --git a/pgjdbc/src/test/java/org/postgresql/test/jdbc2/DriverTest.java b/pgjdbc/src/test/java/org/postgresql/test/jdbc2/DriverTest.java index 1e9fbb81f0..2573a75e57 100644 --- a/pgjdbc/src/test/java/org/postgresql/test/jdbc2/DriverTest.java +++ b/pgjdbc/src/test/java/org/postgresql/test/jdbc2/DriverTest.java @@ -16,8 +16,6 @@ import org.postgresql.PGEnvironment; import org.postgresql.PGProperty; import org.postgresql.test.TestUtil; -import org.postgresql.util.LogWriterHandler; -import org.postgresql.util.NullOutputStream; import org.postgresql.util.URLCoder; import org.junit.Test; @@ -29,7 +27,6 @@ import java.io.ByteArrayOutputStream; import java.io.PrintStream; -import java.io.PrintWriter; import java.lang.reflect.Method; import java.net.URL; import java.nio.file.Files; @@ -40,8 +37,6 @@ import java.util.ArrayList; import java.util.Collections; import java.util.Properties; -import java.util.logging.Handler; -import java.util.logging.Logger; /* * Tests the dynamically created class org.postgresql.Driver @@ -497,68 +492,6 @@ public void testRegistration() throws Exception { fail("Driver has not been found in DriverManager's list but it should be registered"); } - @Test - public void testSetLogWriter() throws Exception { - - // this is a dummy to make sure TestUtil is initialized - Connection con = DriverManager.getConnection(TestUtil.getURL(), TestUtil.getUser(), TestUtil.getPassword()); - con.close(); - String loggerLevel = System.getProperty("loggerLevel"); - String loggerFile = System.getProperty("loggerFile"); - - PrintWriter prevLog = DriverManager.getLogWriter(); - try { - PrintWriter printWriter = new PrintWriter(new NullOutputStream(System.err)); - DriverManager.setLogWriter(printWriter); - assertEquals(DriverManager.getLogWriter(), printWriter); - System.clearProperty("loggerFile"); - System.clearProperty("loggerLevel"); - Properties props = new Properties(); - props.setProperty("user", TestUtil.getUser()); - props.setProperty("password", TestUtil.getPassword()); - props.setProperty("loggerLevel", "DEBUG"); - con = DriverManager.getConnection(TestUtil.getURL(), props); - - Logger logger = Logger.getLogger("org.postgresql"); - Handler[] handlers = logger.getHandlers(); - assertTrue(handlers[0] instanceof LogWriterHandler ); - con.close(); - } finally { - DriverManager.setLogWriter(prevLog); - setProperty("loggerLevel", loggerLevel); - setProperty("loggerFile", loggerFile); - } - } - - @Test - public void testSetLogStream() throws Exception { - // this is a dummy to make sure TestUtil is initialized - Connection con = DriverManager.getConnection(TestUtil.getURL(), TestUtil.getUser(), TestUtil.getPassword()); - con.close(); - String loggerLevel = System.getProperty("loggerLevel"); - String loggerFile = System.getProperty("loggerFile"); - - try { - DriverManager.setLogStream(new NullOutputStream(System.err)); - System.clearProperty("loggerFile"); - System.clearProperty("loggerLevel"); - Properties props = new Properties(); - props.setProperty("user", TestUtil.getUser()); - props.setProperty("password", TestUtil.getPassword()); - props.setProperty("loggerLevel", "DEBUG"); - con = DriverManager.getConnection(TestUtil.getURL(), props); - - Logger logger = Logger.getLogger("org.postgresql"); - Handler []handlers = logger.getHandlers(); - assertTrue( handlers[0] instanceof LogWriterHandler ); - con.close(); - } finally { - DriverManager.setLogStream(null); - setProperty("loggerLevel", loggerLevel); - setProperty("loggerFile", loggerFile); - } - } - @Test public void testSystemErrIsNotClosedWhenCreatedMultipleConnections() throws Exception { TestUtil.initDriver(); diff --git a/pgjdbc/src/test/java/org/postgresql/test/jdbc2/PGPropertyTest.java b/pgjdbc/src/test/java/org/postgresql/test/jdbc2/PGPropertyTest.java index 078930fbba..f3e31287b4 100644 --- a/pgjdbc/src/test/java/org/postgresql/test/jdbc2/PGPropertyTest.java +++ b/pgjdbc/src/test/java/org/postgresql/test/jdbc2/PGPropertyTest.java @@ -8,7 +8,6 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertNull; import static org.junit.Assert.assertSame; import static org.junit.Assert.assertTrue; @@ -215,15 +214,6 @@ public void testPresenceCheck() { assertFalse(PGProperty.READ_ONLY.isPresent(empty)); } - @Test - public void testNullValue() { - Properties empty = new Properties(); - assertNull(PGProperty.LOGGER_LEVEL.getSetString(empty)); - Properties withLogging = new Properties(); - withLogging.setProperty(PGProperty.LOGGER_LEVEL.getName(), "OFF"); - assertNotNull(PGProperty.LOGGER_LEVEL.getSetString(withLogging)); - } - @Test public void testEncodedUrlValues() { String databaseName = "d&a%ta+base"; diff --git a/pgjdbc/src/test/java/org/postgresql/test/jdbc4/Jdbc4TestSuite.java b/pgjdbc/src/test/java/org/postgresql/test/jdbc4/Jdbc4TestSuite.java index 92d6484918..908f5f88f0 100644 --- a/pgjdbc/src/test/java/org/postgresql/test/jdbc4/Jdbc4TestSuite.java +++ b/pgjdbc/src/test/java/org/postgresql/test/jdbc4/Jdbc4TestSuite.java @@ -24,7 +24,6 @@ DatabaseMetaDataTest.class, IsValidTest.class, JsonbTest.class, - LogTest.class, PGCopyInputStreamTest.class, UUIDTest.class, WrapperTest.class, diff --git a/pgjdbc/src/test/java/org/postgresql/test/jdbc4/LogTest.java b/pgjdbc/src/test/java/org/postgresql/test/jdbc4/LogTest.java deleted file mode 100644 index 49d623f7c1..0000000000 --- a/pgjdbc/src/test/java/org/postgresql/test/jdbc4/LogTest.java +++ /dev/null @@ -1,78 +0,0 @@ -/* - * Copyright (c) 2007, PostgreSQL Global Development Group - * See the LICENSE file in the project root for more information. - */ - -package org.postgresql.test.jdbc4; - -import org.postgresql.PGProperty; -import org.postgresql.test.TestUtil; -import org.postgresql.test.jdbc2.BaseTest4; - -import org.junit.Assert; -import org.junit.Assume; -import org.junit.Test; -import org.junit.runner.RunWith; -import org.junit.runners.Parameterized; - -import java.sql.Array; -import java.sql.PreparedStatement; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Properties; - -@RunWith(Parameterized.class) -public class LogTest extends BaseTest4 { - - private String oldLevel; - - public LogTest(BinaryMode binaryMode) { - setBinaryMode(binaryMode); - long maxMemory = Runtime.getRuntime().maxMemory(); - if (maxMemory < 6L * 1024 * 1024 * 1024) { - // TODO: add hamcrest matches and replace with "greaterThan" or something like that - Assume.assumeTrue( - "The test requires -Xmx6g or more. MaxMemory is " + (maxMemory / 1024.0 / 1024) + " MiB", - false); - } - } - - @Parameterized.Parameters(name = "binary = {0}") - public static Iterable