Module com.github.robtimus.servlet

Package com.github.robtimus.servlet.http

Class InputTransformingHttpServletRequestWrapper

java.lang.Object

jakarta.servlet.ServletRequestWrapper

jakarta.servlet.http.HttpServletRequestWrapper

com.github.robtimus.servlet.http.InputTransformingHttpServletRequestWrapper

All Implemented Interfaces:

HttpServletRequest, ServletRequest

Direct Known Subclasses:

BodyCapturingFilter.BodyCapturingRequest

public class InputTransformingHttpServletRequestWrapper
extends HttpServletRequestWrapper

A sub class of HttpServletRequestWrapper that applies a transformation on its input stream and/or reader.

Author:

Rob Spoor

Field Summary

Fields inherited from interface jakarta.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor	Description
InputTransformingHttpServletRequestWrapper(HttpServletRequest request)	Creates a new HttpServletRequest wrapper.

Method Summary

Modifier and Type	Method	Description
ServletInputStream	getInputStream()
BufferedReader	getReader()
protected InputStream	transform(ServletInputStream inputStream)	Transforms the original ServletInputStream.
protected Reader	transform(BufferedReader reader)	Transforms the original BufferedReader.

Methods inherited from class jakarta.servlet.http.HttpServletRequestWrapper

authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getTrailerFields, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade

Methods inherited from class jakarta.servlet.ServletRequestWrapper

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Constructor Detail

InputTransformingHttpServletRequestWrapper

public InputTransformingHttpServletRequestWrapper(HttpServletRequest request)

Creates a new HttpServletRequest wrapper.

Parameters:

request - The request to wrap.

Throws:

IllegalArgumentException - If the request is null.

Method Detail

transform

protected InputStream transform(ServletInputStream inputStream)
                         throws IOException

Transforms the original ServletInputStream.

This default implementation returns the unmodified argument.

Parameters:

inputStream - The original ServletInputStream to transform.

Returns:

An InputStream that is the result of transforming the given ServletInputStream. It does not necessary have to be a ServletInputStream.

Throws:

IOException - If an I/O error occurred during the transformation.

getInputStream

public ServletInputStream getInputStream()
                                  throws IOException

Specified by:

getInputStream in interface ServletRequest

Overrides:

getInputStream in class ServletRequestWrapper

Throws:

IOException

transform

protected Reader transform(BufferedReader reader)
                    throws IOException

Transforms the original BufferedReader.

This default implementation returns the unmodified argument.

Parameters:

reader - The original BufferedReader to transform.

Returns:

A Reader that is the result of transforming the given BufferedReader. It does not necessary have to be a BufferedReader.

Throws:

IOException - If an I/O error occurred during the transformation.

getReader

public BufferedReader getReader()
                         throws IOException

Specified by:

getReader in interface ServletRequest

Overrides:

getReader in class ServletRequestWrapper

Throws:

IOException