HTTPServer.Response (solon.boot.jlhttp 1.6.37-m1 API)

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

所有已实现的接口:

Closeable, AutoCloseable

封闭类:

HTTPServer
```
public class HTTPServer.Response
extends Object
implements Closeable
```
The Response class encapsulates a single HTTP response.

字段概要

字段
限定符和类型	字段和说明
`protected boolean`	`discardBody`
`protected OutputStream`	`encodedOut`
`protected HTTPServer.Headers`	`headers`
`protected OutputStream`	`out`
`protected HTTPServer.Request`	`req`
`protected int`	`state`

构造器概要

构造器
构造器和说明

Response(OutputStream out)
Constructs a Response whose output is written to the given stream.

构造器
构造器和说明
`Response(OutputStream out)` Constructs a Response whose output is written to the given stream.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`close()` Closes this response and flushes all output.
`OutputStream`	`getBody()` Returns an output stream into which the response body can be written.
`HTTPServer.Headers`	`getHeaders()` Returns the request headers collection.
`OutputStream`	`getOutputStream()` Returns the underlying output stream to which the response is written.
`boolean`	`headersSent()` Returns whether the response headers were already sent.
`void`	`redirect(String url, boolean permanent)` Sends a 301 or 302 response, redirecting the client to the given URL.
`void`	`send(int status, String text)` Sends the full response with the given status, and the given string as the body.
`void`	`sendBody(InputStream body, long length, long[] range)` Sends the response body.
`void`	`sendError(int status)` Sends an error response with the given status and default body.
`void`	`sendError(int status, String text)` Sends an error response with the given status and detailed message.
`void`	`sendHeaders(int status)` Sends the response headers with the given response status.
`void`	`sendHeaders(int status, long length, long lastModified, String etag, String contentType, long[] range)` Sends the response headers, including the given response status and description, and all response headers.
`void`	`setClientCapabilities(HTTPServer.Request req)` Sets the request which is used in determining the capabilities supported by the client (e.g. compression, encoding, etc.)
`void`	`setDiscardBody(boolean discardBody)` Sets whether this response's body is discarded or sent.

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

- 字段详细资料
  - out
```
protected OutputStream out
```
  - encodedOut
```
protected OutputStream encodedOut
```
  - headers
```
protected HTTPServer.Headers headers
```
  - discardBody
```
protected boolean discardBody
```
  - state
```
protected int state
```
  - req
```
protected HTTPServer.Request req
```
- 构造器详细资料
  - Response
```
public Response(OutputStream out)
```
    Constructs a Response whose output is written to the given stream.
    
    参数:
    
    out - the stream to which the response is written
- 方法详细资料
  - setDiscardBody
```
public void setDiscardBody(boolean discardBody)
```
    Sets whether this response's body is discarded or sent.
    
    参数:
    
    discardBody - specifies whether the body is discarded or not
  - setClientCapabilities
```
public void setClientCapabilities(HTTPServer.Request req)
```
    Sets the request which is used in determining the capabilities supported by the client (e.g. compression, encoding, etc.)
    
    参数:
    
    req - the request
  - getHeaders
```
public HTTPServer.Headers getHeaders()
```
    Returns the request headers collection.
    
    返回:
    
    the request headers collection
  - getOutputStream
```
public OutputStream getOutputStream()
```
    Returns the underlying output stream to which the response is written. Except for special cases, you should use getBody() instead.
    
    返回:
    
    the underlying output stream to which the response is written
  - headersSent
```
public boolean headersSent()
```
    Returns whether the response headers were already sent.
    
    返回:
    
    whether the response headers were already sent
  - getBody
```
public OutputStream getBody()
                     throws IOException
```
    Returns an output stream into which the response body can be written. The stream applies encodings (e.g. compression) according to the sent headers. This method must be called after response headers have been sent that indicate there is a body. Normally, the content should be prepared (not sent) even before the headers are sent, so that any errors during processing can be caught and a proper error response returned - after the headers are sent, it's too late to change the status into an error.
    
    返回:
    
    an output stream into which the response body can be written, or null if the body should not be written (e.g. it is discarded)
    
    抛出:
    
    IOException - if an error occurs
  - close
