程序包 cn.taketoday.web.servlet

类 ContentCachingRequestWrapper

java.lang.Object

jakarta.servlet.ServletRequestWrapper

jakarta.servlet.http.HttpServletRequestWrapper

cn.taketoday.web.servlet.ContentCachingRequestWrapper

所有已实现的接口:

HttpServletRequest, ServletRequest

public class ContentCachingRequestWrapper
extends HttpServletRequestWrapper

HttpServletRequest wrapper that caches all content read from the input stream and reader, and allows this content to be retrieved via a byte array.

This class acts as an interceptor that only caches content as it is being read but otherwise does not cause content to be read. That means if the request content is not consumed, then the content is not cached, and cannot be retrieved via getContentAsByteArray().

从以下版本开始:

4.0

作者:

Juergen Hoeller, Brian Clozel, Harry Yang

另请参阅:

• ContentCachingResponseWrapper

嵌套类概要

嵌套类

修饰符和类型	类	说明
private class	ContentCachingRequestWrapper.ContentCachingInputStream

字段概要

字段

修饰符和类型	字段	说明
private final cn.taketoday.util.FastByteArrayOutputStream	cachedContent
private final Integer	contentCacheLimit
private ServletInputStream	inputStream
private BufferedReader	reader

从接口继承的字段 jakarta.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

构造器概要

构造器

构造器	说明
ContentCachingRequestWrapper(HttpServletRequest request)	Create a new ContentCachingRequestWrapper for the given servlet request.
ContentCachingRequestWrapper(HttpServletRequest request, int contentCacheLimit)	Create a new ContentCachingRequestWrapper for the given servlet request.

方法概要

修饰符和类型	方法	说明
String	getCharacterEncoding()
byte[]	getContentAsByteArray()	Return the cached request content as a byte array.
String	getContentAsString()	Return the cached request content as a String, using the configured Charset.
ServletInputStream	getInputStream()
String	getParameter(String name)
Map<String,String[]>	getParameterMap()
Enumeration<String>	getParameterNames()
String[]	getParameterValues(String name)
BufferedReader	getReader()
protected void	handleContentOverflow(int contentCacheLimit)	Template method for handling a content overflow: specifically, a request body being read that exceeds the specified content cache limit.
private boolean	isFormPost()
private void	writeRequestParametersToCachedContent()

从类继承的方法 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, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade

从类继承的方法 jakarta.servlet.ServletRequestWrapper

getAsyncContext, getAttribute, getAttributeNames, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getProtocolRequestId, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

从类继承的方法 java.lang.Object

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

从接口继承的方法 jakarta.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getProtocolRequestId, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getRequestId, getScheme, getServerName, getServerPort, getServletConnection, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

字段详细资料

cachedContent

private final cn.taketoday.util.FastByteArrayOutputStream cachedContent

contentCacheLimit

@Nullable
private final Integer contentCacheLimit

inputStream

@Nullable
private ServletInputStream inputStream

reader

@Nullable
private BufferedReader reader

构造器详细资料

ContentCachingRequestWrapper

public ContentCachingRequestWrapper(HttpServletRequest request)

Create a new ContentCachingRequestWrapper for the given servlet request.

参数:

request - the original servlet request

ContentCachingRequestWrapper

public ContentCachingRequestWrapper(HttpServletRequest request,
 int contentCacheLimit)

Create a new ContentCachingRequestWrapper for the given servlet request.

参数:

request - the original servlet request

contentCacheLimit - the maximum number of bytes to cache per request

另请参阅:

• handleContentOverflow(int)

方法详细资料

getInputStream

public ServletInputStream getInputStream()
                                  throws IOException

指定者:

getInputStream 在接口中 ServletRequest

覆盖:

getInputStream 在类中 ServletRequestWrapper

抛出:

IOException

getCharacterEncoding

public String getCharacterEncoding()

指定者:

getCharacterEncoding 在接口中 ServletRequest

覆盖:

getCharacterEncoding 在类中 ServletRequestWrapper

getReader

public BufferedReader getReader()
                         throws IOException

指定者:

getReader 在接口中 ServletRequest

覆盖:

getReader 在类中 ServletRequestWrapper

抛出:

IOException

getParameter

public String getParameter(String name)

指定者:

getParameter 在接口中 ServletRequest

覆盖:

getParameter 在类中 ServletRequestWrapper

getParameterMap

public Map<String,String[]> getParameterMap()

指定者:

getParameterMap 在接口中 ServletRequest

覆盖:

getParameterMap 在类中 ServletRequestWrapper

getParameterNames

public Enumeration<String> getParameterNames()

指定者:

getParameterNames 在接口中 ServletRequest

覆盖:

getParameterNames 在类中 ServletRequestWrapper

getParameterValues

public String[] getParameterValues(String name)

指定者:

getParameterValues 在接口中 ServletRequest

覆盖:

getParameterValues 在类中 ServletRequestWrapper

isFormPost

private boolean isFormPost()

writeRequestParametersToCachedContent

private void writeRequestParametersToCachedContent()

getContentAsByteArray

public byte[] getContentAsByteArray()

Return the cached request content as a byte array.

The returned array will never be larger than the content cache limit.

Note: The byte array returned from this method reflects the amount of content that has been read at the time when it is called. If the application does not read the content, this method returns an empty array.

另请参阅:

• ContentCachingRequestWrapper(HttpServletRequest, int)

getContentAsString

public String getContentAsString()

Return the cached request content as a String, using the configured Charset.

Note: The String returned from this method reflects the amount of content that has been read at the time when it is called. If the application does not read the content, this method returns an empty String.

另请参阅:

• getContentAsByteArray()

handleContentOverflow

protected void handleContentOverflow(int contentCacheLimit)

Template method for handling a content overflow: specifically, a request body being read that exceeds the specified content cache limit.

The default implementation is empty. Subclasses may override this to throw a payload-too-large exception or the like.

参数:

contentCacheLimit - the maximum number of bytes to cache per request which has just been exceeded

另请参阅:

• ContentCachingRequestWrapper(HttpServletRequest, int)