uws.service.log

Class DefaultUWSLog

java.lang.Object

uws.service.log.DefaultUWSLog

All Implemented Interfaces:

UWSLog

public class DefaultUWSLog
extends java.lang.Object
implements UWSLog

Default implementation of UWSLog interface which lets logging any message about a UWS.

Version:

4.2 (07/2016)

Author:

Grégory Mantelet (CDS;ARI)

Nested Class Summary

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

UWSLog.LogLevel

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.PrintWriter	defaultOutput
protected UWSFileManager	fileManager
protected UWSLog.LogLevel	minLogLevel Minimum level that a message must have in order to be logged.
protected UWS	uws

Constructor Summary

Constructors

Constructor and Description
DefaultUWSLog(java.io.OutputStream output) Builds a UWSLog which will print all its messages into the given stream.
DefaultUWSLog(java.io.PrintWriter writer) Builds a UWSLog which will print all its messages into the given stream.
DefaultUWSLog(UWS uws) Builds a UWSLog which will use the file manager of the given UWS to get the log output (see UWSFileManager.getLogOutput(uws.service.log.UWSLog.LogLevel, String)).
DefaultUWSLog(UWSFileManager fm) Builds a UWSLog 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
protected boolean	canLog(UWSLog.LogLevel msgLevel) Tells whether a message with the given error level can be logged or not.
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.
java.text.DateFormat	getDateFormat() Gets the date formatter/parser to use for any date read/write into this logger.
protected java.lang.String	getExceptionOrigin(java.lang.Throwable error) Format and return the origin of the given error.
UWSLog.LogLevel	getMinLogLevel() Get the minimum level that a message must have in order to be logged.
protected java.io.PrintWriter	getOutput(UWSLog.LogLevel level, java.lang.String context) Gets an output for the given type of message to print.
void	info(java.lang.String msg) Logs the given information.
protected void	log(UWSLog.LogLevel level, java.lang.String context, java.lang.String event, java.lang.String ID, java.lang.String message, java.lang.String addColumn, java.lang.Throwable error) Logs a full message and/or error.
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) A message/error logged with this function will have the following format:
void	logHttp(UWSLog.LogLevel level, javax.servlet.http.HttpServletResponse response, java.lang.String requestId, JobOwner user, java.lang.String message, java.lang.Throwable error) A message/error logged with this function will have the following format:
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.
protected java.lang.String	normalizeMessage(java.lang.String message) Normalize a log message.
protected void	printException(java.lang.Throwable error, java.io.PrintWriter out) Format and print the given exception inside the given writer.
void	setDateFormat(java.text.DateFormat dateFormat) Sets the date formatter/parser to use for any date read/write into this logger.
void	setMinLogLevel(UWSLog.LogLevel newMinLevel) Set the minimum level that a message must have in order to be logged.
void	warning(java.lang.String msg) Logs the given warning.

Methods inherited from class java.lang.Object

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

Field Detail

uws

protected final UWS uws

fileManager

protected final UWSFileManager fileManager

defaultOutput

protected final java.io.PrintWriter defaultOutput

minLogLevel

protected UWSLog.LogLevel minLogLevel

Minimum level that a message must have in order to be logged.

The default behavior is the following:

• DEBUG: every messages are logged.
• INFO: every messages EXCEPT DEBUG are logged.
• WARNING: every messages EXCEPT DEBUG and INFO are logged.
• ERROR: only ERROR and FATAL messages are logged.
• FATAL: only FATAL messages are logged.

Since:

4.1

Constructor Detail

DefaultUWSLog

public DefaultUWSLog(UWS uws)

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

note 1: This constructor is particularly useful if the file manager of the given UWS may change.

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

Parameters:

uws - A UWS.

DefaultUWSLog

public DefaultUWSLog(UWSFileManager fm)

Builds a UWSLog 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 UWS file manager.

DefaultUWSLog

public DefaultUWSLog(java.io.OutputStream output)

Builds a UWSLog 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.

DefaultUWSLog

public DefaultUWSLog(java.io.PrintWriter writer)

