Package com.soklet.web.request

Class SokletFilter

java.lang.Object

com.soklet.web.request.SokletFilter

All Implemented Interfaces:

Filter

@Singleton
public class SokletFilter
extends Object
implements Filter

Since:

1.1.2

Author:

Mark Allen

Field Summary

Fields

Modifier and Type	Field	Description
static String	STATIC_FILES_URL_PATTERN_PARAM

Constructor Summary

Constructors

Constructor	Description
SokletFilter(RouteMatcher routeMatcher, ResponseHandler responseHandler)

Method Summary

Modifier and Type	Method	Description
void	destroy()
void	doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
void	init(FilterConfig filterConfig)
boolean	shouldAllowRequestBodyRepeatableReads(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Optional<Route> route)	Should this request body be cached in-memory to support repeated reads?

Methods inherited from class java.lang.Object

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

Field Details

STATIC_FILES_URL_PATTERN_PARAM

public static String STATIC_FILES_URL_PATTERN_PARAM

Constructor Details

SokletFilter

@Inject
public SokletFilter(RouteMatcher routeMatcher,
 ResponseHandler responseHandler)

Method Details

init

public void init(FilterConfig filterConfig)
          throws ServletException

Specified by:

init in interface Filter

Throws:

ServletException

destroy

public void destroy()

Specified by:

destroy in interface Filter

doFilter

public void doFilter(ServletRequest servletRequest,
 ServletResponse servletResponse,
 FilterChain filterChain)
              throws IOException,
ServletException

Specified by:

doFilter in interface Filter

Throws:

IOException

ServletException

shouldAllowRequestBodyRepeatableReads

public boolean shouldAllowRequestBodyRepeatableReads(HttpServletRequest httpServletRequest,
 HttpServletResponse httpServletResponse,
 Optional<Route> route)

Should this request body be cached in-memory to support repeated reads?

This is helpful for common cases (request body logging and parsing) but if you have special requirements (need non-blocking I/O or have to handle large request bodies like file uploads) then you should override this method to return false.

By default this method returns true.

Parameters:

httpServletRequest - Servlet request

httpServletResponse - Servlet request

route - The route for this request

Returns:

true if the filter should be applied, false otherwise