WebRequestStreamHeader (pacebox-springboot-core-common 1.0.9 API)

java.lang.Object
- javax.servlet.ServletRequestWrapper
- - tech.mhuang.pacebox.springboot.core.servlet.WebRequestStreamHeader

所有已实现的接口:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, WebServletRequest
```
public class WebRequestStreamHeader
extends javax.servlet.ServletRequestWrapper
implements WebServletRequest
```
重写HttpServletRequest、达到可添加Header、spring可重复读取数据封装

从以下版本开始:

1.0.0

作者:

mhuang

字段概要
- 从接口继承的字段 javax.servlet.http.HttpServletRequest
  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

构造器概要

构造器
构造器和说明

WebRequestStreamHeader(javax.servlet.http.HttpServletRequest request)

构造器
构造器和说明
`WebRequestStreamHeader(javax.servlet.http.HttpServletRequest request)`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse response)`
`String`	`changeSessionId()`
`String`	`getAuthType()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`String`	`getHeader(String name)` 重构根据key获取header中的值
`Enumeration<String>`	`getHeaderNames()`
`Enumeration<String>`	`getHeaders(String name)` 重构根据key获取header的值
`javax.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String name)`
`String`	`getMethod()`
`javax.servlet.http.Part`	`getPart(String name)`
`Collection<javax.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRemoteUser()`
`String`	`getRequestedSessionId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean create)`
`Principal`	`getUserPrincipal()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()` 已过时。
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isUserInRole(String role)`
`void`	`login(String username, String password)`
`void`	`logout()`
`void`	`putHeader(String name, String value)` 扩展、放入Header
`<T extends javax.servlet.http.HttpUpgradeHandler> T`	`upgrade(Class<T> httpUpgradeHandlerClass)`

从类继承的方法 javax.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

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 javax.servlet.http.HttpServletRequest
getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder

从接口继承的方法 javax.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

- 构造器详细资料
  - WebRequestStreamHeader
```
public WebRequestStreamHeader(javax.servlet.http.HttpServletRequest request)
                       throws IOException
```
    抛出:
    
    IOException
- 方法详细资料
  - putHeader
```
public void putHeader(String name,
                      String value)
```
    扩展、放入Header
    
    指定者:
    
    putHeader 在接口中 WebServletRequest
    
    参数:
    
    name - 放入header的key
    
    value - 放入header的value
  - getHeader
```
public String getHeader(String name)
```
    重构根据key获取header中的值
    
    指定者:
    
    getHeader 在接口中 javax.servlet.http.HttpServletRequest
    
    参数:
    
    name - header的key
    
    返回:
    
    String 根据header的key得到的value
  - getHeaderNames
```
public Enumeration<String> getHeaderNames()
```
    指定者:
    
    getHeaderNames 在接口中 javax.servlet.http.HttpServletRequest
  - getAuthType
```
public String getAuthType()
```
    指定者:
    
    getAuthType 在接口中 javax.servlet.http.HttpServletRequest
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    指定者:
    
    getCookies 在接口中 javax.servlet.http.HttpServletRequest
  - getDateHeader
```
public long getDateHeader(String name)
```
    指定者:
    
    getDateHeader 在接口中 javax.servlet.http.HttpServletRequest
  - getHeaders
```
public Enumeration<String> getHeaders(String name)
```
    重构根据key获取header的值
    
    指定者:
    
    getHeaders 在接口中 javax.servlet.http.HttpServletRequest
    
    参数:
    
    name - header的key
    
    返回:
    
    Enumeration 根据header的key得到的header的value
  - getIntHeader
```
public int getIntHeader(String name)
```
    指定者:
    
    getIntHeader 在接口中 javax.servlet.http.HttpServletRequest
  - getMethod
```
public String getMethod()
```
    指定者:
    
    getMethod 在接口中 javax.servlet.http.HttpServletRequest
  - getPathInfo
```
public String getPathInfo()
```
    指定者:
    
    getPathInfo 在接口中 javax.servlet.http.HttpServletRequest
  - getPathTranslated
```
public String getPathTranslated()
```
    指定者:
    
    getPathTranslated 在接口中 javax.servlet.http.HttpServletRequest
  - getContextPath
```
public String getContextPath()
```
    指定者:
    
    getContextPath 在接口中 javax.servlet.http.HttpServletRequest
  - getQueryString
```
public String getQueryString()
```
    指定者:
    
    getQueryString 在接口中 javax.servlet.http.HttpServletRequest
  - getRemoteUser
```
public String getRemoteUser()
```
    指定者:
    
    getRemoteUser 在接口中 javax.servlet.http.HttpServletRequest
  - isUserInRole
```
public boolean isUserInRole(String role)
```
    指定者:
    
    isUserInRole 在接口中 javax.servlet.http.HttpServletRequest
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    指定者:
    
    getUserPrincipal 在接口中 javax.servlet.http.HttpServletRequest
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    指定者:
    
    getRequestedSessionId 在接口中 javax.servlet.http.HttpServletRequest
  - getRequestURI
```
public String getRequestURI()
```
    指定者:
    
    getRequestURI 在接口中 javax.servlet.http.HttpServletRequest
  - getRequestURL
```
public StringBuffer getRequestURL()
```
    指定者:
    
    getRequestURL 在接口中 javax.servlet.http.HttpServletRequest
  - getServletPath
```
public String getServletPath()
```
    指定者:
    
    getServletPath 在接口中 javax.servlet.http.HttpServletRequest
  - getSession
```
public javax.servlet.http.HttpSession getSession(boolean create)
```
    指定者:
    
    getSession 在接口中 javax.servlet.http.HttpServletRequest
  - getSession
```
public javax.servlet.http.HttpSession getSession()
```
    指定者:
    
    getSession 在接口中 javax.servlet.http.HttpServletRequest
  - changeSessionId
```
public String changeSessionId()
```
    指定者:
    
    changeSessionId 在接口中 javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    指定者:
    
    isRequestedSessionIdValid 在接口中 javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    指定者:
    
    isRequestedSessionIdFromCookie 在接口中 javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    指定者:
    
    isRequestedSessionIdFromURL 在接口中 javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromUrl
```
@Deprecated
public boolean isRequestedSessionIdFromUrl()
```
    已过时。
    
    指定者:
    
    isRequestedSessionIdFromUrl 在接口中 javax.servlet.http.HttpServletRequest
  - authenticate
```
public boolean authenticate(javax.servlet.http.HttpServletResponse response)
                     throws IOException,
                            javax.servlet.ServletException
```
    指定者:
    
    authenticate 在接口中 javax.servlet.http.HttpServletRequest
    
    抛出:
    
    IOException
    
    javax.servlet.ServletException
  - login
```
public void login(String username,
                  String password)
           throws javax.servlet.ServletException
```
    指定者:
    
    login 在接口中 javax.servlet.http.HttpServletRequest
    
    抛出:
    
    javax.servlet.ServletException
  - logout
```
public void logout()
            throws javax.servlet.ServletException
```
    指定者:
    
    logout 在接口中 javax.servlet.http.HttpServletRequest
    
    抛出:
    
    javax.servlet.ServletException
  - getParts
```
public Collection<javax.servlet.http.Part> getParts()
                                             throws IOException,
                                                    javax.servlet.ServletException
```
    指定者:
    
    getParts 在接口中 javax.servlet.http.HttpServletRequest
    
    抛出:
    
    IOException
    
    javax.servlet.ServletException
  - getPart
```
public javax.servlet.http.Part getPart(String name)
                                throws IOException,
                                       javax.servlet.ServletException
```
    指定者:
    
    getPart 在接口中 javax.servlet.http.HttpServletRequest
    
    抛出:
    
    IOException
    
    javax.servlet.ServletException
  - upgrade
```
public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(Class<T> httpUpgradeHandlerClass)
                                                            throws IOException,
                                                                   javax.servlet.ServletException
```
    指定者:
    
    upgrade 在接口中 javax.servlet.http.HttpServletRequest
    
    抛出:
    
    IOException
    
    javax.servlet.ServletException
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    指定者:
    
    getReader 在接口中 javax.servlet.ServletRequest
    
    覆盖:
    
    getReader 在类中 javax.servlet.ServletRequestWrapper
    
    抛出:
    
    IOException
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException
```
    指定者:
    
    getInputStream 在接口中 javax.servlet.ServletRequest
    
    覆盖:
    
    getInputStream 在类中 javax.servlet.ServletRequestWrapper
    
    抛出:
    
    IOException

类 WebRequestStreamHeader

字段概要

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

构造器概要

方法概要

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

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

从接口继承的方法 javax.servlet.http.HttpServletRequest

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

构造器详细资料

WebRequestStreamHeader

方法详细资料

putHeader

getHeader

getHeaderNames

getAuthType

getCookies

getDateHeader

getHeaders

getIntHeader

getMethod

getPathInfo

getPathTranslated

getContextPath

getQueryString

getRemoteUser

isUserInRole

getUserPrincipal

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

getSession

getSession

changeSessionId

isRequestedSessionIdValid

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdFromUrl

authenticate

login

logout

getParts

getPart

upgrade

getReader

getInputStream