Builds a UWSLog 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.

Method Detail

getConfigString

public java.lang.String getConfigString()

Description copied from interface: UWSLog

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.

Specified by:

getConfigString in interface UWSLog

Returns:

String representing the configuration of this logger.

getMinLogLevel

public final UWSLog.LogLevel getMinLogLevel()

Get the minimum level that a message must have in order to be logged.

The default behavior is the following:

• DEBUG: every messages are logged.
• INFO: every messages EXCEPT DEBUG are logged.
• WARNING: every messages EXCEPT DEBUG and INFO are logged.
• ERROR: only ERROR and FATAL messages are logged.
• FATAL: only FATAL messages are logged.

Returns:

The minimum log level.

Since:

4.1

setMinLogLevel

public final void setMinLogLevel(UWSLog.LogLevel newMinLevel)

Set the minimum level that a message must have in order to be logged.

The default behavior is the following:

• DEBUG: every messages are logged.
• INFO: every messages EXCEPT DEBUG are logged.
• WARNING: every messages EXCEPT DEBUG and INFO are logged.
• ERROR: only ERROR and FATAL messages are logged.
• FATAL: only FATAL messages are logged.

Note: If the given level is NULL, this function has no effect.

Parameters:

newMinLevel - The new minimum log level.

Since:

4.1

getDateFormat

public final java.text.DateFormat getDateFormat()

Gets the date formatter/parser to use for any date read/write into this logger.

Returns:

A date formatter/parser.

setDateFormat

public final void setDateFormat(java.text.DateFormat dateFormat)

Sets the date formatter/parser to use for any date read/write into this logger.

Parameters:

dateFormat - The date formatter/parser to use from now. (MUST BE DIFFERENT FROM NULL)

getOutput

protected java.io.PrintWriter getOutput(UWSLog.LogLevel level,
                                        java.lang.String context)

Gets an output for the given type of message to print.

The System.err output is used if none can be found in the UWS or the UWSFileManager given at the creation, or if the given output stream or writer is NULL.

Parameters:

level - Level of the message to print (DEBUG, INFO, WARNING, ERROR or FATAL).

context - Context of the message to print (UWS, HTTP, JOB, THREAD).

Returns:

A writer.

normalizeMessage

protected java.lang.String normalizeMessage(java.lang.String message)

Normalize a log message.

Since a log entry will a tab-separated concatenation of information, additional tabulations or new-lines would corrupt a log entry. This function replaces such characters by one space. Only \r are definitely deleted.

Parameters:

message - Log message to normalize.

Returns:

The normalized log message.

Since:

4.1

canLog

protected boolean canLog(UWSLog.LogLevel msgLevel)

Tells whether a message with the given error level can be logged or not.

In function of the minimum log level of this class, the default behavior is the following:

• DEBUG: every messages are logged.
• INFO: every messages EXCEPT DEBUG are logged.
• WARNING: every messages EXCEPT DEBUG and INFO are logged.
• ERROR: only ERROR and FATAL messages are logged.
• FATAL: only FATAL messages are logged.

Parameters:

msgLevel - Level of the message which has been asked to log. Note: if NULL, it will be considered as DEBUG.

Returns:

true if the message associated with the given log level can be logged, false otherwise.

Since:

4.1

log

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

Description copied from interface: UWSLog

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.

Specified by:

log in interface UWSLog

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

log

protected final void log(UWSLog.LogLevel level,
                         java.lang.String context,
                         java.lang.String event,
                         java.lang.String ID,
                         java.lang.String message,
                         java.lang.String addColumn,
                         java.lang.Throwable error)

Logs a full message and/or error.

Note: If no message and error is provided, nothing will be written.

Parameters:

level - Level of the error (DEBUG, INFO, WARNING, ERROR, FATAL). SHOULD NOT be NULL

context - Context of the error (UWS, HTTP, THREAD, JOB). MAY be NULL

event - Context event during which this log is emitted. MAY be NULL

ID - ID of the job or HTTP request (it may also be an ID of anything else). MAY BE NULL

message - Message of the error. MAY be NULL

