CommonRequest (smart-http-server 2.5.2 API)

java.lang.Object
- org.smartboot.http.server.impl.CommonRequest

All Implemented Interfaces:

Reset

Direct Known Subclasses:

Http2RequestImpl, Request
```
public abstract class CommonRequest
extends Object
implements Reset
```
Version:

V1.0 , 2018/8/31

Author:

三刀

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.smartboot.socket.transport.AioSession`	`aioSession`
`protected org.smartboot.socket.util.Attachment`	`attachment` 附件对象
`protected HttpServerConfiguration`	`configuration`
`protected String`	`connection`
`protected long`	`contentLength`
`protected String`	`contentType`
`protected Cookie[]`	`cookies`
`protected Map<String,HeaderValue>`	`headers` Http请求头
`protected int`	`headerSize`
`protected String`	`hostHeader`
`protected String`	`method` 请求方法
`protected Map<String,String[]>`	`parameters` 请求参数
`protected HttpProtocolEnum`	`protocol` Http协议版本
`protected String`	`queryString` 跟在URL后面的请求信息
`protected String`	`remoteAddr`
`protected String`	`remoteHost`
`protected String`	`requestUri`
`protected String`	`requestUrl`
`protected String`	`scheme` 协议
`protected ServerHandler`	`serverHandler`
`protected SSLEngine`	`sslEngine`
`protected HttpTypeEnum`	`type` 消息类型
`protected String`	`uri` 原始的完整请求

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`org.smartboot.socket.transport.AioSession`	`getAioSession()`
`org.smartboot.socket.util.Attachment`	`getAttachment()` 获取附件对象
`String`	`getCharacterEncoding()`
`HttpServerConfiguration`	`getConfiguration()`
`String`	`getConnection()`
`long`	`getContentLength()`
`String`	`getContentType()`
`Cookie[]`	`getCookies()`
`String`	`getHeader(HeaderNameEnum headerNameEnum)`
`String`	`getHeader(String headName)`
`Collection<String>`	`getHeaderNames()`
`Collection<String>`	`getHeaders(String name)`
`int`	`getHeaderSize()`
`String`	`getHost()`
`BodyInputStream`	`getInputStream()`
`abstract InetSocketAddress`	`getLocalAddress()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getMethod()`
`String`	`getParameter(String name)`
`Map<String,String[]>`	`getParameters()`
`String[]`	`getParameterValues(String name)`
`HttpProtocolEnum`	`getProtocol()`
`String`	`getQueryString()`
`abstract String`	`getRemoteAddr()` Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
`abstract InetSocketAddress`	`getRemoteAddress()`
`abstract String`	`getRemoteHost()` Returns the fully qualified name of the client or the last proxy that sent the request.
`HttpTypeEnum`	`getRequestType()`
`String`	`getRequestURI()`
`String`	`getRequestURL()`
`String`	`getScheme()`
`ServerHandler`	`getServerHandler()`
`SSLEngine`	`getSslEngine()`
`String`	`getUri()`
`boolean`	`isMultiplexing()`
`boolean`	`isSecure()`
`void`	`reset()`
`void`	`setAttachment(org.smartboot.socket.util.Attachment attachment)` 存放附件，支持任意类型
`void`	`setHeader(String headerName, String value)`
`void`	`setMethod(String method)`
`void`	`setProtocol(HttpProtocolEnum protocol)`
`void`	`setQueryString(String queryString)`
`void`	`setRequestURI(String uri)`
`void`	`setScheme(String scheme)`
`void`	`setServerHandler(ServerHandler serverHandler)`
`void`	`setType(HttpTypeEnum type)`
`void`	`setUri(String uri)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

aioSession

protected final org.smartboot.socket.transport.AioSession aioSession

headers

protected final Map<String,HeaderValue> headers

Http请求头

configuration

protected final HttpServerConfiguration configuration

parameters

protected Map<String,String[]> parameters

请求参数

uri
```
protected String uri
```
原始的完整请求

headerSize
```
protected int headerSize
```

method
```
protected String method
```
请求方法

protocol
```
protected HttpProtocolEnum protocol
```
Http协议版本

requestUri
```
protected String requestUri
```

requestUrl
```
protected String requestUrl
```

contentType
```
protected String contentType
```

connection
```
protected String connection
```

queryString
```
protected String queryString
```
跟在URL后面的请求信息

