[UWS,TAP] Review the exceptions and logs management + Add log file rotation... (0ef180ce) · Commits · Sonia Zorba / vollt

src/tap/ADQLExecutor.java

+41 −31

Original line number	Diff line number	Diff line
		@@ -22,7 +22,6 @@ package tap;

		import java.io.IOException;
		import java.io.OutputStream;
		import java.sql.SQLException;

		import javax.servlet.http.HttpServletResponse;

		@@ -40,12 +39,12 @@ import tap.upload.Uploader;
		import uws.UWSException;
		import uws.job.JobThread;
		import uws.job.Result;
		import uws.service.log.UWSLog.LogLevel;
		import adql.parser.ADQLParser;
		import adql.parser.ADQLQueryFactory;
		import adql.parser.ParseException;
		import adql.parser.QueryChecker;
		import adql.query.ADQLQuery;
		import adql.translator.TranslationException;

		/**
		* <p>Let process completely an ADQL query.</p>
		@@ -105,7 +104,7 @@ import adql.translator.TranslationException;
		* </p>
		*
		* @author Grégory Mantelet (CDS;ARI)
		* @version 2.0 (08/2014)
		* @version 2.0 (09/2014)
		*/
		public class ADQLExecutor {

		@@ -206,8 +205,8 @@ public class ADQLExecutor {
		*
		* @return The resulting execution report.
		*
		* @throws UWSException
		* @throws InterruptedException
		* @throws UWSException If any error occurs while executing the ADQL query.
		* @throws InterruptedException If the job has been interrupted (by the user or a time-out).
		*
		* @see #start()
		*/
		@@ -222,7 +221,11 @@ public class ADQLExecutor {
		this.report = new TAPExecutionReport(tapJob.getJobId(), false, tapParams);
		this.response = null;

		try{
		return start();
		}catch(TAPException te){
		throw new UWSException(te.getHttpErrorCode(), te);
		}
		}

		/**
		@@ -237,8 +240,8 @@ public class ADQLExecutor {
		*
		* @return The resulting execution report.
		*
		* @throws TAPException
		* @throws InterruptedException
		* @throws TAPException If any error occurs while executing the ADQL query.
		* @throws InterruptedException If the job has been interrupted (by the user or a time-out).
		*
		* @see #start()
		*/
		@@ -251,7 +254,11 @@ public class ADQLExecutor {
		this.report = new TAPExecutionReport(jobId, true, tapParams);
		this.response = response;

		try{
		return start();
		}catch(UWSException ue){
		throw new TAPException(ue, ue.getHttpErrorCode());
		}
		}

		/**
		@@ -277,14 +284,11 @@ public class ADQLExecutor {
		*
		* @return The updated execution report.
		*
		* @throws TAPException
		* @throws UWSException
		* @throws InterruptedException
		* @throws ParseException
		* @throws TranslationException
		* @throws SQLException
		* @throws TAPException If any error occurs while executing the ADQL query.
		* @throws UWSException If any error occurs while executing the ADQL query.
		* @throws InterruptedException If the job has been interrupted (by the user or a time-out).
		*/
		protected final TAPExecutionReport start() throws TAPException, UWSException, InterruptedException, ParseException, TranslationException, SQLException{
		protected final TAPExecutionReport start() throws TAPException, UWSException, InterruptedException{
		// Save the start time (for reporting usage):
		long start = System.currentTimeMillis();

		@@ -307,7 +311,15 @@ public class ADQLExecutor {
		// 2. PARSE THE ADQL QUERY:
		startStep(ExecutionProgression.PARSING);
		// Parse the query:
		ADQLQuery adqlQuery = parseADQL();
		ADQLQuery adqlQuery = null;
		try{
		adqlQuery = parseADQL();
		}catch(ParseException pe){
		if (report.synchronous)
		throw new TAPException("Incorrect ADQL query: " + pe.getMessage(), pe, UWSException.BAD_REQUEST, tapParams.getQuery(), progression);
		else
		throw new UWSException(UWSException.BAD_REQUEST, pe, "Incorrect ADQL query: " + pe.getMessage());
		}
		// List all resulting columns (it will be useful later to format the result):
		report.resultingColumns = adqlQuery.getResultingColumns();
		endStep();
		@@ -329,7 +341,6 @@ public class ADQLExecutor {
		endStep();

		// Report the COMPLETED status:
		logger.info("JOB " + report.jobID + " COMPLETED");
		tapParams.remove(TAPJob.PARAM_PROGRESSION);
		report.success = true;

		@@ -340,7 +351,7 @@ public class ADQLExecutor {
		try{
		queryResult.close();
		}catch(DataReadException dre){
		logger.error("JOB " + report.jobID + "\tCan not close the database query result!", dre);
		logger.logTAP(LogLevel.ERROR, report, "END_EXEC", "Can not close the database query result!", dre);
		}
		}

		@@ -348,7 +359,7 @@ public class ADQLExecutor {
		try{
		dropUploadedTables();
		}catch(TAPException e){
		logger.error("JOB " + report.jobID + "\tCan not drop the uploaded tables from the database!", e);
		logger.logTAP(LogLevel.ERROR, report, "END_EXEC", "Can not drop the uploaded tables from the database!", e);
		}

		// Free the connection (so that giving it back to a pool, if any, otherwise, just free resources):
		@@ -359,7 +370,6 @@ public class ADQLExecutor {

		// Set the total duration in the report:
		report.setTotalDuration(System.currentTimeMillis() - start);
		logger.queryFinished(report);
		}
		}

		@@ -389,7 +399,8 @@ public class ADQLExecutor {
		try{
		tapParams.set(TAPJob.PARAM_PROGRESSION, this.progression);
		}catch(UWSException ue){
		logger.warning("Can not set/update the informative job parameter \"" + TAPJob.PARAM_PROGRESSION + "\" (this parameter would be just for notification purpose about the execution progression)! CAUSE: " + ue.getClass().getName() + " - " + ue.getMessage());
		// should not happen, but just in case...
		logger.logTAP(LogLevel.WARNING, report, "START_STEP", "Can not set/update the informative job parameter \"" + TAPJob.PARAM_PROGRESSION + "\" (this parameter would be just for notification purpose about the execution progression)!", ue);
		}
		}

		@@ -434,7 +445,7 @@ public class ADQLExecutor {

		// Upload them, if needed:
		if (tables.length > 0){
		logger.info("JOB " + report.jobID + "\tLoading uploaded tables (" + tables.length + ")...");
		logger.logTAP(LogLevel.INFO, report, "UPLOAD", "Loading uploaded tables (" + tables.length + ")...", null);
		try{
		uploadSchema = service.getFactory().createUploader(dbConn).upload(tables);
		}finally{
		@@ -509,18 +520,17 @@ public class ADQLExecutor {
		* @return The result of the query,
		* or NULL if the query execution has failed.
		*
		* @throws SQLException If the query execution has failed ; the database is not able to execute this query.
		* @throws InterruptedException If the thread has been interrupted.
		* @throws TAPException If the {@link DBConnection} has failed to deal with the given ADQL query.
		*
		* @see {@link DBConnection#executeQuery(ADQLQuery)}
		*/
		protected TableIterator executeADQL(final ADQLQuery adql) throws SQLException, InterruptedException, TAPException{
		protected TableIterator executeADQL(final ADQLQuery adql) throws InterruptedException, TAPException{
		TableIterator result = dbConn.executeQuery(adql);
		if (result == null)
		logger.info("JOB " + report.jobID + " - QUERY ABORTED AFTER " + (System.currentTimeMillis() - startStep) + " MS !");
		logger.logTAP(LogLevel.INFO, report, "END_QUERY", "Query execution aborted after " + (System.currentTimeMillis() - startStep) + "ms!", null);
		else
		logger.info("JOB " + report.jobID + " - QUERY SUCCESFULLY EXECUTED IN " + (System.currentTimeMillis() - startStep) + " MS !");
		logger.logTAP(LogLevel.INFO, report, "END_QUERY", "Query successfully executed in " + (System.currentTimeMillis() - startStep) + "ms!", null);
		return result;
		}

		@@ -555,7 +565,7 @@ public class ADQLExecutor {
		writeResult(queryResult, formatter, response.getOutputStream());

		}catch(IOException ioe){
		throw new TAPException("Impossible to get the output stream of the HTTP request to write the result of the job " + report.jobID + " !", ioe);
		throw new TAPException("Impossible to get the HTTP response, so the result of the job " + report.jobID + " can not be written!", ioe, UWSException.INTERNAL_SERVER_ERROR);
		}
		}
		// CASE ASYNCHRONOUS:
		@@ -579,7 +589,7 @@ public class ADQLExecutor {
		jobThread.publishResult(result);

		}catch(IOException ioe){
		throw new UWSException(UWSException.INTERNAL_SERVER_ERROR, ioe, "Impossible to get the output stream of the result file to write the result of the job " + report.jobID + " !");
		throw new UWSException(UWSException.INTERNAL_SERVER_ERROR, ioe, "Impossible to access the file into the result of the job " + report.jobID + " must be written!");
		}
		}
		}
		@@ -621,7 +631,7 @@ public class ADQLExecutor {
		try{
		dbConn.dropUploadedTable(t);
		}catch(DBException dbe){
		logger.error("JOB " + report.jobID + "\tCan not drop the uploaded table \"" + t.getDBName() + "\" (in adql \"" + t.getADQLName() + "\") from the database!", dbe);
		logger.logTAP(LogLevel.ERROR, report, "DROP_UPLOAD", "Can not drop the uploaded table \"" + t.getDBName() + "\" (in adql \"" + t.getADQLName() + "\") from the database!", dbe);
		}
		}
		}

src/tap/AbstractTAPFactory.java

+6 −6

Original line number	Diff line number	Diff line
		@@ -260,11 +260,11 @@ public abstract class AbstractTAPFactory extends TAPFactory {
		* @see tap.TAPFactory#createTAPParameters(javax.servlet.http.HttpServletRequest)
		*/
		@Override
		protected TAPParameters createTAPParameters(final HttpServletRequest request) throws UWSException{
		public TAPParameters createTAPParameters(final HttpServletRequest request) throws TAPException{
		try{
		return new TAPParameters(request, service, getExpectedAdditionalParameters(), getInputParamControllers());
		}catch(TAPException te){
		throw new UWSException(UWSException.INTERNAL_SERVER_ERROR, te);
		}catch(UWSException ue){
		throw new TAPException(ue);
		}
		}

		@@ -281,11 +281,11 @@ public abstract class AbstractTAPFactory extends TAPFactory {
		* @see tap.TAPFactory#createTAPParameters(javax.servlet.http.HttpServletRequest)
		*/
		@Override
		protected TAPParameters createTAPParameters(final Map<String,Object> params) throws UWSException{
		public TAPParameters createTAPParameters(final Map<String,Object> params) throws TAPException{
		try{
		return new TAPParameters(service, params, getExpectedAdditionalParameters(), getInputParamControllers());
		}catch(TAPException te){
		throw new UWSException(UWSException.INTERNAL_SERVER_ERROR, te);
		}catch(UWSException ue){
		throw new TAPException(ue);
		}
		}

src/tap/AsyncThread.java

+0 −8

Original line number	Diff line number	Diff line
		@@ -21,8 +21,6 @@ package tap;

		import uws.UWSException;
		import uws.job.JobThread;
		import adql.parser.ParseException;
		import adql.translator.TranslationException;

		public class AsyncThread extends JobThread {

		@@ -41,12 +39,6 @@ public class AsyncThread extends JobThread {
		throw ie;
		}catch(UWSException ue){
		throw ue;
		}catch(TAPException te){
		throw new UWSException(te.getHttpErrorCode(), te, te.getMessage());
		}catch(ParseException pe){
		throw new UWSException(UWSException.BAD_REQUEST, pe, pe.getMessage());
		}catch(TranslationException te){
		throw new UWSException(UWSException.INTERNAL_SERVER_ERROR, te, te.getMessage());
		}catch(Exception ex){
		throw new UWSException(UWSException.INTERNAL_SERVER_ERROR, ex, "Error while processing the ADQL query of the job " + job.getJobId() + " !");
		}finally{

src/tap/TAPException.java

+7 −1

Original line number	Diff line number	Diff line
		@@ -21,6 +21,12 @@ package tap;

		import uws.UWSException;

		/**
		* TODO JAVADOC OF THE WHOLE CLASS TO WRITE!!!
		*
		* @author Grégory Mantelet (CDS;ARI)
		* @version 2.0 (09/2014)
		*/
		public class TAPException extends Exception {

		private static final long serialVersionUID = 1L;
		@@ -60,7 +66,7 @@ public class TAPException extends Exception {
		}

		public TAPException(UWSException ue){
		this(ue.getMessage(), ue.getCause(), ue.getHttpErrorCode());
		this(ue.getMessage(), (ue.getCause() == null ? ue : ue.getCause()), ue.getHttpErrorCode());
		}

		public TAPException(UWSException cause, int httpErrorCode){

src/tap/TAPFactory.java

+22 −8

Original line number	Diff line number	Diff line
		@@ -58,7 +58,7 @@ import adql.query.ADQLQuery;
		* </ul>
		*
		* @author Grégory Mantelet (CDS;ARI)
		* @version 2.0 (08/2014)
		* @version 2.0 (09/2014)
		*/
		public abstract class TAPFactory extends AbstractUWSFactory {

		@@ -373,7 +373,14 @@ public abstract class TAPFactory extends AbstractUWSFactory {
		*/
		@Override
		public final UWSParameters createUWSParameters(HttpServletRequest request) throws UWSException{
		try{
		return createTAPParameters(request);
		}catch(TAPException te){
		if (te.getCause() != null && te.getCause() instanceof UWSException && te.getMessage().equals(te.getCause().getMessage()))
		throw (UWSException)te.getCause();
		else
		throw new UWSException(te.getHttpErrorCode(), te);
		}
		}

		/**
		@@ -387,9 +394,9 @@ public abstract class TAPFactory extends AbstractUWSFactory {
		*
		* @return An object gathering all successfully extracted TAP parameters.
		*
		* @throws UWSException If any error occurs while extracting the parameters.
		* @throws TAPException If any error occurs while extracting the parameters.
		*/
		protected abstract TAPParameters createTAPParameters(final HttpServletRequest request) throws UWSException;
		public abstract TAPParameters createTAPParameters(final HttpServletRequest request) throws TAPException;

		/**
		* <p>Identify and gather all identified parameters of the given map inside a {@link TAPParameters} object.</p>
		@@ -404,7 +411,14 @@ public abstract class TAPFactory extends AbstractUWSFactory {
		*/
		@Override
		public final UWSParameters createUWSParameters(Map<String,Object> params) throws UWSException{
		try{
		return createTAPParameters(params);
		}catch(TAPException te){
		if (te.getCause() != null && te.getCause() instanceof UWSException && te.getMessage().equals(te.getCause().getMessage()))
		throw (UWSException)te.getCause();
		else
		throw new UWSException(te.getHttpErrorCode(), te);
		}
		}

		/**
		@@ -418,8 +432,8 @@ public abstract class TAPFactory extends AbstractUWSFactory {
		*
		* @return An object gathering all successfully identified TAP parameters.
		*
		* @throws UWSException If any error occurs while creating the {@link TAPParameters} object.
		* @throws TAPException If any error occurs while creating the {@link TAPParameters} object.
		*/
		protected abstract TAPParameters createTAPParameters(final Map<String,Object> params) throws UWSException;
		public abstract TAPParameters createTAPParameters(final Map<String,Object> params) throws TAPException;

		}