Commit 5f18ac69 authored by Grégory Mantelet's avatar Grégory Mantelet
Browse files

[UWS,TAP] Add a new logger which forwards log entries to SLF4J. 

Then, UWS or TAP implementors are free to use whatever logging system they want
(e.g. log4j, logback, ...).
parent ded9cead

build.gradle

+3 −0
Original line number Diff line number Diff line
@@ -11,10 +11,13 @@ dependencies { 
    compile fileTree(dir: 'lib', includes: ['stil_3.1.jar','cos-1.5beta.jar'])

    compile 'javax.servlet:javax.servlet-api:3.0.1'

    compile 'postgresql:postgresql:9.1-901.jdbc4'

    compile 'org.slf4j:slf4j-api:1.7.25'



    testCompile 'junit:junit:4.12'

    testCompile 'com.h2database:h2:1.4.193'

    testCompile fileTree(dir: 'lib', include: 'astroh2-0.3.jar')

    testCompile 'org.slf4j:slf4j-simple:1.7.25'

    

    

    testRuntime 'simple-jndi:simple-jndi:0.11.4.1'

    testRuntime 'com.vividsolutions:jts-core:1.14.0'

buildTAP.xml

+6 −1
Original line number Diff line number Diff line
@@ -14,9 +14,13 @@ 


	<property name="cosJarName" value="cos-1.5beta.jar" />

	<property name="cosJar" value="${libDir}/${cosJarName}" />

	

	<property name="stilJarName" value="stil_3.1.jar" />

	<property name="stilJar" value="${libDir}/${stilJarName}" />



	<property name="slf4jApiJarName" value="slf4j-api-1.7.25.jar" />

	<property name="slf4jApiJar" value="${libDir}/${slf4jApiJarName}" />



	<property name="sqliteJarName" value="sqlite-jdbc-3.16.1.jar" />

	<property name="sqliteJar" value="${libDir}/${sqliteJarName}" />
@@ -29,7 +33,7 @@ 
	<property name="astroh2JarName" value="astroh2-0.3.jar" />

	<property name="astroh2Jar" value="${libDir}/${astroh2JarName}" />

		

	<property name="tapPath" value="tap/**,adql/**,uws/**,cds/**" />

	<property name="tapPath" value="tap/**,adql/**,uws/**,cds/**,datalink/**,puzzlibs/**" />

	<property name="jsonPath" value="org/json/**" />

	<property name="extLibsPath" value="com/oreilly/servlet/**,nom/tam/**,org/apache/tools/bzip2/**,uk/ac/starlink/**" />

	<property name="licensePath" value="COPYING.LESSER" />
@@ -67,6 +71,7 @@ 
	<!-- CLASSPATHS -->

	<path id="tap.classpath">

		<pathelement location="${cosJar}" />

		<pathelement location="${slf4jApiJar}" />

		<pathelement location="${jsonJar}" />

		<pathelement location="${stilJar}" />

		<pathelement location="${POSTGRES}" />

buildUWS.xml

+5 −1
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 
<!DOCTYPE project>

<project name="uws" basedir="." default="buildLib">

	

	<property name="version" value="4.3" />

	<property name="version" value="4.4" />



	<property name="srcDir" value="src" />

	<property name="testDir" value="test" />
@@ -14,6 +14,9 @@ 


	<property name="cosJarName" value="cos-1.5beta.jar" />

	<property name="cosJar" value="${libDir}/${cosJarName}" />



	<property name="slf4jApiJarName" value="slf4j-api-1.7.25.jar" />

	<property name="slf4jApiJar" value="${libDir}/${slf4jApiJarName}" />

	

	<property name="uwsPath" value="uws/**" />

	<property name="jsonPath" value="org/json/**" />
@@ -36,6 +39,7 @@ 
	<!-- CLASSPATHS -->

	<path id="uws.classpath">

		<pathelement location="${cosJar}" />

		<pathelement location="${slf4jApiJar}" />

		<pathelement location="${SERVLET-API}" />

	</path>

src/tap/config/ConfigurableServiceConnection.java

+42 −36
Original line number Diff line number Diff line
@@ -58,6 +58,7 @@ import static tap.config.TAPConfiguration.KEY_UDFS; 
import static tap.config.TAPConfiguration.KEY_UPLOAD_ENABLED;

import static tap.config.TAPConfiguration.KEY_UPLOAD_MAX_FILE_SIZE;

import static tap.config.TAPConfiguration.KEY_USER_IDENTIFIER;

import static tap.config.TAPConfiguration.SLF4J_LOGGER;

import static tap.config.TAPConfiguration.VALUE_ALL;

import static tap.config.TAPConfiguration.VALUE_ANY;

import static tap.config.TAPConfiguration.VALUE_CSV;
@@ -109,6 +110,7 @@ import tap.formatter.SVFormat; 
import tap.formatter.TextFormat;

import tap.formatter.VOTableFormat;

import tap.log.DefaultTAPLog;

import tap.log.Slf4jTAPLog;

import tap.log.TAPLog;

import tap.metadata.TAPMetadata;

import tap.metadata.TableSetParser;
@@ -129,7 +131,7 @@ import uws.service.log.UWSLog.LogLevel; 
 * </p>

 *

 * @author Gr&eacute;gory Mantelet (ARI)

 * @version 2.3 (03/2018)

 * @version 2.3 (04/2018)

 * @since 2.0

 */

public final class ConfigurableServiceConnection implements ServiceConnection {
@@ -171,7 +173,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 


	/** Array of 2 integers: resp. default and maximum output limit.

	 * <em>Each limit is expressed in a unit specified in the array {@link #outputLimitTypes}.</em> */

	private int[] outputLimits = new int[]{-1,-1};

	private int[] outputLimits = new int[]{ -1, -1 };

	/** Array of 2 limit units: resp. unit of the default output limit and unit of the maximum output limit. */

	private LimitUnit[] outputLimitTypes = new LimitUnit[2];
@@ -179,7 +181,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 
	private boolean isUploadEnabled = false;

	/** Array of 2 integers: resp. default and maximum upload limit.

	 * <em>Each limit is expressed in a unit specified in the array {@link #uploadLimitTypes}.</em> */

	private int[] uploadLimits = new int[]{-1,-1};

	private int[] uploadLimits = new int[]{ -1, -1 };

	/** Array of 2 limit units: resp. unit of the default upload limit and unit of the maximum upload limit. */

	private LimitUnit[] uploadLimitTypes = new LimitUnit[2];

	/** The maximum size of a set of uploaded files.
@@ -188,7 +190,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 


	/** Array of 2 integers: resp. default and maximum fetch size.

	 * <em>Both sizes are expressed in number of rows.</em> */

	private int[] fetchSize = new int[]{DEFAULT_ASYNC_FETCH_SIZE,DEFAULT_SYNC_FETCH_SIZE};

	private int[] fetchSize = new int[]{ DEFAULT_ASYNC_FETCH_SIZE, DEFAULT_SYNC_FETCH_SIZE };



	/** The method to use in order to identify a TAP user. */

	private UserIdentifier userIdentifier = null;
@@ -322,7 +324,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 
		}

		// CUSTOM file manager:

		else

			fileManager = newInstance(fileManagerType, KEY_FILE_MANAGER, UWSFileManager.class, new Class<?>[]{Properties.class}, new Object[]{tapConfig});

			fileManager = newInstance(fileManagerType, KEY_FILE_MANAGER, UWSFileManager.class, new Class<?>[]{ Properties.class }, new Object[]{ tapConfig });

	}



	/**
@@ -355,7 +357,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 
	}



	/**

	 * Initialize the TAP logger with the given TAP configuration file.

	 * Initialise the TAP logger with the given TAP configuration file.

	 *

	 * @param tapConfig	The content of the TAP configuration file.

	 *
@@ -367,31 +369,33 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 
		String propValue = getProperty(tapConfig, KEY_LOGGER);

		if (propValue == null || propValue.trim().equalsIgnoreCase(DEFAULT_LOGGER))

			logger = new DefaultTAPLog(fileManager);

		else if (propValue == null || propValue.trim().equalsIgnoreCase(SLF4J_LOGGER))

			logger = new Slf4jTAPLog();

		else

			logger = newInstance(propValue, KEY_LOGGER, TAPLog.class, new Class<?>[]{UWSFileManager.class}, new Object[]{fileManager});

			logger = newInstance(propValue, KEY_LOGGER, TAPLog.class, new Class<?>[]{ UWSFileManager.class }, new Object[]{ fileManager });



		StringBuffer buf = new StringBuffer("Logger initialized");

		// Set some options for the default logger:

		if (propValue == null || propValue.trim().equalsIgnoreCase(DEFAULT_LOGGER)){



		// Set the minimum log level:

		propValue = getProperty(tapConfig, KEY_MIN_LOG_LEVEL);

		if (propValue != null){

			try{

				((DefaultTAPLog)logger).setMinLogLevel(LogLevel.valueOf(propValue.toUpperCase()));

			}catch(IllegalArgumentException iae){}

		}

		buf.append(" (minimum log level: ").append(((DefaultTAPLog)logger).getMinLogLevel());



		// Set the log rotation period, if any:

		if (fileManager instanceof LocalUWSFileManager){

			propValue = getProperty(tapConfig, KEY_LOG_ROTATION);

			if (propValue != null)

				((LocalUWSFileManager)fileManager).setLogRotationFreq(propValue);

			buf.append(", log rotation: ").append(((LocalUWSFileManager)fileManager).getLogRotationFreq());

			// Set the minimum log level:

			propValue = getProperty(tapConfig, KEY_MIN_LOG_LEVEL);

			if (propValue != null){

				try{

					((DefaultTAPLog)logger).setMinLogLevel(LogLevel.valueOf(propValue.toUpperCase()));

				}catch(IllegalArgumentException iae){

				}

			}



			// Set the log rotation period, if any:

			if (fileManager instanceof LocalUWSFileManager){

				propValue = getProperty(tapConfig, KEY_LOG_ROTATION);

				if (propValue != null)

					((LocalUWSFileManager)fileManager).setLogRotationFreq(propValue);

			}

		}



		// Log the successful initialization with set parameters:

		buf.append(").");

		logger.info(buf.toString());

		// Log the successful initialisation of the logger:

		logger.info("Logger initialized - {" + logger.getConfigString() + "}");

	}



	/**
@@ -412,10 +416,10 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 
		String propValue = getProperty(tapConfig, KEY_TAP_FACTORY);

		if (propValue == null)

			tapFactory = new ConfigurableTAPFactory(this, tapConfig);

		else if (hasConstructor(propValue, KEY_TAP_FACTORY, TAPFactory.class, new Class<?>[]{ServiceConnection.class,Properties.class}))

			tapFactory = newInstance(propValue, KEY_TAP_FACTORY, TAPFactory.class, new Class<?>[]{ServiceConnection.class,Properties.class}, new Object[]{this,tapConfig});

		else if (hasConstructor(propValue, KEY_TAP_FACTORY, TAPFactory.class, new Class<?>[]{ ServiceConnection.class, Properties.class }))

			tapFactory = newInstance(propValue, KEY_TAP_FACTORY, TAPFactory.class, new Class<?>[]{ ServiceConnection.class, Properties.class }, new Object[]{ this, tapConfig });

		else

			tapFactory = newInstance(propValue, KEY_TAP_FACTORY, TAPFactory.class, new Class<?>[]{ServiceConnection.class}, new Object[]{this});

			tapFactory = newInstance(propValue, KEY_TAP_FACTORY, TAPFactory.class, new Class<?>[]{ ServiceConnection.class }, new Object[]{ this });

	}



	/**
@@ -486,7 +490,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 


				// fetch and set the ADQL<->DB mapping for all standard TAP_SCHEMA items:

				if (conn instanceof JDBCConnection){

					HashMap<String,String> dbMapping = new HashMap<String,String>(10);

					HashMap<String, String> dbMapping = new HashMap<String, String>(10);

					// fetch the mapping from the Property file:

					for(String key : tapConfig.stringPropertyNames()){

						if (key.trim().startsWith("TAP_SCHEMA") && tapConfig.getProperty(key) != null && tapConfig.getProperty(key).trim().length() > 0)
@@ -794,7 +798,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 
			}

			// custom OutputFormat

			else if (isClassName(f))

				outputFormats.add(TAPConfiguration.newInstance(f, KEY_OUTPUT_FORMATS, OutputFormat.class, new Class<?>[]{ServiceConnection.class}, new Object[]{this}));

				outputFormats.add(TAPConfiguration.newInstance(f, KEY_OUTPUT_FORMATS, OutputFormat.class, new Class<?>[]{ ServiceConnection.class }, new Object[]{ this }));

			// unknown format

			else

				throw new TAPException("Unknown output format: " + f);
@@ -1050,7 +1054,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 
					// parse the coordinate system regular expression in order to check it:

					else{

						try{

							STCS.buildCoordSysRegExp(new String[]{item});

							STCS.buildCoordSysRegExp(new String[]{ item });

							lstCoordSys.add(item);

						}catch(ParseException pe){

							throw new TAPException("Incorrect coordinate system regular expression (\"" + item + "\"): " + pe.getMessage(), pe);
@@ -1446,7 +1450,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 


	@Override

	public final LimitUnit[] getOutputLimitType(){

		return new LimitUnit[]{LimitUnit.rows,LimitUnit.rows};

		return new LimitUnit[]{ LimitUnit.rows, LimitUnit.rows };

	}



	@Override
@@ -1495,7 +1499,7 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 
	 */

	public void setUploadLimitType(final LimitUnit type){

		if (type != null)

			uploadLimitTypes = new LimitUnit[]{type,type};

			uploadLimitTypes = new LimitUnit[]{ type, type };

	}



	/**
@@ -1516,7 +1520,8 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 
				uploadLimits[0] = limit;

				return true;

			}

		}catch(TAPException e){}

		}catch(TAPException e){

		}

		return false;

	}
@@ -1540,7 +1545,8 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 
				uploadLimits[0] = limit;

			// Set the new maximum output limit:

			uploadLimits[1] = limit;

		}catch(TAPException e){}

		}catch(TAPException e){

		}

	}



	@Override

src/tap/config/TAPConfiguration.java

+35 −16
Original line number Diff line number Diff line
@@ -16,7 +16,8 @@ package tap.config; 
 * You should have received a copy of the GNU Lesser General Public License

 * along with TAPLibrary.  If not, see <http://www.gnu.org/licenses/>.

 *

 * Copyright 2015-2017 - Astronomisches Rechen Institut (ARI)

 * Copyright 2015-2018 - UDS/Centre de Données astronomiques de Strasbourg (CDS),

 *                       Astronomisches Rechen Institut (ARI)

 */



