com.devonfw.module.logging.common.impl

Class DiagnosticContextFilter

java.lang.Object

com.devonfw.module.logging.common.impl.DiagnosticContextFilter

All Implemented Interfaces:

javax.servlet.Filter

public class DiagnosticContextFilter
extends Object
implements javax.servlet.Filter

Request logging filter that adds the request log message to the SLF4j mapped diagnostic context (MDC) before the request is processed, removing it again after the request is processed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CORRELATION_ID_HEADER_NAME_DEFAULT The default value for setCorrelationIdHttpHeaderName(String).
private static String	CORRELATION_ID_HEADER_NAME_PARAM The name of the init parameter for setCorrelationIdHttpHeaderName(String).
private String	correlationIdHttpHeaderName
private DiagnosticContextFacade	diagnosticContextFacade
private static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
DiagnosticContextFilter() The constructor.

Method Summary

Modifier and Type	Method and Description
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
void	init(javax.servlet.FilterConfig config)
private static String	normalizeValue(String value)
private void	setCorrelationId(javax.servlet.ServletRequest request)
void	setCorrelationIdHttpHeaderName(String correlationIdHttpHeaderName)
void	setDiagnosticContextFacade(DiagnosticContextFacade diagnosticContextFacade)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

CORRELATION_ID_HEADER_NAME_PARAM

private static final String CORRELATION_ID_HEADER_NAME_PARAM

The name of the init parameter for setCorrelationIdHttpHeaderName(String).

See Also:

Constant Field Values

CORRELATION_ID_HEADER_NAME_DEFAULT

public static final String CORRELATION_ID_HEADER_NAME_DEFAULT

The default value for setCorrelationIdHttpHeaderName(String).

See Also:

Constant Field Values

correlationIdHttpHeaderName

private String correlationIdHttpHeaderName

See Also:

setCorrelationIdHttpHeaderName(String)

diagnosticContextFacade

private DiagnosticContextFacade diagnosticContextFacade

Constructor Detail

DiagnosticContextFilter

public DiagnosticContextFilter()

The constructor.

Method Detail

setCorrelationIdHttpHeaderName

public void setCorrelationIdHttpHeaderName(String correlationIdHttpHeaderName)

Parameters:

correlationIdHttpHeaderName - is the name of the HTTP header for the correlation ID.

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

normalizeValue

private static String normalizeValue(String value)

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

setCorrelationId

private void setCorrelationId(javax.servlet.ServletRequest request)

setDiagnosticContextFacade

@Inject
public void setDiagnosticContextFacade(DiagnosticContextFacade diagnosticContextFacade)

Parameters:

diagnosticContextFacade - the diagnosticContextFacade to set

init

public void init(javax.servlet.FilterConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException