tap.log

Interface TAPLog

All Superinterfaces:

UWSLog

All Known Implementing Classes:

DefaultTAPLog, Slf4jTAPLog

public interface TAPLog
extends UWSLog

Let log any kind of message about a TAP service.

Version:

2.0 (04/2015)

Author:

Grégory Mantelet (CDS;ARI)

Nested Class Summary

Nested classes/interfaces inherited from interface uws.service.log.UWSLog

UWSLog.LogLevel

Method Summary

Modifier and Type	Method and Description
void	logDB(UWSLog.LogLevel level, DBConnection connection, java.lang.String event, java.lang.String message, java.lang.Throwable error) Log a message and/or an error in the DB (database) context.
void	logTAP(UWSLog.LogLevel level, java.lang.Object obj, java.lang.String event, java.lang.String message, java.lang.Throwable error) Log a message and/or an error in the general context of TAP.

Methods inherited from interface uws.service.log.UWSLog

debug, debug, debug, error, error, error, getConfigString, info, log, logHttp, logHttp, logJob, logThread, logUWS, warning

Method Detail

logDB

void logDB(UWSLog.LogLevel level,
           DBConnection connection,
           java.lang.String event,
           java.lang.String message,
           java.lang.Throwable error)

Log a message and/or an error in the DB (database) context.

List of all events sent by the library (case sensitive):

• CONNECTION_LACK
• TRANSLATE
• EXECUTE
• RESULT
• LOAD_TAP_SCHEMA
• CLEAN_TAP_SCHEMA
• CREATE_TAP_SCHEMA
• TABLE_EXIST
• COLUMN_EXIST
• EXEC_UPDATE
• ADD_UPLOAD_TABLE
• DROP_UPLOAD_TABLE
• START_TRANSACTION
• COMMIT
• ROLLBACK
• END_TRANSACTION
• CLOSE

Parameters:

level - Level of the log (info, warning, error, ...). SHOULD NOT be NULL, but if NULL anyway, the level SHOULD be considered as INFO

connection - DB connection from which this log comes. MAY be NULL

event - Event at the origin of this log or action executed by the given database connection while this log is sent. MAY be NULL

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

Since:

2.0

logTAP

void logTAP(UWSLog.LogLevel level,
            java.lang.Object obj,
            java.lang.String event,
            java.lang.String message,
            java.lang.Throwable error)

Log a message and/or an error in the general context of TAP.

One of the parameter is of type Object. This object can be used to provide more information to the log function in order to describe as much as possible the state and/or result event.

List of all events sent by the library (case sensitive):

• IDENT_USER (with a NULL "obj")
• SYNC_INIT (with "obj" as an instance of TAPParameters)
• ASYNC_INIT (with a NULL "obj")
• START (with "obj" as an instance of TAPSyncJob)
• UPLOADING (with "obj" as an instance of TAPExecutionReport)
• PARSING (with "obj" as an instance of TAPExecutionReport)
• START_DB_EXECUTION (with "obj" as an instance of TAPExecutionReport)
• WRITING_RESULT (with "obj" as an instance of TAPExecutionReport)
• RESULT_WRITTEN (with "obj" as an instance of TAPExecutionReport)
• START_STEP (with "obj" as an instance of TAPExecutionReport)
• END_EXEC (with "obj" as an instance of TAPExecutionReport)
• END_DB_EXECUTION (with "obj" as an instance of TAPExecutionReport)
• DROP_UPLOAD (with "obj" as an instance of TAPExecutionReport)
• TIME_OUT (with "obj" as an instance of TAPSyncJob)
• END (with "obj" as an instance of TAPSyncJob)

Parameters:

level - Level of the log (info, warning, error, ...). SHOULD NOT be NULL, but if NULL anyway, the level SHOULD be considered as INFO

obj - Object providing more information about the event/object at the origin of this log. MAY be NULL

event - Event at the origin of this log or action currently executed by TAP while this log is sent. MAY be NULL

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

Since:

2.0