HttpRequest (smart-http-server 2.5.2 API)

All Known Implementing Classes:

Http2RequestImpl, HttpRequestImpl, WebSocketRequestImpl
```
public interface HttpRequest
```
Http消息请求接口

Version:

V1.0 , 2018/8/7

Author:

三刀

Field Summary

Fields
Modifier and Type Field and Description

static ThreadLocal<SSLEngine> SSL_ENGINE_THREAD_LOCAL

Fields
Modifier and Type	Field and Description
`static ThreadLocal<SSLEngine>`	`SSL_ENGINE_THREAD_LOCAL`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`org.smartboot.socket.util.Attachment`	`getAttachment()` 获取附件对象
`String`	`getCharacterEncoding()`
`long`	`getContentLength()`
`String`	`getContentType()`
`Cookie[]`	`getCookies()` 获取Cookie
`String`	`getHeader(String headName)` 获取指定名称的Http Header值
`Collection<String>`	`getHeaderNames()`
`Collection<String>`	`getHeaders(String name)`
`BodyInputStream`	`getInputStream()`
`InetSocketAddress`	`getLocalAddress()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getMethod()` Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
`String`	`getParameter(String name)`
`Map<String,String[]>`	`getParameters()`
`String[]`	`getParameterValues(String name)`
`default Collection<Part>`	`getParts()`
`Collection<Part>`	`getParts(MultipartConfig configElement)`
`HttpProtocolEnum`	`getProtocol()`
`String`	`getQueryString()`
`String`	`getRemoteAddr()` Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
`InetSocketAddress`	`getRemoteAddress()`
`String`	`getRemoteHost()` Returns the fully qualified name of the client or the last proxy that sent the request.
`String`	`getRequestURI()`
`String`	`getRequestURL()`
`String`	`getScheme()`
`SSLEngine`	`getSslEngine()`
`default Map<String,String>`	`getTrailerFields()`
`boolean`	`isSecure()` 是否启动安全通信
`default boolean`	`isTrailerFieldsReady()`
`default PushBuilder`	`newPushBuilder()`
`void`	`setAttachment(org.smartboot.socket.util.Attachment attachment)` 存放附件，支持任意类型

- Field Detail
  - SSL_ENGINE_THREAD_LOCAL
```
static final ThreadLocal<SSLEngine> SSL_ENGINE_THREAD_LOCAL
```
- Method Detail
  - getHeader
```
String getHeader(String headName)
```
    获取指定名称的Http Header值
    
    Parameters:
    
    headName -
    
    Returns:
  - getHeaders
```
Collection<String> getHeaders(String name)
```
  - getHeaderNames
```
Collection<String> getHeaderNames()
```
  - getInputStream
```
BodyInputStream getInputStream()
                        throws IOException
```
    Throws:
    
    IOException
  - getRequestURI
```
String getRequestURI()
```
  - getProtocol
```
HttpProtocolEnum getProtocol()
```
  - getMethod
```
String getMethod()
```
    Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.
    
    Returns:
    
    a String specifying the name of the method with which this request was made
  - isSecure
```
boolean isSecure()
```
    是否启动安全通信
  - getScheme
```
String getScheme()
```
  - getRequestURL
```
String getRequestURL()
```
  - getQueryString
```
String getQueryString()
```
  - getContentType
```
String getContentType()
```
  - getContentLength
```
long getContentLength()
```
  - getParameter
```
String getParameter(String name)
```
  - getParameterValues
```
String[] getParameterValues(String name)
```
  - getParameters
```
Map<String,String[]> getParameters()
```
  - getParts
```
default Collection<Part> getParts()
                           throws IOException
```
    Throws:
    
    IOException
  - getParts
```
Collection<Part> getParts(MultipartConfig configElement)
                   throws IOException
```
    Throws:
    
    IOException
  - getTrailerFields
```
default Map<String,String> getTrailerFields()
```
  - isTrailerFieldsReady
```
default boolean isTrailerFieldsReady()
```
  - getRemoteAddr
```
String getRemoteAddr()
```
    Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.
    
    Returns:
    
    a String containing the IP address of the client that sent the request
  - getRemoteAddress
```
InetSocketAddress getRemoteAddress()
```
  - getLocalAddress
```
InetSocketAddress getLocalAddress()
```
  - getRemoteHost
```
String getRemoteHost()
```
    Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.
    
    Returns:
    
    a String containing the fully qualified name of the client
  - getLocale
```
Locale getLocale()
```
  - getLocales
```
Enumeration<Locale> getLocales()
```
  - getCharacterEncoding
```
String getCharacterEncoding()
```
  - getCookies
```
Cookie[] getCookies()
```
    获取Cookie
  - getAttachment
```
org.smartboot.socket.util.Attachment getAttachment()
```
    获取附件对象
    
    Returns:
    
    附件
  - setAttachment
```
void setAttachment(org.smartboot.socket.util.Attachment attachment)
```
    存放附件，支持任意类型
    
    Parameters:
    
    attachment - 附件对象
  - getSslEngine
```
SSLEngine getSslEngine()
```
  - newPushBuilder
```
default PushBuilder newPushBuilder()
```

Interface HttpRequest

Field Summary

Method Summary

Field Detail

SSL_ENGINE_THREAD_LOCAL

Method Detail

getHeader

getHeaders

getHeaderNames

getInputStream

getRequestURI

getProtocol

getMethod

isSecure

getScheme

getRequestURL

getQueryString

getContentType

getContentLength

getParameter

getParameterValues

getParameters

getParts

getParts

getTrailerFields

isTrailerFieldsReady

getRemoteAddr

getRemoteAddress

getLocalAddress

getRemoteHost

getLocale

getLocales

getCharacterEncoding

getCookies

getAttachment

setAttachment

getSslEngine

newPushBuilder