com.devonfw.module.logging.common.api

Interface DiagnosticContextFacade

All Known Implementing Classes:

DiagnosticContextFacadeImpl

public interface DiagnosticContextFacade

This is the interface for a simple facade to write data into the mapped diagnostic context. As additional value you can easily hook in custom extensions without interfering the logger implementation. A use case may be to provide diagnostic informations also to additional components such as a performance monitoring module. Therefore setting diagnostic information from devon4j code is always indirected via this interface so the implementation can be extended or replaced (what is not as easy for static methods).

Method Summary

Modifier and Type	Method and Description
String	getCorrelationId()
void	removeCorrelationId() Removes the correlation ID from the diagnostic context.
void	setCorrelationId(String correlationId) Sets the correlation ID for the current processing and thread.

Method Detail

getCorrelationId

String getCorrelationId()

Returns:

the current correlation ID or null if not set.

setCorrelationId

void setCorrelationId(String correlationId)

Sets the correlation ID for the current processing and thread.

Parameters:

correlationId - is the correlation ID as unique identifier for the current processing task.

removeCorrelationId

void removeCorrelationId()

Removes the correlation ID from the diagnostic context.