ServletHttpServletRequest (Spring Boot Protocol 2.1.4 API)

java.lang.Object
- com.github.netty.protocol.servlet.ServletHttpServletRequest

所有已实现的接口:

Recyclable, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
```
public class ServletHttpServletRequest
extends Object
implements javax.servlet.http.HttpServletRequest, Recyclable
```
The servlet request

作者:

wangzihao 2018/7/15/015

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse response)`
`String`	`changeSessionId()`
`ServletAsyncContext`	`getAsyncContext()`
`Object`	`getAttribute(String name)`
`Enumeration<String>`	`getAttributeNames()`
`String`	`getAuthType()` "BASIC", or "DIGEST", or "SSL".
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`long`	`getContentLengthLong()`
`String`	`getContentType()`
`String`	`getContextPath()` Context Path: the Path prefix associated with the ServletContext is part of this servlet.
`Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)` servlet standard: returns the value of the specified request header is the long value, representing a date object.
`javax.servlet.DispatcherType`	`getDispatcherType()`
`int`	`getFileSizeThreshold()`
`String`	`getHeader(String name)` The getHeader method returns the header for the given header name.
`Enumeration<String>`	`getHeaderNames()`
`Enumeration<String>`	`getHeaders(String name)`
`ServletInputStreamWrapper`	`getInputStream()`
`int`	`getIntHeader(String name)` servlet standard: returns the value of the specified request header as int.
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()`
`io.netty.handler.codec.http.HttpHeaders`	`getNettyHeaders()`
`io.netty.handler.codec.http.HttpRequest`	`getNettyRequest()`
`String`	`getParameter(String name)`
`Map<String,String[]>`	`getParameterMap()`
`Enumeration<String>`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`javax.servlet.http.Part`	`getPart(String name)`
`Collection<javax.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()` PathInfo：Part of the request Path that is not part of the Context Path or Servlet Path.
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String path)`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`ServletRequestDispatcher`	`getRequestDispatcher(String path)`
`String`	`getRequestedSessionId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()` Copy the implementation of tomcat
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`ServletContext`	`getServletContext()`
`ServletHttpExchange`	`getServletHttpExchange()`
`String`	`getServletPath()` Servlet Path: the Path section corresponds directly to the mapping of the activation request.
`ServletHttpSession`	`getSession()`
`ServletHttpSession`	`getSession(boolean create)`
`Principal`	`getUserPrincipal()`
`boolean`	`isAsync()`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isMultipart()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String role)`
`void`	`login(String username, String password)`
`void`	`logout()`
`static ServletHttpServletRequest`	`newInstance(ServletHttpExchange exchange, io.netty.handler.codec.http.HttpRequest httpRequest)`
`void`	`recycle()` recycle
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object object)`
`void`	`setCharacterEncoding(String env)`
`ServletAsyncContext`	`startAsync()`
`ServletAsyncContext`	`startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)`
`<T extends javax.servlet.http.HttpUpgradeHandler> T`	`upgrade(Class<T> httpUpgradeHandlerClass)`

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

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

从接口继承的方法 com.github.netty.core.util.Recyclable
recycle

- 方法详细资料
  - newInstance
```
public static ServletHttpServletRequest newInstance(ServletHttpExchange exchange,
                                                    io.netty.handler.codec.http.HttpRequest httpRequest)
```
  - getFileSizeThreshold
```
public int getFileSizeThreshold()
```
  - isMultipart
```
public boolean isMultipart()
```
  - isAsync
```
public boolean isAsync()
```
  - getServletHttpExchange
```
public ServletHttpExchange getServletHttpExchange()
```
  - getNettyRequest
```
public io.netty.handler.codec.http.HttpRequest getNettyRequest()
```
  - getNettyHeaders
```
public io.netty.handler.codec.http.HttpHeaders getNettyHeaders()
```
  - getCookies
```
public Cookie[] getCookies()
```
    指定者:
    
    getCookies 在接口中 javax.servlet.http.HttpServletRequest
  - getDateHeader
```
public long getDateHeader(String name)
                   throws IllegalArgumentException
