HTTPServer.Request (solon.boot.jlhttp 1.11.6 API)

java.lang.Object
- org.noear.solon.boot.jlhttp.HTTPServer.Request

封闭类:

HTTPServer
```
public class HTTPServer.Request
extends Object
```
The Request class encapsulates a single HTTP request.

字段概要

字段
限定符和类型	字段和说明
`protected URL`	`baseURL`
`protected InputStream`	`body`
`protected HTTPServer.VirtualHost.ContextInfo`	`context`
`protected HTTPServer.Headers`	`headers`
`protected HTTPServer.VirtualHost`	`host`
`protected String`	`method`
`protected Map<String,String>`	`params`
`protected Socket`	`sock`
`protected URI`	`uri`
`protected String`	`version`

构造器概要

构造器
构造器和说明

Request(InputStream in, Socket sock)
Constructs a Request from the data in the given input stream.

构造器
构造器和说明
`Request(InputStream in, Socket sock)` Constructs a Request from the data in the given input stream.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`URL`	`getBaseURL()` Returns the base URL (scheme, host and port) of the request resource.
`InputStream`	`getBody()` Returns the input stream containing the request body.
`HTTPServer.VirtualHost.ContextInfo`	`getContext()` Returns the info of the context handling this request.
`HTTPServer.Headers`	`getHeaders()` Returns the request headers.
`String`	`getMethod()` Returns the request method.
`Map<String,String>`	`getParams()` Returns the request parameters, which are parsed both from the query part of the request URI, and from the request body if its content type is "application/x-www-form-urlencoded" (i.e. a submitted form).
`List<String[]>`	`getParamsList()`
`String`	`getPath()` Returns the path component of the request URI, after URL decoding has been applied (using the UTF-8 charset).
`long[]`	`getRange(long length)` Returns the absolute (zero-based) content range value read from the Range header.
`Socket`	`getSocket()` Returns the underlying socket, which can be used to retrieve connection meta-data.
`URI`	`getURI()` Returns the request URI.
`String`	`getVersion()` Returns the request version string.
`HTTPServer.VirtualHost`	`getVirtualHost()` Returns the virtual host corresponding to the requested host name, or the default host if none exists.
`protected void`	`readRequestLine(InputStream in)` Reads the request line, parsing the method, URI and version string.
`void`	`setPath(String path)` Sets the path component of the request URI.

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

- 字段详细资料
  - method
```
protected String method
```
  - uri
```
protected URI uri
```
  - baseURL
```
protected URL baseURL
```
  - version
```
protected String version
```
  - headers
```
protected HTTPServer.Headers headers
```
  - body
```
protected InputStream body
```
  - sock
```
protected Socket sock
```
  - params
```
protected Map<String,String> params
```
  - host
```
protected HTTPServer.VirtualHost host
```
  - context
```
protected HTTPServer.VirtualHost.ContextInfo context
```
- 构造器详细资料
  - Request
```
public Request(InputStream in,
               Socket sock)
        throws IOException
```
    Constructs a Request from the data in the given input stream.
    
    参数:
    
    in - the input stream from which the request is read
    
    sock - the underlying connected socket
    
    抛出:
    
    IOException - if an error occurs
- 方法详细资料
  - getMethod
```
public String getMethod()
```
    Returns the request method.
    
    返回:
    
    the request method
  - getURI
```
public URI getURI()
```
    Returns the request URI.
    
    返回:
    
    the request URI
  - getVersion
```
public String getVersion()
```
    Returns the request version string.
    
    返回:
    
    the request version string
  - getHeaders
```
public HTTPServer.Headers getHeaders()
```
    Returns the request headers.
    
    返回:
    
    the request headers
  - getBody
```
public InputStream getBody()
```
    Returns the input stream containing the request body.
    
    返回:
    
    the input stream containing the request body
  - getSocket
```
public Socket getSocket()
```
    Returns the underlying socket, which can be used to retrieve connection meta-data.
    
    返回:
    
    the underlying socket
  - getPath
```
public String getPath()
```
    Returns the path component of the request URI, after URL decoding has been applied (using the UTF-8 charset).
    
    返回:
    
    the decoded path component of the request URI
  - setPath
```
public void setPath(String path)
```
    Sets the path component of the request URI. This can be useful in URL rewriting, etc.
    
    参数:
    
    path - the path to set
    
    抛出:
    
    IllegalArgumentException - if the given path is malformed
  - getBaseURL
```
public URL getBaseURL()
```
    Returns the base URL (scheme, host and port) of the request resource. The host name is taken from the request URI or the Host header or a default host (see RFC2616#5.2).
    
    返回:
    
    the base URL of the requested resource, or null if it is malformed
  - getParamsList
```
public List<String[]> getParamsList()
                             throws IOException
```
    抛出:
    
    IOException
  - getParams
```
public Map<String,String> getParams()
                             throws IOException
```
    Returns the request parameters, which are parsed both from the query part of the request URI, and from the request body if its content type is "application/x-www-form-urlencoded" (i.e. a submitted form). UTF-8 encoding is assumed in both cases.
    For multivalued parameters (i.e. multiple parameters with the same name), only the first one is considered. For access to all values, use getParamsList() instead.
    The map iteration retains the original order of the parameters.
    
    返回:
    
    the request parameters name-value pairs, or an empty map if there are none
    
    抛出:
    
    IOException - if an error occurs
    
    另请参阅:
    
    getParamsList()
  - getRange
```
public long[] getRange(long length)
```
    Returns the absolute (zero-based) content range value read from the Range header. If multiple ranges are requested, a single range containing all of them is returned.
    
    参数:
    
    length - the full length of the requested resource
    
    返回:
    
    the requested range, or null if the Range header is missing or invalid
  - readRequestLine
```
protected void readRequestLine(InputStream in)
                        throws IOException
```
    Reads the request line, parsing the method, URI and version string.
    
    参数:
    
    in - the input stream from which the request line is read
    
    抛出:
    
    IOException - if an error occurs or the request line is invalid
  - getVirtualHost
```
public HTTPServer.VirtualHost getVirtualHost()
```
    Returns the virtual host corresponding to the requested host name, or the default host if none exists.
    
    返回:
    
    the virtual host corresponding to the requested host name, or the default virtual host
  - getContext
```
public HTTPServer.VirtualHost.ContextInfo getContext()
```
    Returns the info of the context handling this request.
    
    返回:
    
    the info of the context handling this request, or an empty context

类 HTTPServer.Request

字段概要

构造器概要

方法概要

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

字段详细资料

method

uri

baseURL

version

headers

body

sock

params

host

context

构造器详细资料

Request

方法详细资料

getMethod

getURI

getVersion

getHeaders

getBody

getSocket

getPath

setPath

getBaseURL

getParamsList

getParams

getRange

readRequestLine

getVirtualHost

getContext