Package com.persequor.extension.logging

Interface ISagaLoggerWithContext

All Known Implementing Classes:

SagaLoggerWithContext

public interface ISagaLoggerWithContext

ISagaLoggerWithContext is the main interface for logging in Saga SDK with a pre defined context. It is expected that logging takes place through concrete implementations of this interface.

Typical usage pattern:

 import com.persequor.extension.logging.ISagaLogger;
 import com.persequor.extension.logging.LoggingCategory;
 import com.persequor.extension.logging.LoggingContext;
 import com.persequor.extension.logging.LoggingMessage;

 public class LoggingExampleController {
        private ISagaLoggerWithContext logger = sagaLoggerFactory.get(getClass(), LoggingContext.CORE);

        public void helloWithCustomLoggingContext() {
                // this logging will override LoggingContext provided when getting an instance of ISagaLogger from the factory
                logger.info(LoggingCategory.SYSTEM, LoggingMessage.get("hello from custom context"), LoggingMessage.get("our Recomendation"));
    }
 }
 

Method Summary

Modifier and Type	Method	Description
default ISagaLoggerWithContext	changeContext(LoggingContext context)	Provides ISagaLoggerWithContext instance allowing the developer to use a logger with a different context.
default void	debug(LoggingCategory category, LoggingMessage message)	Log a message at the DEBUG level according to the logging category, logging context, message and recommendation message
void	debug(LoggingCategory category, LoggingMessage message, Throwable throwable)	Log a message at the DEBUG level according to the logging category, logging context, message and recommendation message
default void	error(LoggingCategory category, LoggingMessage message, LoggingMessage recommendation)	Log a message at the ERROR level according to the logging category, logging context, message and recommendation message
void	error(LoggingCategory category, LoggingMessage message, LoggingMessage recommendation, Throwable throwable)	Log a message at the ERROR level according to the logging category, logging context, message and recommendation message
default void	info(LoggingCategory category, LoggingMessage message)	Log a message at the INFO level according to the logging category, logging context, message and recommendation message
void	info(LoggingCategory category, LoggingMessage message, Throwable throwable)	Log a message at the INFO level according to the logging category, logging context, message and recommendation message
default void	trace(LoggingCategory category, LoggingMessage message)	Log a message at the TRACE level according to the logging category, logging context, message and recommendation message
void	trace(LoggingCategory category, LoggingMessage message, Throwable throwable)	Log a message at the TRACE level according to the logging category, logging context, message and recommendation message
default void	warn(LoggingCategory category, LoggingMessage message, LoggingMessage recommendation)	Log a message at the WARN level according to the logging category, logging context, message and recommendation message
void	warn(LoggingCategory category, LoggingMessage message, LoggingMessage recommendation, Throwable throwable)	Log a message at the WARN level according to the logging category, logging context, message and recommendation message
ISagaLogger	withoutContext()	Provides ISagaLogger instance allowing the developer to use a logger with a custom context.

Method Details

trace

default void trace(LoggingCategory category,
 LoggingMessage message)

Log a message at the TRACE level according to the logging category, logging context, message and recommendation message

Parameters:

category - the logging category LoggingCategory

message - the templated message LoggingMessage

trace

void trace(LoggingCategory category,
 LoggingMessage message,
 Throwable throwable)

Log a message at the TRACE level according to the logging category, logging context, message and recommendation message

Parameters:

category - the logging category LoggingCategory

message - the templated message LoggingMessage

throwable - a throwable to be logged Throwable

debug

default void debug(LoggingCategory category,
 LoggingMessage message)

Log a message at the DEBUG level according to the logging category, logging context, message and recommendation message

Parameters:

category - the logging category LoggingCategory

message - the templated message LoggingMessage

debug

void debug(LoggingCategory category,
 LoggingMessage message,
 Throwable throwable)

Log a message at the DEBUG level according to the logging category, logging context, message and recommendation message

Parameters:

category - the logging category LoggingCategory

message - the templated message LoggingMessage

throwable - a throwable to be logged Throwable

info

default void info(LoggingCategory category,
 LoggingMessage message)

Log a message at the INFO level according to the logging category, logging context, message and recommendation message

Parameters:

category - the logging category LoggingCategory

message - the templated message LoggingMessage

info

void info(LoggingCategory category,
 LoggingMessage message,
 Throwable throwable)

Log a message at the INFO level according to the logging category, logging context, message and recommendation message

Parameters:

category - the logging category LoggingCategory

message - the templated message LoggingMessage

throwable - a throwable to be logged Throwable

warn

default void warn(LoggingCategory category,
 LoggingMessage message,
 LoggingMessage recommendation)

Log a message at the WARN level according to the logging category, logging context, message and recommendation message

Parameters:

category - the logging category LoggingCategory

message - the templated message LoggingMessage

recommendation - the recommendation message LoggingMessage

warn

void warn(LoggingCategory category,
 LoggingMessage message,
 LoggingMessage recommendation,
 Throwable throwable)

Log a message at the WARN level according to the logging category, logging context, message and recommendation message

Parameters:

category - the logging category LoggingCategory

message - the templated message LoggingMessage

recommendation - the recommendation message LoggingMessage

throwable - a throwable to be logged Throwable

error

default void error(LoggingCategory category,
 LoggingMessage message,
 LoggingMessage recommendation)

Log a message at the ERROR level according to the logging category, logging context, message and recommendation message

Parameters:

category - the logging category LoggingCategory

message - the templated message LoggingMessage

recommendation - the recommendation message LoggingMessage

error

void error(LoggingCategory category,
 LoggingMessage message,
 LoggingMessage recommendation,
 Throwable throwable)

Log a message at the ERROR level according to the logging category, logging context, message and recommendation message

Parameters:

category - the logging category LoggingCategory

message - the templated message LoggingMessage

recommendation - the recommendation message LoggingMessage

throwable - a throwable to be logged Throwable

withoutContext

ISagaLogger withoutContext()

Provides ISagaLogger instance allowing the developer to use a logger with a custom context.

Returns:

an instance of ISagaLogger.

See Also:

• ISagaLogger

changeContext

default ISagaLoggerWithContext changeContext(LoggingContext context)

Provides ISagaLoggerWithContext instance allowing the developer to use a logger with a different context.

Returns:

an instance of ISagaLoggerWithContext.