import java.lang.reflect.Constructor;
@@ -35,8 +36,8 @@ import tap.backup.DefaultTAPBackupManager; 
 * <p><i>This class implements the Design Pattern "Utility": no instance of this class can be created, it can not be extended,

 * and it must be used only thanks to its static classes and attributes.</i></p>

 *

 * @author Gr&eacute;gory Mantelet (ARI)

 * @version 2.1 (09/2017)

 * @author Gr&eacute;gory Mantelet (CDS;ARI)

 * @version 2.3 (07/2018)

 * @since 2.0

 */

public final class TAPConfiguration {
@@ -83,14 +84,26 @@ public final class TAPConfiguration { 
	/** Name/Key of the property specifying the logger to use.

	 * By default, {@link tap.log.DefaultTAPLog} is used. */

	public final static String KEY_LOGGER = "logger";

	/** Default value of the property {@link #KEY_LOGGER}: {@value #DEFAULT_LOGGER}. */

	/** Default value of the property {@link #KEY_LOGGER}:

	 * {@value #DEFAULT_LOGGER}. */

	public final static String DEFAULT_LOGGER = "default";

	/** Name/Key of the property specifying the minimum type of messages (i.e. DEBUG, INFO, WARNING, ERROR, FATAL)

	 * that must be logged. By default all messages are logged...which is equivalent to set this property to "DEBUG". */

	/** Name/Key of the property specifying the minimum type of messages

	 * (i.e. DEBUG, INFO, WARNING, ERROR, FATAL) that must be logged by the

	 * <strong>default logger</strong>.

	 * <p>By default all messages are logged...which is equivalent to set this

	 * property to "DEBUG".</p>

	 * <p><i><b>Note:</b> If {@link #KEY_LOGGER} is set to a value different

	 * from {@value #DEFAULT_LOGGER}, this property is ignored.</i></p> */

	public final static String KEY_MIN_LOG_LEVEL = "min_log_level";

	/** Name/Key of the property specifying the frequency of the log file rotation.

	 * By default the log rotation occurs every day at midnight. */

	/** Name/Key of the property specifying the frequency of the log file

	 * rotation to set in the <strong>default logger</strong>.

	 * <p>By default the log rotation occurs every day at midnight.</p>

	 * <p><i><b>Note:</b> If {@link #KEY_LOGGER} is set to a value different

	 * from {@value #DEFAULT_LOGGER}, this property is ignored.</i></p> */

	public final static String KEY_LOG_ROTATION = "log_rotation";

	/** SLF4J logger value: {@value #SLF4J_LOGGER}.

	 * @since 2.3 */

	public final static String SLF4J_LOGGER = "slf4j";



	/* UWS BACKUP */

	/** Name/Key of the property specifying the frequency (in milliseconds) of jobs backup.
@@ -164,7 +177,7 @@ public final class TAPConfiguration { 
	/** List of the most known JDBC drivers. For the moment this list contains 4 drivers:

	 * oracle ("oracle.jdbc.OracleDriver"), postgresql ("org.postgresql.Driver"), mysql ("com.mysql.jdbc.Driver"),

	 * sqlite ("org.sqlite.JDBC") and h2 ("org.h2.Driver"). */

	public final static HashMap<String,String> VALUE_JDBC_DRIVERS = new HashMap<String,String>(4);

	public final static HashMap<String, String> VALUE_JDBC_DRIVERS = new HashMap<String, String>(4);

	static{

		VALUE_JDBC_DRIVERS.put("oracle", "oracle.jdbc.OracleDriver");

		VALUE_JDBC_DRIVERS.put("postgresql", "org.postgresql.Driver");
@@ -191,6 +204,11 @@ public final class TAPConfiguration { 
	/** Name/Key of the property specifying the local file path of the XML file containing the TAP metadata to load. */

	public final static String KEY_METADATA_FILE = "metadata_file";



	/* DATALINK KEY */

	/** Name/Key of the property providing the API for the Datalink capability.

	 * @since 2.3 */

	public final static String KEY_DATALINK = "datalink";



	/* HOME PAGE KEY */

	/** Name/Key of the property specifying the TAP home page to use.

	 * It can be a file, a URL or a class. If null, the default TAP home page of the library is used.
@@ -298,7 +316,8 @@ public final class TAPConfiguration { 
	public final static String KEY_TAP_FACTORY = "tap_factory";



	/** No instance of this class should be created. */

	private TAPConfiguration(){}

	private TAPConfiguration(){

	}



	/**

	 * <p>Read the asked property from the given Properties object.</p>
@@ -354,7 +373,7 @@ public final class TAPConfiguration { 
	 * @see #isClassName(String)

	 */

	@SuppressWarnings("unchecked")

	public final static < C > Class<? extends C> fetchClass(final String value, final String propertyName, final Class<C> expectedType) throws TAPException{

	public final static <C> Class<? extends C> fetchClass(final String value, final String propertyName, final Class<C> expectedType) throws TAPException{

		if (!isClassName(value))

			return null;
@@ -391,7 +410,7 @@ public final class TAPConfiguration { 
	 *

	 * @since 2.1

	 */

	public final static < C > boolean hasConstructor(final String propValue, final String propName, final Class<C> expectedType, final Class<?>[] pTypes) throws TAPException{

	public final static <C> boolean hasConstructor(final String propValue, final String propName, final Class<C> expectedType, final Class<?>[] pTypes) throws TAPException{

		// Ensure the given name is a class name specification:

		if (!isClassName(propValue))

			throw new TAPException("Class name expected for the property \"" + propName + "\" instead of: \"" + propValue + "\"! The specified class must extend/implement " + expectedType.getName() + ".");
@@ -429,7 +448,7 @@ public final class TAPConfiguration { 
	 * @see #isClassName(String)

	 * @see #fetchClass(String, String, Class)

	 */

	public final static < C > C newInstance(final String propValue, final String propName, final Class<C> expectedType) throws TAPException{

	public final static <C> C newInstance(final String propValue, final String propName, final Class<C> expectedType) throws TAPException{

		return newInstance(propValue, propName, expectedType, null, null);

	}
@@ -457,7 +476,7 @@ public final class TAPConfiguration { 
	 * @see #isClassName(String)

	 * @see #fetchClass(String, String, Class)

	 */

	public final static < C > C newInstance(final String propValue, final String propName, final Class<C> expectedType, final Class<?>[] pTypes, final Object[] parameters) throws TAPException{

	public final static <C> C newInstance(final String propValue, final String propName, final Class<C> expectedType, final Class<?>[] pTypes, final Object[] parameters) throws TAPException{

		// Ensure the given name is a class name specification:

		if (!isClassName(propValue))

			throw new TAPException("Class name expected for the property \"" + propName + "\" instead of: \"" + propValue + "\"! The specified class must extend/implement " + expectedType.getName() + ".");
@@ -529,7 +548,7 @@ public final class TAPConfiguration { 


		// If empty value, return an infinite limit:

		if (value == null || value.length() == 0)

			return new Object[]{-1,LimitUnit.rows};

			return new Object[]{ -1, LimitUnit.rows };



		// A. Parse the string from the end in order to extract the unit part.

		//    The final step of the loop is the extraction of the numeric value, when the first digit is encountered.
@@ -596,7 +615,7 @@ public final class TAPConfiguration { 
			}

		}



		return new Object[]{((numValue < 0) ? -1 : numValue),unit};

		return new Object[]{ ((numValue < 0) ? -1 : numValue), unit };

	}



}