Package com.helger.servlet.filter

Class AbstractHttpServletFilter

java.lang.Object

com.helger.servlet.filter.AbstractServletFilter

com.helger.servlet.filter.AbstractHttpServletFilter

All Implemented Interfaces:

jakarta.servlet.Filter

Direct Known Subclasses:

CharacterEncodingFilter, LoggingFilter

public abstract class AbstractHttpServletFilter
extends AbstractServletFilter

An abstract Filter implementation that only works with HttpServletRequest and HttpServletResponse. All other request and response types are not handled.

Since:

8.8.0

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
AbstractHttpServletFilter()

Method Summary

Modifier and Type	Method	Description
void	doFilter(jakarta.servlet.ServletRequest aRequest, jakarta.servlet.ServletResponse aResponse, jakarta.servlet.FilterChain aChain)
abstract void	doHttpFilter(jakarta.servlet.http.HttpServletRequest aHttpRequest, jakarta.servlet.http.HttpServletResponse aHttpResponse, jakarta.servlet.FilterChain aChain)	Implement this main filtering method in subclasses.

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

destroy, getFilterConfig, init, init, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHttpServletFilter

public AbstractHttpServletFilter()

Method Detail

doHttpFilter

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

Implement this main filtering method in subclasses.

Parameters:

aHttpRequest - The HTTP request. Never null.

aHttpResponse - The HTTP response. Never null.

aChain - The further filter chain.

Throws:

IOException - In case of an IO error

jakarta.servlet.ServletException - For non IO errors

doFilter

public final void doFilter(@Nonnull
                           jakarta.servlet.ServletRequest aRequest,
                           @Nonnull
                           jakarta.servlet.ServletResponse aResponse,
                           @Nonnull
                           jakarta.servlet.FilterChain aChain)
                    throws IOException,
                           jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException