uws.service.log

Interface UWSLog

All Known Implementing Classes:

DefaultUWSLog, Slf4jUWSLog

public interface UWSLog

Let log any kind of message about a UWS service.

Version:

4.3 (07/2018)

Author:

Grégory Mantelet (CDS;ARI)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UWSLog.LogLevel Indicate the level of the error: debug, info, warning or error.

Method Summary

Modifier and Type	Method and Description
void	debug(java.lang.String msg) Logs a debug message.
void	debug(java.lang.String msg, java.lang.Throwable t) Logs a full (message+exception) debug message.
void	debug(java.lang.Throwable t) Logs an exception as a debug message.
void	error(java.lang.String msg) Logs the given error.
void	error(java.lang.String msg, java.lang.Throwable t) Logs a full (message+exception) error message.
void	error(java.lang.Throwable t) Logs the given exception as an error.
java.lang.String	getConfigString() Get a string representing the configuration of this logger.
void	info(java.lang.String msg) Logs the given information.
void	log(UWSLog.LogLevel level, java.lang.String context, java.lang.String message, java.lang.Throwable error) Generic way to log a message and/or an exception.
void	logHttp(UWSLog.LogLevel level, javax.servlet.http.HttpServletRequest request, java.lang.String requestId, java.lang.String message, java.lang.Throwable error) Log a message and/or an error in the HTTP context.
void	logHttp(UWSLog.LogLevel level, javax.servlet.http.HttpServletResponse response, java.lang.String requestId, JobOwner user, java.lang.String message, java.lang.Throwable error) Log a message and/or an error in the HTTP context.
void	logJob(UWSLog.LogLevel level, UWSJob job, java.lang.String event, java.lang.String message, java.lang.Throwable error) Log a message and/or an error in the JOB context.
void	logThread(UWSLog.LogLevel level, java.lang.Thread thread, java.lang.String event, java.lang.String message, java.lang.Throwable error) Log a message and/or an error in the THREAD context.
void	logUWS(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 UWS.
void	warning(java.lang.String msg) Logs the given warning.

Method Detail

getConfigString

java.lang.String getConfigString()

Get a string representing the configuration of this logger.

The result of this function aims to be logged when the logging mechanism is successfully configured and ready to be used.

Returns:

String representing the configuration of this logger.

Since:

4.3.

log

void log(UWSLog.LogLevel level,
         java.lang.String context,
         java.lang.String message,
         java.lang.Throwable error)

Generic way to log a message and/or an exception.

Note: The other functions of this class or extension, MAY be equivalent to a call to this function with some specific parameter values. It should be especially the case for the debug(...), info(...), warning(...) and error(...) functions.

Parameters:

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

context - Context of the log item (HTTP, Thread, Job, UWS, ...). MAY be NULL

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

Since:

4.1

debug

void debug(java.lang.String msg)

Logs a debug message.

Note: This function should be equals to: log(LogLevel.WARNING, null, msg, null)

Parameters:

msg - A DEBUG message.

debug

void debug(java.lang.Throwable t)

Logs an exception as a debug message.

Note: This function should be equals to: log(LogLevel.WARNING, null, null, t)

Parameters:

t - An exception.

debug

void debug(java.lang.String msg,
           java.lang.Throwable t)

Logs a full (message+exception) debug message.

Note: This function should be equals to: log(LogLevel.WARNING, null, msg, t)

Parameters:

msg - A DEBUG message.

t - An exception.

info

void info(java.lang.String msg)

Logs the given information.

Note: This function should be equals to: log(LogLevel.INFO, null, msg, null)

Parameters:

msg - An INFO message.

warning

void warning(java.lang.String msg)

Logs the given warning.

Note: This function should be equals to: log(LogLevel.WARNING, null, msg, null)

Parameters:

msg - A WARNING message.

error

void error(java.lang.String msg)

Logs the given error.

Note: This function should be equals to: log(LogLevel.ERROR, null, msg, null)

Parameters:

msg - An ERROR message.

error

void error(java.lang.Throwable t)

Logs the given exception as an error.

Note: This function should be equals to: log(LogLevel.ERROR, null, null, t)

Parameters:

t - An exception.

error

void error(java.lang.String msg,
           java.lang.Throwable t)

Logs a full (message+exception) error message.

Note: This function should be equals to: log(LogLevel.ERROR, null, msg, t)

Parameters:

msg - An ERROR message.

t - An exception.

logUWS

void logUWS(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 UWS.

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):

• INIT (with "obj" as an instance of UWS except in case of error where "obj" is NULL)
• ADD_JOB_LIST (with "obj" as an instance of JobList)
• DESTROY_JOB_LIST (with "obj" as an instance of JobList)
• DESTROY_JOB (with "obj" as an instance of UWSUrl)
• SERIALIZE (with "obj" as an instance of UWSUrl)
• SET_PARAM (with "obj" as an instance of HttpServletRequest in case of error)
• GET_RESULT (with "obj" as an instance of Result)
• GET_ERROR (with "obj" as an instance of ErrorSummary)
• RESTORATION (with "obj" the raw object to de-serialize (may be JSONObject or JSONArray or NULL))
• BACKUP (with "obj" the object to backup ; may be JobOwner, a UWSJob, ...)
• RESTORED (with "obj" as an integer array of 4 items: nb of restored jobs, total nb of jobs, nb of restored users, total nb of users)
• BACKUPED (with "obj" as an integer array of 4 items: nb of saved jobs, total nb of jobs, nb of saved users, total nb of users or with just 2 items (the two last ones))
• FORMAT_ERROR (with a NULL "obj")
• STOP (with "obj" as an instance of UWS)

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 UWS while this log is sent. MAY be NULL

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

Since:

4.1

logHttp

void logHttp(UWSLog.LogLevel level,
             javax.servlet.http.HttpServletRequest request,
             java.lang.String requestId,
             java.lang.String message,
             java.lang.Throwable error)

Log a message and/or an error in the HTTP context. This log function is called when a request is received by the service. Consequently, the event is: REQUEST_RECEIVED.

Note: When a request is received, this function is called, and then, when the response has been written and sent to the client, logHttp(LogLevel, HttpServletResponse, String, JobOwner, String, Throwable) should be called. These functions should always work together.

Parameters:

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

request - HTTP request received by the service. SHOULD NOT be NULL

requestId - ID to use to identify this request until its response is sent.

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

Since:

4.1

See Also:

logHttp(LogLevel, HttpServletResponse, String, JobOwner, String, Throwable)

logHttp

void logHttp(UWSLog.LogLevel level,
             javax.servlet.http.HttpServletResponse response,
             java.lang.String requestId,
             JobOwner user,
             java.lang.String message,
             java.lang.Throwable error)

Log a message and/or an error in the HTTP context. This log function is called when a response is sent to the client by the service. Consequently, the event is: RESPONSE_SENT.

Note: When a request is received, logHttp(LogLevel, HttpServletRequest, String, String, Throwable) is called, and then, when the response has been written and sent to the client, this function should be called. These functions should always work together.

Parameters:

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

response - HTTP response sent by the service to the client. MAY be NULL if an error occurs while writing the response

requestId - ID to use to identify the request to which the given response is answering.

user - Identified user which has sent the received request.

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

Since:

4.1

See Also:

logHttp(LogLevel, HttpServletRequest, String, String, Throwable)

logJob

void logJob(UWSLog.LogLevel level,
            UWSJob job,
            java.lang.String event,
            java.lang.String message,
            java.lang.Throwable error)

Log a message and/or an error in the JOB context.

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

• CREATED
• QUEUE
• START
• ABORT
• ERROR
• ARCHIVE
• EXECUTING
• CHANGE_PHASE
• NOTIFY
• END
• SERIALIZE
• MOVE_UPLOAD
• ADD_RESULT
• SET_DESTRUCTION
• SET_ERROR
• CLEAR_RESOURCES
• DESTROY

Parameters:

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

job - Job from which this log comes. MAY be NULL

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

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

Since:

4.1

logThread

void logThread(UWSLog.LogLevel level,
               java.lang.Thread thread,
               java.lang.String event,
               java.lang.String message,
               java.lang.Throwable error)

Log a message and/or an error in the THREAD context.

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

• START
• SET_ERROR
• END

Parameters:

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

thread - Thread from which this log comes. MAY be NULL

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

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

Since:

4.1