HttpResponse (smart-http-server 2.5.2 API)

All Known Implementing Classes:

AbstractResponse, WebSocketResponseImpl
```
public interface HttpResponse
```
Http消息响应接口

Version:

V1.0 , 2018/2/3

Author:

三刀

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addCookie(Cookie cookie)` 添加Cookie信息
`void`	`addHeader(String name, String value)` Adds a response header with the given name and value.
`void`	`close()`
`long`	`getContentLength()`
`String`	`getContentType()`
`String`	`getHeader(String name)`
`Collection<String>`	`getHeaderNames()` Get the header names set for this HTTP response.
`Collection<String>`	`getHeaders(String name)` Return a Collection of all the header values associated with the specified header name.
`HttpStatus`	`getHttpStatus()` 获取Http响应状态
`BufferOutputStream`	`getOutputStream()` 响应消息输出流
`default Supplier<Map<String,String>>`	`getTrailerFields()` Gets the supplier of trailer headers.
`void`	`setContentLength(long contentLength)`
`void`	`setContentType(String contentType)`
`void`	`setHeader(String name, String value)` Sets a response header with the given name and value.
`void`	`setHttpStatus(HttpStatus httpStatus)` 设置Http响应状态,若不设置默认`HttpStatus.OK`
`void`	`setHttpStatus(int httpStatus, String reasonPhrase)` 设置Http响应状态,若不设置默认`HttpStatus.OK`
`default void`	`setTrailerFields(Supplier<Map<String,String>> supplier)` Sets the supplier of trailer headers.
`void`	`write(byte[] data)`

- Method Detail
  - getOutputStream
```
BufferOutputStream getOutputStream()
```
    响应消息输出流
    
    Returns:
  - getHttpStatus
```
HttpStatus getHttpStatus()
```
    获取Http响应状态
    
    Returns:
  - setHttpStatus
```
void setHttpStatus(HttpStatus httpStatus)
```
    设置Http响应状态,若不设置默认HttpStatus.OK
    
    Parameters:
    
    httpStatus -
  - setHttpStatus
```
void setHttpStatus(int httpStatus,
                   String reasonPhrase)
```
    设置Http响应状态,若不设置默认HttpStatus.OK
    
    Parameters:
    
    httpStatus -
  - setHeader
```
void setHeader(String name,
               String value)
```
    Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.
    
    Parameters:
    
    name - the name of the header
    
    value - the header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)
    
    See Also:
    
    addHeader(java.lang.String, java.lang.String)
  - addHeader
```
void addHeader(String name,
               String value)
```
    Adds a response header with the given name and value. This method allows response headers to have multiple values.
    
    Parameters:
    
    name - the name of the header
    
    value - the additional header value If it contains octet string, it should be encoded according to RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)
    
    See Also:
    
    setHeader(java.lang.String, java.lang.String)
  - getHeader
```
String getHeader(String name)
```
  - getHeaders
```
Collection<String> getHeaders(String name)
```
    Return a Collection of all the header values associated with the specified header name.
    
    Parameters:
    
    name - Header name to look up
    
    Returns:
    
    The values for the specified header. These are the raw values so if multiple values are specified in a single header that will be returned as a single header value.
    
    Since:
    
    Servlet 3.0
  - getHeaderNames
```
Collection<String> getHeaderNames()
```
    Get the header names set for this HTTP response.
    
    Returns:
    
    The header names set for this HTTP response.
    
    Since:
    
    Servlet 3.0
  - setContentLength
```
void setContentLength(long contentLength)
```
  - getContentLength
```
long getContentLength()
```
  - setContentType
```
void setContentType(String contentType)
```
  - getContentType
```
String getContentType()
```
  - write
```
void write(byte[] data)
    throws IOException
```
    Throws:
    
    IOException
  - close
```
void close()
```
  - addCookie
```
void addCookie(Cookie cookie)
```
    添加Cookie信息
    
    Parameters:
    
    cookie -
  - setTrailerFields
```
default void setTrailerFields(Supplier<Map<String,String>> supplier)
```
    Sets the supplier of trailer headers.
    The trailer header field value is defined as a comma-separated list (see Section 3.2.2 and Section 4.1.2 of RFC 7230).
    
    The supplier will be called within the scope of whatever thread/call causes the response content to be completed. Typically this will be any thread calling close() on the output stream or writer.
    
    The trailers that run afoul of the provisions of section 4.1.2 of RFC 7230 are ignored.
    
    The RFC requires the name of every key that is to be in the supplied Map is included in the comma separated list that is the value of the "Trailer" response header. The application is responsible for ensuring this requirement is met. Failure to do so may lead to interoperability failures.
    
    Parameters:
    
    supplier - the supplier of trailer headers
    
    Throws:
    
    IllegalStateException - if it is invoked after the response has has been committed, or the trailer is not supported in the request, for instance, the underlying protocol is HTTP 1.0, or the response is not in chunked encoding in HTTP 1.1.
    
    Since:
    
    Servlet 4.0
  - getTrailerFields
```
default Supplier<Map<String,String>> getTrailerFields()
```
    Gets the supplier of trailer headers.
    
    Returns:
    
    Supplier of trailer headers
    
    Since:
    
    Servlet 4.0

Interface HttpResponse

Method Summary

Method Detail

getOutputStream

getHttpStatus

setHttpStatus

setHttpStatus

setHeader

addHeader

getHeader

getHeaders

getHeaderNames

setContentLength

getContentLength

setContentType

getContentType

write

close

addCookie

setTrailerFields

getTrailerFields