```
    servlet standard: returns the value of the specified request header is the long value, representing a date object. Using this method contains a header for the date, for example Return date is The number of milliseconds since January 1, 1970. The first name is case insensitive. , if the request does not have a header specify a name, and this method returns -1. If the header Cannot convert to date,
    
    指定者:
    
    getDateHeader 在接口中 javax.servlet.http.HttpServletRequest
    
    参数:
    
    name - ，Specifies the name of the title
    
    返回:
    
    Indicates the specified date in milliseconds as of January 1, 1970, or -1, if a title is specified. Not included in request
    
    抛出:
    
    IllegalArgumentException - IllegalArgumentException
  - getHeader
```
public String getHeader(String name)
```
    The getHeader method returns the header for the given header name. Multiple headers can have the same name, such as the cache-control header in an HTTP request. if multiple headers have the same name, the getHeader method returns the first header in the request. The getHeaders method allowed access to all names with specific headers calls the associated header value and returns an enumeration of the String object. the header can contain int or Date data in the form of a String. The HttpServletRequest interface provides the following convenient methods to access these types of headers data: the header can contain int or Date data in the form of a String. The HttpServletRequest interface provides the following convenient methods to access these types of headers getIntHeader getDateHeader if the getIntHeader method cannot be converted to a header value of int, then a NumberFormatException is thrown. If getDateHeader side method cannot convert the head into a Date object, then an IllegalArgumentException is thrown.
    
    指定者:
    
    getHeader 在接口中 javax.servlet.http.HttpServletRequest
    
    参数:
    
    name - name
    
    返回:
    
    header value
  - getHeaderNames
```
public Enumeration<String> getHeaderNames()
```
    指定者:
    
    getHeaderNames 在接口中 javax.servlet.http.HttpServletRequest
  - getRequestURL
```
public StringBuffer getRequestURL()
```
    Copy the implementation of tomcat
    
    指定者:
    
    getRequestURL 在接口中 javax.servlet.http.HttpServletRequest
    
    返回:
    
    RequestURL
  - getPathInfo
```
public String getPathInfo()
```
    PathInfo：Part of the request Path that is not part of the Context Path or Servlet Path. If there's no extra path, it's either null, Or a string that starts with '/'.
    
    指定者:
    
    getPathInfo 在接口中 javax.servlet.http.HttpServletRequest
    
    返回:
    
    pathInfo
  - getQueryString
```
public String getQueryString()
```
    指定者:
    
    getQueryString 在接口中 javax.servlet.http.HttpServletRequest
  - getRequestURI
```
public String getRequestURI()
```
    指定者:
    
    getRequestURI 在接口中 javax.servlet.http.HttpServletRequest
  - getServletPath
```
public String getServletPath()
```
    Servlet Path: the Path section corresponds directly to the mapping of the activation request. The path starts with the "/" character, if the request is in the "/ *" or "" mode." matches, in which case it is an empty string.
    
    指定者:
    
    getServletPath 在接口中 javax.servlet.http.HttpServletRequest
    
    返回:
    
    servletPath
  - getHeaders
```
public Enumeration<String> getHeaders(String name)
```
    指定者:
    
    getHeaders 在接口中 javax.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(String name)
```
    servlet standard: returns the value of the specified request header as int. If the request has no title the name specified by this method returns -1. if This method does not convert headers to integers throws a NumberFormatException code. The first name is case insensitive.
    
    指定者:
    
    getIntHeader 在接口中 javax.servlet.http.HttpServletRequest
    
    参数:
    
    name - specifies the name of the request header
    
    返回:
    
    An integer request header representing a value or -1 if the request does not return -1 for the header with this name
    
    抛出:
    
    NumberFormatException - If the header value cannot be converted to an int。
  - getMethod
```
public String getMethod()
```
    指定者:
    
    getMethod 在接口中 javax.servlet.http.HttpServletRequest
  - getContextPath
```
public String getContextPath()
```
    Context Path: the Path prefix associated with the ServletContext is part of this servlet. If the context is web-based the server's URL namespace based on the "default" context, then the path will be an empty string. Otherwise, if the context is not server-based namespaces, so the path starts with /, but does not end with /
    
    指定者:
    
    getContextPath 在接口中 javax.servlet.http.HttpServletRequest
  - getSession
```
public ServletHttpSession getSession(boolean create)
```
    指定者:
    
    getSession 在接口中 javax.servlet.http.HttpServletRequest
  - getSession
```
public ServletHttpSession 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
```
public boolean isRequestedSessionIdFromUrl()
```
    指定者:
    
    isRequestedSessionIdFromUrl 在接口中 javax.servlet.http.HttpServletRequest
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    指定者:
    
    getRequestedSessionId 在接口中 javax.servlet.http.HttpServletRequest
  - getAttribute
```
public Object getAttribute(String name)
```
    指定者:
    
    getAttribute 在接口中 javax.servlet.ServletRequest
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    指定者:
    
    getAttributeNames 在接口中 javax.servlet.ServletRequest
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    指定者:
    
    getCharacterEncoding 在接口中 javax.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(String env)
                          throws UnsupportedEncodingException
```
    指定者:
    
    setCharacterEncoding 在接口中 javax.servlet.ServletRequest
    
    抛出:
    
    UnsupportedEncodingException
  - getContentLength
```
public int getContentLength()
```
    指定者:
    
    getContentLength 在接口中 javax.servlet.ServletRequest
  - getContentLengthLong
```
public long getContentLengthLong()
```
    指定者:
    
    getContentLengthLong 在接口中 javax.servlet.ServletRequest
  - getContentType
```
public String getContentType()
```
    指定者:
    
    getContentType 在接口中 javax.servlet.ServletRequest
  - getInputStream
```
public ServletInputStreamWrapper getInputStream()
```
    指定者:
    
    getInputStream 在接口中 javax.servlet.ServletRequest
  - getParameter
```
public String getParameter(String name)
```
    指定者:
    
    getParameter 在接口中 javax.servlet.ServletRequest
  - getParameterNames
```
public Enumeration<String> getParameterNames()
```
    指定者:
    
    getParameterNames 在接口中 javax.servlet.ServletRequest
  - getParameterValues
```
public String[] getParameterValues(String name)
```
    指定者:
    
    getParameterValues 在接口中 javax.servlet.ServletRequest
  - getParameterMap
```
public Map<String,String[]> getParameterMap()
```
    指定者:
    
    getParameterMap 在接口中 javax.servlet.ServletRequest
  - getProtocol
```
public String getProtocol()
```
    指定者:
    
    getProtocol 在接口中 javax.servlet.ServletRequest
  - getScheme
```
public String getScheme()
```
    指定者:
    
    getScheme 在接口中 javax.servlet.ServletRequest
  - getServerName
```
public String getServerName()
```
    指定者:
    
    getServerName 在接口中 javax.servlet.ServletRequest
  - getServerPort
```
public int getServerPort()
```
    指定者:
    
    getServerPort 在接口中 javax.servlet.ServletRequest
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    指定者:
    
    getReader 在接口中 javax.servlet.ServletRequest
    
    抛出:
    
    IOException
  - getRemoteAddr
```
public String getRemoteAddr()
```
    指定者:
    
    getRemoteAddr 在接口中 javax.servlet.ServletRequest
  - getRemoteHost
```
public String getRemoteHost()
```
    指定者:
    
    getRemoteHost 在接口中 javax.servlet.ServletRequest
  - getRemotePort
```
public int getRemotePort()
```
    指定者:
    
    getRemotePort 在接口中 javax.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(String name,
                         Object object)
```
    指定者:
    
    setAttribute 在接口中 javax.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(String name)
```
    指定者:
    
    removeAttribute 在接口中 javax.servlet.ServletRequest
  - getLocale
```
public Locale getLocale()
```
    指定者:
    
    getLocale 在接口中 javax.servlet.ServletRequest
  - getLocales
```
public Enumeration<Locale> getLocales()
```
    指定者:
    
    getLocales 在接口中 javax.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    指定者:
    
    isSecure 在接口中 javax.servlet.ServletRequest
  - getRequestDispatcher
```
public ServletRequestDispatcher getRequestDispatcher(String path)
```
    指定者:
    
    getRequestDispatcher 在接口中 javax.servlet.ServletRequest
  - getRealPath
