Package com.helger.servlet.logging

Class LoggingFilter

java.lang.Object

com.helger.servlet.filter.AbstractServletFilter

com.helger.servlet.filter.AbstractHttpServletFilter

com.helger.servlet.logging.LoggingFilter

All Implemented Interfaces:

jakarta.servlet.Filter

public class LoggingFilter
extends AbstractHttpServletFilter

Constructor Summary

Constructors

Constructor	Description
LoggingFilter()

Method Summary

Modifier and Type	Method	Description
void	doHttpFilter(jakarta.servlet.http.HttpServletRequest aHttpRequest, jakarta.servlet.http.HttpServletResponse aHttpResponse, jakarta.servlet.FilterChain aFilterChain)	Implement this main filtering method in subclasses.
protected String	getRequestDescription(LoggingHttpServletRequestWrapper aRequestWrapper)
protected String	getResponseDescription(LoggingHttpServletResponseWrapper responseWrapper)
void	init()	Init this filter
static boolean	isGloballyEnabled()
protected boolean	isLogRequest(jakarta.servlet.http.HttpServletRequest aHttpRequest, jakarta.servlet.http.HttpServletResponse aHttpResponse)	Check if this request should be logged or not.
static void	setGloballyEnabled(boolean bEnabled)

Methods inherited from class com.helger.servlet.filter.AbstractHttpServletFilter

doFilter

Methods inherited from class com.helger.servlet.filter.AbstractServletFilter

destroy, getFilterConfig, init, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingFilter

public LoggingFilter()

Method Detail

setGloballyEnabled

public static void setGloballyEnabled(boolean bEnabled)

isGloballyEnabled

public static boolean isGloballyEnabled()

init

@OverridingMethodsMustInvokeSuper
public void init()
          throws jakarta.servlet.ServletException

Description copied from class: AbstractServletFilter

Init this filter

Overrides:

init in class AbstractServletFilter

Throws:

jakarta.servlet.ServletException - In case of an error

getRequestDescription

@Nonnull
@OverrideOnDemand
protected String getRequestDescription(@Nonnull
                                       LoggingHttpServletRequestWrapper aRequestWrapper)

getResponseDescription

@Nonnull
@OverrideOnDemand
protected String getResponseDescription(@Nonnull
                                        LoggingHttpServletResponseWrapper responseWrapper)

isLogRequest

@OverrideOnDemand
protected boolean isLogRequest(@Nonnull
                               jakarta.servlet.http.HttpServletRequest aHttpRequest,
                               @Nonnull
                               jakarta.servlet.http.HttpServletResponse aHttpResponse)

Check if this request should be logged or not.

Parameters:

aHttpRequest - Current HTTP servlet request. Never null.

aHttpResponse - Current HTTP servlet response. Never null.

Returns:

true to log, false to not log the request

doHttpFilter

public void doHttpFilter(@Nonnull
                         jakarta.servlet.http.HttpServletRequest aHttpRequest,
                         @Nonnull
                         jakarta.servlet.http.HttpServletResponse aHttpResponse,
                         @Nonnull
                         jakarta.servlet.FilterChain aFilterChain)
                  throws IOException,
                         jakarta.servlet.ServletException

Description copied from class: AbstractHttpServletFilter

Implement this main filtering method in subclasses.

Specified by:

doHttpFilter in class AbstractHttpServletFilter

Parameters:

aHttpRequest - The HTTP request. Never null.

aHttpResponse - The HTTP response. Never null.

aFilterChain - The further filter chain.

Throws:

IOException - In case of an IO error

jakarta.servlet.ServletException - For non IO errors