```
public void close()
           throws IOException
```
    Closes this response and flushes all output.
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException - if an error occurs
  - sendHeaders
```
public void sendHeaders(int status)
                 throws IOException
```
    Sends the response headers with the given response status. A Date header is added if it does not already exist. If the response has a body, the Content-Length/Transfer-Encoding and Content-Type headers must be set before sending the headers.
    
    参数:
    
    status - the response status
    
    抛出:
    
    IOException - if an error occurs or headers were already sent
    
    另请参阅:
    
    sendHeaders(int, long, long, String, String, long[])
  - sendHeaders
```
public void sendHeaders(int status,
                        long length,
                        long lastModified,
                        String etag,
                        String contentType,
                        long[] range)
                 throws IOException
```
    Sends the response headers, including the given response status and description, and all response headers. If they do not already exist, the following headers are added as necessary: Content-Range, Content-Type, Transfer-Encoding, Content-Encoding, Content-Length, Last-Modified, ETag, Connection and Date. Ranges are properly calculated as well, with a 200 status changed to a 206 status.
    
    参数:
    
    status - the response status
    
    length - the response body length, or zero if there is no body, or negative if there is a body but its length is not yet known
    
    lastModified - the last modified date of the response resource, or non-positive if unknown. A time in the future will be replaced with the current system time.
    
    etag - the ETag of the response resource, or null if unknown (see RFC2616#3.11)
    
    contentType - the content type of the response resource, or null if unknown (in which case "application/octet-stream" will be sent)
    
    range - the content range that will be sent, or null if the entire resource will be sent
    
    抛出:
    
    IOException - if an error occurs
  - send
```
public void send(int status,
                 String text)
          throws IOException
```
    Sends the full response with the given status, and the given string as the body. The text is sent in the UTF-8 charset. If a Content-Type header was not explicitly set, it will be set to text/html, and so the text must contain valid (and properly escaped) HTML.
    
    参数:
    
    status - the response status
    
    text - the text body (sent as text/html)
    
    抛出:
    
    IOException - if an error occurs
  - sendError
```
public void sendError(int status,
                      String text)
               throws IOException
```
    Sends an error response with the given status and detailed message. An HTML body is created containing the status and its description, as well as the message, which is escaped using the escape method.
    
    参数:
    
    status - the response status
    
    text - the text body (sent as text/html)
    
    抛出:
    
    IOException - if an error occurs
  - sendError
```
public void sendError(int status)
               throws IOException
```
    Sends an error response with the given status and default body.
    
    参数:
    
    status - the response status
    
    抛出:
    
    IOException - if an error occurs
  - sendBody
```
public void sendBody(InputStream body,
                     long length,
                     long[] range)
              throws IOException
```
    Sends the response body. This method must be called only after the response headers have been sent (and indicate that there is a body).
    
    参数:
    
    body - a stream containing the response body
    
    length - the full length of the response body, or -1 for the whole stream
    
    range - the sub-range within the response body that should be sent, or null if the entire body should be sent
    
    抛出:
    
    IOException - if an error occurs
  - redirect
```
public void redirect(String url,
                     boolean permanent)
              throws IOException
```
    Sends a 301 or 302 response, redirecting the client to the given URL.
    
    参数:
    
    url - the absolute URL to which the client is redirected
    
    permanent - specifies whether a permanent (301) or temporary (302) redirect status is sent
    
    抛出:
    
    IOException - if an IO error occurs or url is malformed

类 HTTPServer.Response

字段概要

构造器概要

方法概要

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

字段详细资料

out

encodedOut

headers

discardBody

state

req

构造器详细资料

Response

方法详细资料

setDiscardBody

setClientCapabilities

getHeaders

getOutputStream

headersSent

getBody

close

sendHeaders

sendHeaders

send

sendError

sendError

sendBody

redirect