```
public String getRealPath(String path)
```
    指定者:
    
    getRealPath 在接口中 javax.servlet.ServletRequest
  - getLocalName
```
public String getLocalName()
```
    指定者:
    
    getLocalName 在接口中 javax.servlet.ServletRequest
  - getLocalAddr
```
public String getLocalAddr()
```
    指定者:
    
    getLocalAddr 在接口中 javax.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    指定者:
    
    getLocalPort 在接口中 javax.servlet.ServletRequest
  - getServletContext
```
public ServletContext getServletContext()
```
    指定者:
    
    getServletContext 在接口中 javax.servlet.ServletRequest
  - startAsync
```
public ServletAsyncContext startAsync()
                               throws IllegalStateException
```
    指定者:
    
    startAsync 在接口中 javax.servlet.ServletRequest
    
    抛出:
    
    IllegalStateException
  - startAsync
```
public ServletAsyncContext startAsync(javax.servlet.ServletRequest servletRequest,
                                      javax.servlet.ServletResponse servletResponse)
                               throws IllegalStateException
```
    指定者:
    
    startAsync 在接口中 javax.servlet.ServletRequest
    
    抛出:
    
    IllegalStateException
  - isAsyncStarted
```
public boolean isAsyncStarted()
```
    指定者:
    
    isAsyncStarted 在接口中 javax.servlet.ServletRequest
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
    指定者:
    
    isAsyncSupported 在接口中 javax.servlet.ServletRequest
  - getAsyncContext
```
public ServletAsyncContext getAsyncContext()
```
    指定者:
    
    getAsyncContext 在接口中 javax.servlet.ServletRequest
  - getDispatcherType
```
public javax.servlet.DispatcherType getDispatcherType()
```
    指定者:
    
    getDispatcherType 在接口中 javax.servlet.ServletRequest
  - getPathTranslated
```
public String getPathTranslated()
```
    指定者:
    
    getPathTranslated 在接口中 javax.servlet.http.HttpServletRequest
  - getAuthType
```
public String getAuthType()
```
    "BASIC", or "DIGEST", or "SSL".
    
    指定者:
    
    getAuthType 在接口中 javax.servlet.http.HttpServletRequest
    
    返回:
    
    Authentication type
  - getRemoteUser
```
public String getRemoteUser()
```
    指定者:
    
    getRemoteUser 在接口中 javax.servlet.http.HttpServletRequest
  - isUserInRole
```
public boolean isUserInRole(String role)
```
    指定者:
    
    isUserInRole 在接口中 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
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    指定者:
    
    getUserPrincipal 在接口中 javax.servlet.http.HttpServletRequest
  - 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
  - recycle
```
public void recycle()
```
    从接口复制的说明: Recyclable
    
    recycle
    
    指定者:
    
    recycle 在接口中 Recyclable

类 ServletHttpServletRequest

字段概要

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

方法概要

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

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

从接口继承的方法 com.github.netty.core.util.Recyclable

方法详细资料

newInstance

getFileSizeThreshold

isMultipart

isAsync

getServletHttpExchange

getNettyRequest

getNettyHeaders

getCookies

getDateHeader

getHeader

getHeaderNames

getRequestURL

getPathInfo

getQueryString

getRequestURI

getServletPath

getHeaders

getIntHeader

getMethod

getContextPath

getSession

getSession

changeSessionId

isRequestedSessionIdValid

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdFromUrl

getRequestedSessionId

getAttribute

getAttributeNames

getCharacterEncoding

setCharacterEncoding

getContentLength

getContentLengthLong

getContentType

getInputStream

getParameter

getParameterNames

getParameterValues

getParameterMap

getProtocol

getScheme

getServerName

getServerPort

getReader

getRemoteAddr

getRemoteHost

getRemotePort

setAttribute

removeAttribute

getLocale

getLocales

isSecure

getRequestDispatcher

getRealPath

getLocalName

getLocalAddr

getLocalPort

getServletContext

startAsync

startAsync

isAsyncStarted

isAsyncSupported

getAsyncContext

getDispatcherType

getPathTranslated

getAuthType

getRemoteUser

isUserInRole

authenticate

getUserPrincipal

login