Package org.hawaiiframework.logging.web.filter

Class AbstractGenericFilterBean

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.hawaiiframework.logging.web.filter.AbstractGenericFilterBean

All Implemented Interfaces:

jakarta.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

Direct Known Subclasses:

BusinessTransactionIdFilter, ClientIpLogFilter, ContainerNameHttpHeaderFilter, ContentCachingRequestResponseFilter, KibanaLogCleanupFilter, MicrometerTraceIdResponseFilter, OidcLogFilter, OpenTelemetryTraceIdResponseFilter, RequestDurationFilter, RequestIdFilter, RequestResponseLogFilter, SoftwareVersionLogFilter, TransactionIdFilter, TransactionTypeFilter

public abstract class AbstractGenericFilterBean
extends org.springframework.web.filter.OncePerRequestFilter

Adapter "interface" to be able to write FilterBeans that can be "once per request" or "for every dispatch in the request" without having to change code.

So, if a filter changes from AbstractGenericFilterBean to OncePerRequestFilter then the filter code remains the same.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	WRAPPED_REQUEST_RESPONSE

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Constructor Summary

Constructors

Constructor	Description
AbstractGenericFilterBean()

Method Summary

Modifier and Type	Method	Description
protected WrappedHttpRequestResponse	getWrapped(jakarta.servlet.http.HttpServletRequest httpServletRequest)	Retrieve the WrappedHttpRequestResponse given the httpServletRequest.
protected WrappedHttpRequestResponse	getWrapped(jakarta.servlet.http.HttpServletRequest httpServletRequest, jakarta.servlet.http.HttpServletResponse httpServletResponse)	Retrieve or create the WrappedHttpRequestResponse.

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

doFilter, doFilterInternal, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Field Details

WRAPPED_REQUEST_RESPONSE

protected static final String WRAPPED_REQUEST_RESPONSE

Constructor Details

AbstractGenericFilterBean

public AbstractGenericFilterBean()

Method Details

getWrapped

protected WrappedHttpRequestResponse getWrapped(jakarta.servlet.http.HttpServletRequest httpServletRequest)

Retrieve the WrappedHttpRequestResponse given the httpServletRequest.

Parameters:

httpServletRequest - The http servlet request.

Returns:

The, possibly null, WrappedHttpRequestResponse.

getWrapped

protected WrappedHttpRequestResponse getWrapped(jakarta.servlet.http.HttpServletRequest httpServletRequest,
 jakarta.servlet.http.HttpServletResponse httpServletResponse)

Retrieve or create the WrappedHttpRequestResponse.

Parameters:

httpServletRequest - The http servlet request.

httpServletResponse - The http servlet response.

Returns:

a, never null WrappedHttpRequestResponse.