scheme
```
protected String scheme
```
协议

contentLength
```
protected long contentLength
```

remoteAddr
```
protected String remoteAddr
```

remoteHost
```
protected String remoteHost
```

hostHeader
```
protected String hostHeader
```

type
```
protected HttpTypeEnum type
```
消息类型

cookies
```
protected Cookie[] cookies
```

sslEngine
```
protected SSLEngine sslEngine
```

attachment

protected org.smartboot.socket.util.Attachment attachment

附件对象

serverHandler
```
protected ServerHandler serverHandler
```

Method Detail

getSslEngine
```
public SSLEngine getSslEngine()
```

getHost
```
public final String getHost()
```

getHeader

public final String getHeader(HeaderNameEnum headerNameEnum)

getHeader

public final String getHeader(String headName)

getHeaders

public final Collection<String> getHeaders(String name)

getHeaderNames

public final Collection<String> getHeaderNames()

getHeaderSize
```
public final int getHeaderSize()
```

getInputStream

public BodyInputStream getInputStream()

setHeader

public final void setHeader(String headerName,
                            String value)

getRequestType
```
public HttpTypeEnum getRequestType()
```

setType

public void setType(HttpTypeEnum type)

getServerHandler

public ServerHandler getServerHandler()

setServerHandler

public void setServerHandler(ServerHandler serverHandler)

getRequestURI
```
public final String getRequestURI()
```

setRequestURI

public final void setRequestURI(String uri)

getProtocol

public final HttpProtocolEnum getProtocol()

setProtocol

public final void setProtocol(HttpProtocolEnum protocol)

getMethod
```
public final String getMethod()
```

isSecure
```
public final boolean isSecure()
```

setMethod

public final void setMethod(String method)

getUri
```
public final String getUri()
```

setUri
```
public final void setUri(String uri)
```

getRequestURL
```
public final String getRequestURL()
```

getScheme
```
public final String getScheme()
```

setScheme

public final void setScheme(String scheme)

getQueryString
```
public final String getQueryString()
```

setQueryString

public final void setQueryString(String queryString)

getContentType
```
public final String getContentType()
```

getConnection
```
public final String getConnection()
```

getContentLength
```
public long getContentLength()
```

getParameter

public final String getParameter(String name)

getParameterValues

public final String[] getParameterValues(String name)

getParameters

public final Map<String,String[]> getParameters()

getRemoteAddr
```
public abstract 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

public abstract InetSocketAddress getRemoteAddress()

getLocalAddress

public abstract InetSocketAddress getLocalAddress()

getRemoteHost
```
public abstract 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
```
public final Locale getLocale()
```

getLocales

public final Enumeration<Locale> getLocales()

getCharacterEncoding

public final String getCharacterEncoding()

getCookies
```
public final Cookie[] getCookies()
```

getAttachment

public final org.smartboot.socket.util.Attachment getAttachment()

获取附件对象

Returns:: 附件

setAttachment

public final void setAttachment(org.smartboot.socket.util.Attachment attachment)

存放附件，支持任意类型

Parameters:: attachment - 附件对象

getAioSession

public org.smartboot.socket.transport.AioSession getAioSession()

getConfiguration

public final HttpServerConfiguration getConfiguration()

isMultiplexing
```
public boolean isMultiplexing()
```

reset
```
public void reset()
```
Specified by:

reset in interface Reset

Class CommonRequest

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

aioSession

headers

configuration

parameters

uri

headerSize

method

protocol

requestUri

requestUrl

contentType

connection

queryString

scheme

contentLength

remoteAddr

remoteHost

hostHeader

type

cookies

sslEngine

attachment

serverHandler

Method Detail

getSslEngine

getHost

getHeader

getHeader

getHeaders

getHeaderNames

getHeaderSize

getInputStream

setHeader

getRequestType

setType

getServerHandler

setServerHandler

getRequestURI

setRequestURI

getProtocol

setProtocol

getMethod

isSecure

setMethod

getUri

setUri

getRequestURL

getScheme

setScheme

getQueryString

setQueryString

getContentType

getConnection

getContentLength

getParameter

getParameterValues

getParameters

getRemoteAddr

getRemoteAddress

getLocalAddress

getRemoteHost

getLocale

getLocales

getCharacterEncoding

getCookies

getAttachment

setAttachment

getAioSession

getConfiguration

isMultiplexing

reset