tap.log

Class DefaultTAPLog

java.lang.Object

uws.service.log.DefaultUWSLog

tap.log.DefaultTAPLog

All Implemented Interfaces:

TAPLog, UWSLog

public class DefaultTAPLog
extends DefaultUWSLog
implements TAPLog

Default implementation of the TAPLog interface which lets logging any message about a TAP service.

Version:

2.0 (04/2015)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

DefaultUWSLog

Nested Class Summary

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

UWSLog.LogLevel

Field Summary

Fields inherited from class uws.service.log.DefaultUWSLog

defaultOutput, fileManager, minLogLevel, uws

Constructor Summary

Constructors

Constructor and Description
DefaultTAPLog(java.io.OutputStream output) Builds a TAPLog which will print all its messages into the given stream.
DefaultTAPLog(java.io.PrintWriter writer) Builds a TAPLog which will print all its messages into the given stream.
DefaultTAPLog(UWSFileManager fm) Builds a TAPLog which will use the given file manager to get the log output (see UWSFileManager.getLogOutput(uws.service.log.UWSLog.LogLevel, String)).

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.
protected void	printException(java.lang.Throwable error, java.io.PrintWriter out) Format and print the given exception inside the given writer.

Methods inherited from class uws.service.log.DefaultUWSLog

canLog, debug, debug, debug, error, error, error, getConfigString, getDateFormat, getExceptionOrigin, getMinLogLevel, getOutput, info, log, log, logHttp, logHttp, logJob, logThread, logUWS, normalizeMessage, setDateFormat, setMinLogLevel, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface uws.service.log.UWSLog

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

Constructor Detail

DefaultTAPLog

public DefaultTAPLog(UWSFileManager fm)

Builds a TAPLog which will use the given file manager to get the log output (see UWSFileManager.getLogOutput(uws.service.log.UWSLog.LogLevel, String)).

note 1: This constructor is particularly useful if the way of managing log output may change in the given file manager. Indeed, the output may change in function of the type of message to log (UWSLog.LogLevel).

note 2 If no output can be found in the file manager the standard error output (System.err) will be chosen automatically for all log messages.

Parameters:

fm - A TAP file manager.

See Also:

DefaultUWSLog.DefaultUWSLog(UWSFileManager)

DefaultTAPLog

public DefaultTAPLog(java.io.OutputStream output)

Builds a TAPLog which will print all its messages into the given stream.

note: the given output will be used whatever is the type of message to log (UWSLog.LogLevel).

Parameters:

output - An output stream.

See Also:

DefaultUWSLog.DefaultUWSLog(OutputStream)

DefaultTAPLog

public DefaultTAPLog(java.io.PrintWriter writer)

Builds a TAPLog which will print all its messages into the given stream.

note: the given output will be used whatever is the type of message to log (UWSLog.LogLevel).

Parameters:

writer - A print writer.

See Also:

DefaultUWSLog.DefaultUWSLog(PrintWriter)

Method Detail

printException

protected void printException(java.lang.Throwable error,
                              java.io.PrintWriter out)

Description copied from class: DefaultUWSLog

Format and print the given exception inside the given writer.

This function does nothing if the given error is NULL.

The full stack trace is printed ONLY for unknown exceptions.

The printed text has the following format for known exceptions:

 Caused by a {ExceptionClassName} {ExceptionOrigin}
     {ExceptionMessage}
 

The printed text has the following format for unknown exceptions:

 Caused by a {ExceptionFullStackTrace}
 

Overrides:

printException in class DefaultUWSLog

Parameters:

error - The exception to print.

out - The output in which the exception must be written.

See Also:

DefaultUWSLog.getExceptionOrigin(Throwable)

logDB

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

Description copied from interface: TAPLog

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

Specified by:

logDB in interface TAPLog

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

logTAP

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

Description copied from interface: TAPLog

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)

Specified by:

logTAP in interface TAPLog

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