This is an automated email from the ASF dual-hosted git repository. markt pushed a commit to branch 8.5.x in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/8.5.x by this push: new 210cf32 Deprecate LOGGING_CONFIG and replace with CATALINA_LOGGING_CONFIG 210cf32 is described below commit 210cf32c5789eff6ad99b84c6976bc200422de05 Author: Mark Thomas <ma...@apache.org> AuthorDate: Wed Apr 1 17:19:25 2020 +0100 Deprecate LOGGING_CONFIG and replace with CATALINA_LOGGING_CONFIG Backwards compatibility is retained --- bin/catalina.bat | 30 +++++++++++++++++++++--------- bin/catalina.sh | 35 ++++++++++++++++++++++++----------- bin/daemon.sh | 19 ++++++++++++++----- webapps/docs/changelog.xml | 6 ++++++ 4 files changed, 65 insertions(+), 25 deletions(-) diff --git a/bin/catalina.bat b/bin/catalina.bat index eaced8d..bf0f7e0 100755 --- a/bin/catalina.bat +++ b/bin/catalina.bat @@ -94,9 +94,14 @@ rem JSSE_OPTS (Optional) Java runtime options used to control the TLS rem implementation when JSSE is used. Default is: rem "-Djdk.tls.ephemeralDHKeySize=2048" rem -rem LOGGING_CONFIG (Optional) Override Tomcat's logging config file +rem CATALINA_LOGGING_CONFIG (Optional) Override Tomcat's logging config file rem Example (all one line) -rem set LOGGING_CONFIG="-Djava.util.logging.config.file=%CATALINA_BASE%\conf\logging.properties" +rem set CATALINA_LOGGING_CONFIG="-Djava.util.logging.config.file=%CATALINA_BASE%\conf\logging.properties" +rem +rem LOGGING_CONFIG Deprecated +rem Use CATALINA_LOGGING_CONFIG +rem This is only used if CATALINA_LOGGING_CONFIG is not set +rem and LOGGING_CONFIG starts with "-D..." rem rem LOGGING_MANAGER (Optional) Override Tomcat's logging manager rem Example (all one line) @@ -214,10 +219,17 @@ rem Register custom URL handlers rem Do this here so custom URL handles (specifically 'war:...') can be used in the security policy set "JAVA_OPTS=%JAVA_OPTS% -Djava.protocol.handler.pkgs=org.apache.catalina.webresources" -if not "%LOGGING_CONFIG%" == "" goto noJuliConfig -set LOGGING_CONFIG=-Dnop +rem Check for the deprecated LOGGING_CONFIG +rem Only use it if CATALINA_LOGGING_CONFIG is not set and LOGGING_CONFIG starts with "-D..." +if not "%LOGGING_CONFIG:~0,2%"=="-D" goto noLoggingDeprecation +if not "%CATALINA_LOGGING_CONFIG%" == "" goto noLoggingDeprecation +set "CATALINA_LOGGING_CONFIG=%LOGGING_CONFIG%" +:noLoggingDeprecation + +if not "%CATALINA_LOGGING_CONFIG%" == "" goto noJuliConfig +set CATALINA_LOGGING_CONFIG=-Dnop if not exist "%CATALINA_BASE%\conf\logging.properties" goto noJuliConfig -set LOGGING_CONFIG=-Djava.util.logging.config.file="%CATALINA_BASE%\conf\logging.properties" +set CATALINA_LOGGING_CONFIG=-Djava.util.logging.config.file="%CATALINA_BASE%\conf\logging.properties" :noJuliConfig if not "%LOGGING_MANAGER%" == "" goto noJuliManager @@ -358,17 +370,17 @@ goto setArgs rem Execute Java with the applicable properties if not "%JPDA%" == "" goto doJpda if not "%SECURITY_POLICY_FILE%" == "" goto doSecurity -%_EXECJAVA% %LOGGING_CONFIG% %LOGGING_MANAGER% %JAVA_OPTS% %CATALINA_OPTS% %DEBUG_OPTS% -D%ENDORSED_PROP%="%JAVA_ENDORSED_DIRS%" -classpath "%CLASSPATH%" -Dcatalina.base="%CATALINA_BASE%" -Dcatalina.home="%CATALINA_HOME%" -Djava.io.tmpdir="%CATALINA_TMPDIR%" %MAINCLASS% %CMD_LINE_ARGS% %ACTION% +%_EXECJAVA% %CATALINA_LOGGING_CONFIG% %LOGGING_MANAGER% %JAVA_OPTS% %CATALINA_OPTS% %DEBUG_OPTS% -D%ENDORSED_PROP%="%JAVA_ENDORSED_DIRS%" -classpath "%CLASSPATH%" -Dcatalina.base="%CATALINA_BASE%" -Dcatalina.home="%CATALINA_HOME%" -Djava.io.tmpdir="%CATALINA_TMPDIR%" %MAINCLASS% %CMD_LINE_ARGS% %ACTION% goto end :doSecurity -%_EXECJAVA% %LOGGING_CONFIG% %LOGGING_MANAGER% %JAVA_OPTS% %CATALINA_OPTS% %DEBUG_OPTS% -D%ENDORSED_PROP%="%JAVA_ENDORSED_DIRS%" -classpath "%CLASSPATH%" -Djava.security.manager -Djava.security.policy=="%SECURITY_POLICY_FILE%" -Dcatalina.base="%CATALINA_BASE%" -Dcatalina.home="%CATALINA_HOME%" -Djava.io.tmpdir="%CATALINA_TMPDIR%" %MAINCLASS% %CMD_LINE_ARGS% %ACTION% +%_EXECJAVA% %CATALINA_LOGGING_CONFIG% %LOGGING_MANAGER% %JAVA_OPTS% %CATALINA_OPTS% %DEBUG_OPTS% -D%ENDORSED_PROP%="%JAVA_ENDORSED_DIRS%" -classpath "%CLASSPATH%" -Djava.security.manager -Djava.security.policy=="%SECURITY_POLICY_FILE%" -Dcatalina.base="%CATALINA_BASE%" -Dcatalina.home="%CATALINA_HOME%" -Djava.io.tmpdir="%CATALINA_TMPDIR%" %MAINCLASS% %CMD_LINE_ARGS% %ACTION% goto end :doJpda if not "%SECURITY_POLICY_FILE%" == "" goto doSecurityJpda -%_EXECJAVA% %LOGGING_CONFIG% %LOGGING_MANAGER% %JAVA_OPTS% %JPDA_OPTS% %CATALINA_OPTS% %DEBUG_OPTS% -D%ENDORSED_PROP%="%JAVA_ENDORSED_DIRS%" -classpath "%CLASSPATH%" -Dcatalina.base="%CATALINA_BASE%" -Dcatalina.home="%CATALINA_HOME%" -Djava.io.tmpdir="%CATALINA_TMPDIR%" %MAINCLASS% %CMD_LINE_ARGS% %ACTION% +%_EXECJAVA% %CATALINA_LOGGING_CONFIG% %LOGGING_MANAGER% %JAVA_OPTS% %JPDA_OPTS% %CATALINA_OPTS% %DEBUG_OPTS% -D%ENDORSED_PROP%="%JAVA_ENDORSED_DIRS%" -classpath "%CLASSPATH%" -Dcatalina.base="%CATALINA_BASE%" -Dcatalina.home="%CATALINA_HOME%" -Djava.io.tmpdir="%CATALINA_TMPDIR%" %MAINCLASS% %CMD_LINE_ARGS% %ACTION% goto end :doSecurityJpda -%_EXECJAVA% %LOGGING_CONFIG% %LOGGING_MANAGER% %JAVA_OPTS% %JPDA_OPTS% %CATALINA_OPTS% %DEBUG_OPTS% -D%ENDORSED_PROP%="%JAVA_ENDORSED_DIRS%" -classpath "%CLASSPATH%" -Djava.security.manager -Djava.security.policy=="%SECURITY_POLICY_FILE%" -Dcatalina.base="%CATALINA_BASE%" -Dcatalina.home="%CATALINA_HOME%" -Djava.io.tmpdir="%CATALINA_TMPDIR%" %MAINCLASS% %CMD_LINE_ARGS% %ACTION% +%_EXECJAVA% %CATALINA_LOGGING_CONFIG% %LOGGING_MANAGER% %JAVA_OPTS% %JPDA_OPTS% %CATALINA_OPTS% %DEBUG_OPTS% -D%ENDORSED_PROP%="%JAVA_ENDORSED_DIRS%" -classpath "%CLASSPATH%" -Djava.security.manager -Djava.security.policy=="%SECURITY_POLICY_FILE%" -Dcatalina.base="%CATALINA_BASE%" -Dcatalina.home="%CATALINA_HOME%" -Djava.io.tmpdir="%CATALINA_TMPDIR%" %MAINCLASS% %CMD_LINE_ARGS% %ACTION% goto end :end diff --git a/bin/catalina.sh b/bin/catalina.sh index 2fabcd1..4e0b8bf 100755 --- a/bin/catalina.sh +++ b/bin/catalina.sh @@ -94,9 +94,14 @@ # of the catalina startup java process, when start (fork) is # used # -# LOGGING_CONFIG (Optional) Override Tomcat's logging config file +# CATALINA_LOGGING_CONFIG (Optional) Override Tomcat's logging config file # Example (all one line) -# LOGGING_CONFIG="-Djava.util.logging.config.file=$CATALINA_BASE/conf/logging.properties" +# CATALINA_LOGGING_CONFIG="-Djava.util.logging.config.file=$CATALINA_BASE/conf/logging.properties" +# +# LOGGING_CONFIG Deprecated +# Use CATALINA_LOGGING_CONFIG +# This is only used if CATALINA_LOGGING_CONFIG is not set +# and LOGGING_CONFIG starts with "-D..." # # LOGGING_MANAGER (Optional) Override Tomcat's logging manager # Example (all one line) @@ -255,13 +260,21 @@ JAVA_OPTS="$JAVA_OPTS $JSSE_OPTS" # Do this here so custom URL handles (specifically 'war:...') can be used in the security policy JAVA_OPTS="$JAVA_OPTS -Djava.protocol.handler.pkgs=org.apache.catalina.webresources" +# Check for the deprecated LOGGING_CONFIG +# Only use it if CATALINA_LOGGING_CONFIG is not set and LOGGING_CONFIG starts with "-D..." +if [ -z "$CATALINA_LOGGING_CONFIG" ]; then + if [ "${LOGGING_CONFIG#*-D}" != "$LOGGING_CONFIG" ]; then + CATALINA_LOGGING_CONFIG="$LOGGING_CONFIG" + fi +fi + # Set juli LogManager config file if it is present and an override has not been issued -if [ -z "$LOGGING_CONFIG" ]; then +if [ -z "$CATALINA_LOGGING_CONFIG" ]; then if [ -r "$CATALINA_BASE"/conf/logging.properties ]; then - LOGGING_CONFIG="-Djava.util.logging.config.file=$CATALINA_BASE/conf/logging.properties" + CATALINA_LOGGING_CONFIG="-Djava.util.logging.config.file=$CATALINA_BASE/conf/logging.properties" else # Bugzilla 45585 - LOGGING_CONFIG="-Dnop" + CATALINA_LOGGING_CONFIG="-Dnop" fi fi @@ -358,7 +371,7 @@ if [ "$1" = "debug" ] ; then echo "Using Security Manager" fi shift - exec "$_RUNJDB" "$LOGGING_CONFIG" $LOGGING_MANAGER $JAVA_OPTS $CATALINA_OPTS \ + exec "$_RUNJDB" "$CATALINA_LOGGING_CONFIG" $LOGGING_MANAGER $JAVA_OPTS $CATALINA_OPTS \ -D$ENDORSED_PROP="$JAVA_ENDORSED_DIRS" \ -classpath "$CLASSPATH" \ -sourcepath "$CATALINA_HOME"/../../java \ @@ -369,7 +382,7 @@ if [ "$1" = "debug" ] ; then -Djava.io.tmpdir="$CATALINA_TMPDIR" \ org.apache.catalina.startup.Bootstrap "$@" start else - exec "$_RUNJDB" "$LOGGING_CONFIG" $LOGGING_MANAGER $JAVA_OPTS $CATALINA_OPTS \ + exec "$_RUNJDB" "$CATALINA_LOGGING_CONFIG" $LOGGING_MANAGER $JAVA_OPTS $CATALINA_OPTS \ -D$ENDORSED_PROP="$JAVA_ENDORSED_DIRS" \ -classpath "$CLASSPATH" \ -sourcepath "$CATALINA_HOME"/../../java \ @@ -388,7 +401,7 @@ elif [ "$1" = "run" ]; then echo "Using Security Manager" fi shift - eval exec "\"$_RUNJAVA\"" "\"$LOGGING_CONFIG\"" $LOGGING_MANAGER "$JAVA_OPTS" "$CATALINA_OPTS" \ + eval exec "\"$_RUNJAVA\"" "\"$CATALINA_LOGGING_CONFIG\"" $LOGGING_MANAGER "$JAVA_OPTS" "$CATALINA_OPTS" \ -D$ENDORSED_PROP="\"$JAVA_ENDORSED_DIRS\"" \ -classpath "\"$CLASSPATH\"" \ -Djava.security.manager \ @@ -398,7 +411,7 @@ elif [ "$1" = "run" ]; then -Djava.io.tmpdir="\"$CATALINA_TMPDIR\"" \ org.apache.catalina.startup.Bootstrap "$@" start else - eval exec "\"$_RUNJAVA\"" "\"$LOGGING_CONFIG\"" $LOGGING_MANAGER "$JAVA_OPTS" "$CATALINA_OPTS" \ + eval exec "\"$_RUNJAVA\"" "\"$CATALINA_LOGGING_CONFIG\"" $LOGGING_MANAGER "$JAVA_OPTS" "$CATALINA_OPTS" \ -D$ENDORSED_PROP="\"$JAVA_ENDORSED_DIRS\"" \ -classpath "\"$CLASSPATH\"" \ -Dcatalina.base="\"$CATALINA_BASE\"" \ @@ -456,7 +469,7 @@ elif [ "$1" = "start" ] ; then echo "Using Security Manager" fi shift - eval $_NOHUP "\"$_RUNJAVA\"" "\"$LOGGING_CONFIG\"" $LOGGING_MANAGER "$JAVA_OPTS" "$CATALINA_OPTS" \ + eval $_NOHUP "\"$_RUNJAVA\"" "\"$CATALINA_LOGGING_CONFIG\"" $LOGGING_MANAGER "$JAVA_OPTS" "$CATALINA_OPTS" \ -D$ENDORSED_PROP="\"$JAVA_ENDORSED_DIRS\"" \ -classpath "\"$CLASSPATH\"" \ -Djava.security.manager \ @@ -468,7 +481,7 @@ elif [ "$1" = "start" ] ; then >> "$CATALINA_OUT" 2>&1 "&" else - eval $_NOHUP "\"$_RUNJAVA\"" "\"$LOGGING_CONFIG\"" $LOGGING_MANAGER "$JAVA_OPTS" "$CATALINA_OPTS" \ + eval $_NOHUP "\"$_RUNJAVA\"" "\"$CATALINA_LOGGING_CONFIG\"" $LOGGING_MANAGER "$JAVA_OPTS" "$CATALINA_OPTS" \ -D$ENDORSED_PROP="\"$JAVA_ENDORSED_DIRS\"" \ -classpath "\"$CLASSPATH\"" \ -Dcatalina.base="\"$CATALINA_BASE\"" \ diff --git a/bin/daemon.sh b/bin/daemon.sh index a44a1ed..6038e1d 100755 --- a/bin/daemon.sh +++ b/bin/daemon.sh @@ -148,13 +148,22 @@ if [ -r "$CATALINA_BASE/bin/tomcat-juli.jar" ] ; then else CLASSPATH="$CLASSPATH:$CATALINA_HOME/bin/tomcat-juli.jar" fi + +# Check for the deprecated LOGGING_CONFIG +# Only use it if CATALINA_LOGGING_CONFIG is not set and LOGGING_CONFIG starts with "-D..." +if [ -z "$CATALINA_LOGGING_CONFIG" ]; then + if [ "${LOGGING_CONFIG#*-D}" != "$LOGGING_CONFIG" ]; then + CATALINA_LOGGING_CONFIG="$LOGGING_CONFIG" + fi +fi + # Set juli LogManager config file if it is present and an override has not been issued -if [ -z "$LOGGING_CONFIG" ]; then +if [ -z "$CATALINA_LOGGING_CONFIG" ]; then if [ -r "$CATALINA_BASE/conf/logging.properties" ]; then - LOGGING_CONFIG="-Djava.util.logging.config.file=$CATALINA_BASE/conf/logging.properties" + CATALINA_LOGGING_CONFIG="-Djava.util.logging.config.file=$CATALINA_BASE/conf/logging.properties" else # Bugzilla 45585 - LOGGING_CONFIG="-Dnop" + CATALINA_LOGGING_CONFIG="-Dnop" fi fi @@ -214,7 +223,7 @@ case "$1" in -outfile "\"&1\"" \ -errfile "\"&2\"" \ -classpath "\"$CLASSPATH\"" \ - "\"$LOGGING_CONFIG\"" "$JAVA_OPTS" "$CATALINA_OPTS" \ + "\"$CATALINA_LOGGING_CONFIG\"" "$JAVA_OPTS" "$CATALINA_OPTS" \ -D$ENDORSED_PROP="\"$JAVA_ENDORSED_DIRS\"" \ -Dcatalina.base="\"$CATALINA_BASE\"" \ -Dcatalina.home="\"$CATALINA_HOME\"" \ @@ -233,7 +242,7 @@ case "$1" in -outfile "\"$CATALINA_OUT\"" \ -errfile "\"&1\"" \ -classpath "\"$CLASSPATH\"" \ - "\"$LOGGING_CONFIG\"" "$JAVA_OPTS" "$CATALINA_OPTS" \ + "\"$CATALINA_LOGGING_CONFIG\"" "$JAVA_OPTS" "$CATALINA_OPTS" \ -D$ENDORSED_PROP="\"$JAVA_ENDORSED_DIRS\"" \ -Dcatalina.base="\"$CATALINA_BASE\"" \ -Dcatalina.home="\"$CATALINA_HOME\"" \ diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml index f4fbc32..b2e481a 100644 --- a/webapps/docs/changelog.xml +++ b/webapps/docs/changelog.xml @@ -140,6 +140,12 @@ be configured via the <code>UMASK</code> environment variable as it is when using <code>catalina.sh</code>. (markt) </fix> + <fix> + Depreacted the <code>LOGGING_CONFIG</code> environment variable and + replace it with the <code>CATALINA_LOGGING_CONFIG</code> environment + variable to avoid clashes with other components that use + <code>LOGGING_CONFIG</code>. (markt) + </fix> </changelog> </subsection> </section> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org