addColumn - Additional column to append after the message and before the stack trace.

error - Error at the origin of the log error/warning/fatal. MAY be NULL

Since:

4.1

printException

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

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}
 

Parameters:

error - The exception to print.

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

Since:

4.1

See Also:

getExceptionOrigin(Throwable)

getExceptionOrigin

protected java.lang.String getExceptionOrigin(java.lang.Throwable error)

Format and return the origin of the given error. "Origin" means here: "where the error has been thrown from?" (from which class? method? file? line?).

This function does nothing if the given error is NULL or if the origin information is missing.

The returned text has the following format:

 at {OriginClass}.{OriginMethod}({OriginFile}:{OriginLine})
 

{OriginFile} and {OriginLine} are written only if provided.

Parameters:

error - Error whose the origin should be returned.

Returns:

A string which contains formatted information about the origin of the given error.

Since:

4.1

debug

public void debug(java.lang.String msg)

Description copied from interface: UWSLog

Logs a debug message.

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

Specified by:

debug in interface UWSLog

Parameters:

msg - A DEBUG message.

debug

public void debug(java.lang.Throwable t)

Description copied from interface: UWSLog

Logs an exception as a debug message.

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

Specified by:

debug in interface UWSLog

Parameters:

t - An exception.

debug

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

Description copied from interface: UWSLog

Logs a full (message+exception) debug message.

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

Specified by:

debug in interface UWSLog

Parameters:

msg - A DEBUG message.

t - An exception.

info

public void info(java.lang.String msg)

Description copied from interface: UWSLog

Logs the given information.

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

Specified by:

info in interface UWSLog

Parameters:

msg - An INFO message.

warning

public void warning(java.lang.String msg)

Description copied from interface: UWSLog

Logs the given warning.

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

Specified by:

warning in interface UWSLog

Parameters:

msg - A WARNING message.

error

public void error(java.lang.String msg)

Description copied from interface: UWSLog

Logs the given error.

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

Specified by:

error in interface UWSLog

Parameters:

msg - An ERROR message.

error

public void error(java.lang.Throwable t)

Description copied from interface: UWSLog

Logs the given exception as an error.

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

Specified by:

error in interface UWSLog

Parameters:

t - An exception.

error

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

Description copied from interface: UWSLog

Logs a full (message+exception) error message.

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

Specified by:

error in interface UWSLog

Parameters:

msg - An ERROR message.

t - An exception.

logHttp

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

A message/error logged with this function will have the following format:

<TIMESTAMP> <LEVEL>   HTTP    REQUEST_RECEIVED        <REQUEST_ID>      <MESSAGE> <HTTP_METHOD> in <CONTENT_TYPE> at <URL> from <IP_ADDR> using <USER_AGENT> with parameters (<PARAM1>=<VAL1>&...)

Specified by:

logHttp in interface UWSLog

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

See Also:

UWSLog.logHttp(uws.service.log.UWSLog.LogLevel, javax.servlet.http.HttpServletRequest, java.lang.String, java.lang.String, java.lang.Throwable)

logHttp

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

A message/error logged with this function will have the following format:

<TIMESTAMP> <LEVEL>   HTTP    RESPONSE_SENT   <REQUEST_ID>      <MESSAGE> HTTP-<STATUS_CODE> to the user <USER> as <CONTENT_TYPE>

,where <USER> may be either "(id:<USER_ID>;pseudo:<USER_PSEUDO>)" or "ANONYMOUS".

Specified by:

logHttp in interface UWSLog

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

See Also:

UWSLog.logHttp(uws.service.log.UWSLog.LogLevel, javax.servlet.http.HttpServletResponse, java.lang.String, uws.job.user.JobOwner, java.lang.String, java.lang.Throwable)

logUWS

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

Description copied from interface: UWSLog

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)

Specified by:

logUWS in interface UWSLog

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

logJob

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

Description copied from interface: UWSLog

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

Specified by:

logJob in interface UWSLog

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

logThread

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

Description copied from interface: UWSLog

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

Specified by:

logThread in interface UWSLog

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