com.sap.smp.client.supportability

Interface ClientLogger

public interface ClientLogger

Logger doing logging with different log levels.

Note that this API shall not be used to log sensitive data, such as authentication data (passwords, tokens, crypto keys), personal data (user’s name, address, gender, age etc.), or business confidential data (request data). Only necessary metadata about the client program’s execution behavior and not about server behavior and error information shall be written to the log.

E2E tracing information is provided to the logger via the TraceInfo argument on the various log methods. Each such method has an overloaded variant which accepts an object of this type as an extra argument. If this argument is set to null then that method behaves exactly the same as the original method not having a TraceInfo argument.

As such, when there's no trace information present then the correlation ID is taken from the enclosing ClientLogManager. Otherwise, it's taken from the TraceInfo object. Check the documentation of that interface for details on how to obtain an object of that type.

Method Summary

Modifier and Type	Method and Description
java.util.EnumSet<ClientLogDestination>	getLogDestinations() Retrieves the set of destinations assigned to the given logger.
ClientLogLevel	getLogLevel() Retrieves the current log level assigned to the given logger.
boolean	isDestinationSet(ClientLogDestination destination) Tells whether a destination is set for the given logger or not.
void	log(ClientLogLevel level, java.lang.String message) Generates a log with the given level.
void	log(ClientLogLevel level, java.lang.String message, java.lang.Throwable tr) Generates a log with the given level.
void	log(ClientLogLevel level, java.lang.String message, java.lang.Throwable tr, TraceInfo traceInfo) Generates a log with the given level.
void	log(ClientLogLevel level, java.lang.String message, TraceInfo traceInfo) Generates a log with the given level.
void	logDebug(java.lang.String message) Logs the message with level DEBUG.
void	logDebug(java.lang.String message, java.lang.Throwable tr) Logs the message with level DEBUG.
void	logDebug(java.lang.String message, java.lang.Throwable tr, TraceInfo traceInfo) Logs the message with level DEBUG.
void	logDebug(java.lang.String message, TraceInfo traceInfo) Logs the message with level DEBUG.
void	logError(java.lang.String message) Logs the message with level ERROR.
void	logError(java.lang.String message, java.lang.Throwable tr) Logs the message with level ERROR.
void	logError(java.lang.String message, java.lang.Throwable tr, TraceInfo traceInfo) Logs the message with level ERROR.
void	logError(java.lang.String message, TraceInfo traceInfo) Logs the message with level ERROR.
void	logFatal(java.lang.String message) Logs the message with level FATAL.
void	logFatal(java.lang.String message, java.lang.Throwable tr) Logs the message with level FATAL.
void	logFatal(java.lang.String message, java.lang.Throwable tr, TraceInfo traceInfo) Logs the message with level FATAL.
void	logFatal(java.lang.String message, TraceInfo traceInfo) Logs the message with level FATAL.
void	logInfo(java.lang.String message) Logs the message with level INFO.
void	logInfo(java.lang.String message, java.lang.Throwable tr) Logs the message with level INFO.
void	logInfo(java.lang.String message, java.lang.Throwable tr, TraceInfo traceInfo) Logs the message with level INFO.
void	logInfo(java.lang.String message, TraceInfo traceInfo) Logs the message with level INFO.
void	logWarning(java.lang.String message) Logs the message with level WARNING.
void	logWarning(java.lang.String message, java.lang.Throwable tr) Logs the message with level WARNING.
void	logWarning(java.lang.String message, java.lang.Throwable tr, TraceInfo traceInfo) Logs the message with level WARNING.
void	logWarning(java.lang.String message, TraceInfo traceInfo) Logs the message with level WARNING.

Method Detail

getLogLevel

ClientLogLevel getLogLevel()

Retrieves the current log level assigned to the given logger.

Returns:

getLogDestinations

java.util.EnumSet<ClientLogDestination> getLogDestinations()

Retrieves the set of destinations assigned to the given logger.

Returns:

set of destinations, always non-null

isDestinationSet

boolean isDestinationSet(ClientLogDestination destination)

Tells whether a destination is set for the given logger or not. If the argument is null then this method returns false.

Parameters:

destination - the destination, can be null

Returns:

true if the destination is set, false otherwise

log

void log(ClientLogLevel level,
         java.lang.String message)

Generates a log with the given level.

Parameters:

level - log level

message - the log message, must be non-null

logFatal

void logFatal(java.lang.String message)

Logs the message with level FATAL. Precondition: logging messages with level FATAL or less critical is enabled.

Parameters:

message - the log message, must be non-null

logError

void logError(java.lang.String message)

Logs the message with level ERROR. Precondition: logging messages with level ERROR or less critical is enabled.

Parameters:

message - the log message, must be non-null

logWarning

void logWarning(java.lang.String message)

Logs the message with level WARNING. Precondition: logging messages with level WARNING or less critical is enabled. Use this level to signal situations that may require attention but are not critical or irrecoverable issues.

Parameters:

message - the log message, must be non-null

logDebug

void logDebug(java.lang.String message)

Logs the message with level DEBUG. Precondition: logging messages with level DEBUG or INFO is enabled. Use for low priority messages used during development.

Parameters:

message - the log message, must be non-null

logInfo

void logInfo(java.lang.String message)

Logs the message with level INFO. Precondition: logging messages with level INFO is enabled. This is the log level with the lowest priority, should be used to log least significant information.

Parameters:

message - the log message, must be non-null

log

void log(ClientLogLevel level,
         java.lang.String message,
         java.lang.Throwable tr)

Generates a log with the given level.

Parameters:

level - log level

message - the log message, must be non-null

tr - exception to log, can be null

logFatal

void logFatal(java.lang.String message,
              java.lang.Throwable tr)

Logs the message with level FATAL. Precondition: logging messages with level FATAL or less critical is enabled.

Parameters:

message - the log message, must be non-null

tr - exception to log, can be null

logError

void logError(java.lang.String message,
              java.lang.Throwable tr)

Logs the message with level ERROR. Precondition: logging messages with level ERROR or less critical is enabled.

Parameters:

message - the log message, must be non-null

tr - exception to log, can be null

logWarning

void logWarning(java.lang.String message,
                java.lang.Throwable tr)

Logs the message with level WARNING. Precondition: logging messages with level WARNING or less critical is enabled. Use this level to signal situations that may require attention but are not critical or irrecoverable issues.

Parameters:

message - the log message, must be non-null

tr - exception to log, can be null

logDebug

void logDebug(java.lang.String message,
              java.lang.Throwable tr)

Logs the message with level DEBUG. Precondition: logging messages with level DEBUG or INFO is enabled. Use for low priority messages used during development.

Parameters:

message - the log message, must be non-null

tr - exception to log, can be null

logInfo

void logInfo(java.lang.String message,
             java.lang.Throwable tr)

Logs the message with level INFO. Precondition: logging messages with level INFO is enabled. This is the log level with the lowest priority, should be used to log least significant information.

Parameters:

message - the log message, must be non-null

tr - exception to log, can be null

log

void log(ClientLogLevel level,
         java.lang.String message,
         TraceInfo traceInfo)

Generates a log with the given level. Trace information is provided, as well.

Parameters:

level - log level

traceInfo - the trace info object, can be null

message - the log message, must be non-null

logFatal

void logFatal(java.lang.String message,
              TraceInfo traceInfo)

Logs the message with level FATAL. Precondition: logging messages with level FATAL or less critical is enabled. Trace information is provided, as well.

Parameters:

message - the log message, must be non-null

traceInfo - the trace info object, can be null

logError

void logError(java.lang.String message,
              TraceInfo traceInfo)

Logs the message with level ERROR. Precondition: logging messages with level ERROR or less critical is enabled. Trace information is provided, as well.

Parameters:

message - the log message, must be non-null

traceInfo - the trace info object, can be null

logWarning

void logWarning(java.lang.String message,
                TraceInfo traceInfo)

Logs the message with level WARNING. Precondition: logging messages with level WARNING or less critical is enabled. Use this level to signal situations that may require attention but are not critical or irrecoverable issues. Trace information is provided, as well.

Parameters:

message - the log message, must be non-null

traceInfo - the trace info object, can be null

logDebug

void logDebug(java.lang.String message,
              TraceInfo traceInfo)

Logs the message with level DEBUG. Precondition: logging messages with level DEBUG or INFO is enabled. Use for low priority messages used during development. Trace information is provided, as well.

Parameters:

message - the log message, must be non-null

traceInfo - the trace info object, can be null

logInfo

void logInfo(java.lang.String message,
             TraceInfo traceInfo)

Logs the message with level INFO. Precondition: logging messages with level INFO is enabled. This is the log level with the lowest priority, should be used to log least significant information. Trace information is provided, as well.

Parameters:

message - the log message, must be non-null

traceInfo - the trace info object, can be null

log

void log(ClientLogLevel level,
         java.lang.String message,
         java.lang.Throwable tr,
         TraceInfo traceInfo)

Generates a log with the given level. Trace information is provided, as well.

Parameters:

level - log level

message - the log message, must be non-null

tr - exception to log, can be null

traceInfo - the trace info object, can be null

logFatal

void logFatal(java.lang.String message,
              java.lang.Throwable tr,
              TraceInfo traceInfo)

Logs the message with level FATAL. Precondition: logging messages with level FATAL or less critical is enabled. Trace information is provided, as well.

Parameters:

message - the log message, must be non-null

tr - exception to log, can be null

traceInfo - the trace info object, can be null

logError

void logError(java.lang.String message,
              java.lang.Throwable tr,
              TraceInfo traceInfo)

Logs the message with level ERROR. Precondition: logging messages with level ERROR or less critical is enabled. Trace information is provided, as well.

Parameters:

message - the log message, must be non-null

tr - exception to log, can be null

traceInfo - the trace info object, can be null

logWarning

void logWarning(java.lang.String message,
                java.lang.Throwable tr,
                TraceInfo traceInfo)

Logs the message with level WARNING. Precondition: logging messages with level WARNING or less critical is enabled. Use this level to signal situations that may require attention but are not critical or irrecoverable issues. Trace information is provided, as well.

Parameters:

message - the log message, must be non-null

tr - exception to log, can be null

traceInfo - the trace info object, can be null

logDebug

void logDebug(java.lang.String message,
              java.lang.Throwable tr,
              TraceInfo traceInfo)

Logs the message with level DEBUG. Precondition: logging messages with level DEBUG or INFO is enabled. Use for low priority messages used during development. Trace information is provided, as well.

Parameters:

message - the log message, must be non-null

tr - exception to log, can be null

traceInfo - the trace info object, can be null

logInfo

void logInfo(java.lang.String message,
             java.lang.Throwable tr,
             TraceInfo traceInfo)

Logs the message with level INFO. Precondition: logging messages with level INFO is enabled. This is the log level with the lowest priority, should be used to log least significant information. Trace information is provided, as well.

Parameters:

message - the log message, must be non-null

tr - exception to log, can be null

traceInfo - the trace info object, can be null