AbstractResponse (smart-http-server 2.5.2 API)

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

All Implemented Interfaces:

Reset, HttpResponse

Direct Known Subclasses:

WebSocketResponseImpl
```
public class AbstractResponse
extends Object
implements HttpResponse, Reset
```
Version:

V1.0 , 2018/2/3

Author:

三刀

Field Summary

Fields
Modifier and Type Field and Description

protected boolean closed
是否关闭Socket连接通道

protected org.smartboot.http.server.impl.AbstractOutputStream outputStream
输入流

Fields
Modifier and Type	Field and Description
`protected boolean`	`closed` 是否关闭Socket连接通道
`protected org.smartboot.http.server.impl.AbstractOutputStream`	`outputStream` 输入流

Constructor Summary

Constructors
Constructor and Description

AbstractResponse()

Constructors
Constructor and Description
`AbstractResponse()`

Method Summary

All Methods Instance Methods Concrete 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()`
`List<Cookie>`	`getCookies()`
`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()` 响应消息输出流
`Supplier<Map<String,String>>`	`getTrailerFields()` Gets the supplier of trailer headers.
`protected void`	`init(org.smartboot.socket.transport.AioSession session, org.smartboot.http.server.impl.AbstractOutputStream outputStream)`
`boolean`	`isClosed()` 是否要断开TCP连接
`void`	`reset()`
`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 value, String reasonPhrase)` 设置Http响应状态,若不设置默认`HttpStatus.OK`
`void`	`write(byte[] buffer)`

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

Methods inherited from interface org.smartboot.http.server.HttpResponse
setTrailerFields

- Field Detail
  - outputStream
```
protected org.smartboot.http.server.impl.AbstractOutputStream outputStream
```
    输入流
  - closed
```
protected boolean closed
```
    是否关闭Socket连接通道
- Constructor Detail
  - AbstractResponse
```
public AbstractResponse()
```
- Method Detail
  - init
```
protected void init(org.smartboot.socket.transport.AioSession session,
                    org.smartboot.http.server.impl.AbstractOutputStream outputStream)
```
  - reset
```
public final void reset()
```
    Specified by:
    
    reset in interface Reset
  - getOutputStream
```
public final BufferOutputStream getOutputStream()
```
    Description copied from interface: HttpResponse
    
    响应消息输出流
    
    Specified by:
    
    getOutputStream in interface HttpResponse
    
    Returns:
  - getHttpStatus
```
public HttpStatus getHttpStatus()
```
    Description copied from interface: HttpResponse
    
    获取Http响应状态
    
    Specified by:
    
    getHttpStatus in interface HttpResponse
    
    Returns:
  - setHttpStatus
```
public final void setHttpStatus(HttpStatus httpStatus)
```
    Description copied from interface: HttpResponse
    
    设置Http响应状态,若不设置默认HttpStatus.OK
    
    Specified by:
    
    setHttpStatus in interface HttpResponse
  - setHttpStatus
```
public final void setHttpStatus(int value,
                                String reasonPhrase)
```
    Description copied from interface: HttpResponse
    
    设置Http响应状态,若不设置默认HttpStatus.OK
    
    Specified by:
    
    setHttpStatus in interface HttpResponse
  - setHeader
```
public final void setHeader(String name,
                            String value)
```
    Description copied from interface: HttpResponse
    
    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.
    
    Specified by:
    
    setHeader in interface HttpResponse
    
    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:
    
    HttpResponse.addHeader(java.lang.String, java.lang.String)
  - addHeader
```
public final void addHeader(String name,
                            String value)
```
    Description copied from interface: HttpResponse
    
    Adds a response header with the given name and value. This method allows response headers to have multiple values.
    
    Specified by:
    
    addHeader in interface HttpResponse
    
    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:
    
    HttpResponse.setHeader(java.lang.String, java.lang.String)
  - getHeader
```
public final String getHeader(String name)
```
    Specified by:
    
    getHeader in interface HttpResponse
  - getHeaders
```
public final Collection<String> getHeaders(String name)
```
    Description copied from interface: HttpResponse
    
    Return a Collection of all the header values associated with the specified header name.
    
    Specified by:
    
    getHeaders in interface HttpResponse
    
    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.
  - getHeaderNames
```
public final Collection<String> getHeaderNames()
```
    Description copied from interface: HttpResponse
    
    Get the header names set for this HTTP response.
    
    Specified by:
    
    getHeaderNames in interface HttpResponse
    
    Returns:
    
    The header names set for this HTTP response.
  - write
```
public final void write(byte[] buffer)
                 throws IOException
```
    Specified by:
    
    write in interface HttpResponse
    
    Throws:
    
    IOException
  - close
```
public void close()
```
    Specified by:
    
    close in interface HttpResponse
  - getCookies
```
public List<Cookie> getCookies()
```
  - addCookie
```
public void addCookie(Cookie cookie)
```
    Description copied from interface: HttpResponse
    
    添加Cookie信息
    
    Specified by:
    
    addCookie in interface HttpResponse
  - getContentLength
```
public long getContentLength()
```
    Specified by:
    
    getContentLength in interface HttpResponse
  - setContentLength
```
public void setContentLength(long contentLength)
```
    Specified by:
    
    setContentLength in interface HttpResponse
  - getContentType
```
public final String getContentType()
```
    Specified by:
    
    getContentType in interface HttpResponse
  - setContentType
```
public final void setContentType(String contentType)
```
    Specified by:
    
    setContentType in interface HttpResponse
  - isClosed
```
public final boolean isClosed()
```
    是否要断开TCP连接
    
    Returns:
    
    true/false
  - getTrailerFields
```
public Supplier<Map<String,String>> getTrailerFields()
```
    Description copied from interface: HttpResponse
    
    Gets the supplier of trailer headers.
    
    Specified by:
    
    getTrailerFields in interface HttpResponse
    
    Returns:
    
    Supplier of trailer headers

Class AbstractResponse

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.smartboot.http.server.HttpResponse

Field Detail

outputStream

closed

Constructor Detail

AbstractResponse

Method Detail

init

reset

getOutputStream

getHttpStatus

setHttpStatus

setHttpStatus

setHeader

addHeader

getHeader

getHeaders

getHeaderNames

write

close

getCookies

addCookie

getContentLength

setContentLength

getContentType

setContentType

isClosed

getTrailerFields