com.netflix.zuul.http

Class HttpServletRequestWrapper

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

com.netflix.zuul.http.HttpServletRequestWrapper

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class HttpServletRequestWrapper
extends javax.servlet.http.HttpServletRequestWrapper

This class implements the Wrapper or Decorator pattern.
Methods default to calling through to the wrapped request object, except the ones that read the request's content (parameters, stream or reader).

This class provides a buffered content reading that allows the methods HttpServletRequestWrapper.getReader(), HttpServletRequestWrapper.getInputStream() and any of the getParameterXXX to be called safely and repeatedly with the same results.

This class is intended to wrap relatively small HttpServletRequest instances.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
HttpServletRequestWrapper()
HttpServletRequestWrapper(javax.servlet.http.HttpServletRequest request)

Method Summary

Modifier and Type	Method and Description
long	getBodyBufferingTimeNs() Time taken to buffer the request body in nanoseconds.
byte[]	getContentData() This method is safe to use multiple times.
javax.servlet.ServletInputStream	getInputStream() This method is safe to call multiple times.
java.lang.String	getParameter(java.lang.String name) This method is safe to execute multiple times.
java.util.Map	getParameterMap() This method is safe.
java.util.Enumeration	getParameterNames() This method is safe to execute multiple times.
java.util.HashMap<java.lang.String,java.lang.String[]>	getParameters() This method is safe to use multiple times.
java.lang.String[]	getParameterValues(java.lang.String name) This method is safe to execute multiple times.
java.io.BufferedReader	getReader() This method is safe to call multiple times.
javax.servlet.http.HttpServletRequest	getRequest() Returns the wrapped HttpServletRequest.

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole

Methods inherited from class javax.servlet.ServletRequestWrapper

getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletRequest

getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

HttpServletRequestWrapper

public HttpServletRequestWrapper()

HttpServletRequestWrapper

public HttpServletRequestWrapper(javax.servlet.http.HttpServletRequest request)

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns the wrapped HttpServletRequest. Using the getParameterXXX(), getInputStream() or getReader() methods may interfere with this class operation.

Overrides:

getRequest in class javax.servlet.ServletRequestWrapper

Returns:

The wrapped HttpServletRequest.

getContentData

public byte[] getContentData()

This method is safe to use multiple times.

Returns:

The request body data.

getParameters

public java.util.HashMap<java.lang.String,java.lang.String[]> getParameters()

This method is safe to use multiple times. Changing the returned map or the array of any of the map's values will not interfere with this class operation.

Returns:

The cloned parameters map.

getBodyBufferingTimeNs

public long getBodyBufferingTimeNs()

Time taken to buffer the request body in nanoseconds.

Returns:

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException

This method is safe to call multiple times. Calling it will not interfere with getParameterXXX() or getReader(). Every time a new ServletInputStream is returned that reads data from the begining.

Specified by:

getInputStream in interface javax.servlet.ServletRequest

Overrides:

getInputStream in class javax.servlet.ServletRequestWrapper

Returns:

A new ServletInputStream.

Throws:

java.io.IOException

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException

This method is safe to call multiple times. Calling it will not interfere with getParameterXXX() or getInputStream(). Every time a new BufferedReader is returned that reads data from the begining.

Specified by:

getReader in interface javax.servlet.ServletRequest

Overrides:

getReader in class javax.servlet.ServletRequestWrapper

Returns:

A new BufferedReader with the wrapped request's character encoding (or UTF-8 if null).

Throws:

java.io.IOException

getParameter

public java.lang.String getParameter(java.lang.String name)

This method is safe to execute multiple times.

Specified by:

getParameter in interface javax.servlet.ServletRequest

Overrides:

getParameter in class javax.servlet.ServletRequestWrapper

See Also:

ServletRequest.getParameter(java.lang.String)

getParameterMap

public java.util.Map getParameterMap()

This method is safe.

Specified by:

getParameterMap in interface javax.servlet.ServletRequest

Overrides:

getParameterMap in class javax.servlet.ServletRequestWrapper

See Also:

#getParameters()}, ServletRequest.getParameterMap()

getParameterNames

public java.util.Enumeration getParameterNames()

This method is safe to execute multiple times.

Specified by:

getParameterNames in interface javax.servlet.ServletRequest

Overrides:

getParameterNames in class javax.servlet.ServletRequestWrapper

See Also:

ServletRequest.getParameterNames()

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

This method is safe to execute multiple times. Changing the returned array will not interfere with this class operation.

Specified by:

getParameterValues in interface javax.servlet.ServletRequest

Overrides:

getParameterValues in class javax.servlet.ServletRequestWrapper

See Also:

ServletRequest.getParameterValues(java.lang.String)