org.dromara.hutool.http.server.engine.sun

Class SunServerResponse

java.lang.Object

org.dromara.hutool.http.server.engine.sun.SunServerExchangeBase

org.dromara.hutool.http.server.engine.sun.SunServerResponse

All Implemented Interfaces:

Closeable, AutoCloseable, ServerResponse

public class SunServerResponse
extends SunServerExchangeBase
implements ServerResponse

SunHttp服务器响应对象

Since:

6.0.0

Author:

looly

Field Summary

Fields inherited from class org.dromara.hutool.http.server.engine.sun.SunServerExchangeBase

httpExchange

Fields inherited from interface org.dromara.hutool.http.server.handler.ServerResponse

DEFAULT_CHARSET

Constructor Summary

Constructors

Constructor and Description
SunServerResponse(com.sun.net.httpserver.HttpExchange httpExchange) 构造

Method Summary

Modifier and Type	Method and Description
SunServerResponse	addHeader(String header, String value) 添加响应头，如果已经存在，则追加
Charset	getCharset() 获取编码，默认为UTF-8
com.sun.net.httpserver.Headers	getHeaders() 获得所有响应头，获取后可以添加新的响应头
OutputStream	getOutputStream() 获取输出流，用于写出数据
SunServerResponse	send(int httpStatusCode, long bodyLength) 发送HTTP状态码
SunServerResponse	send404(String content) 发送404错误页
SunServerResponse	sendError(int errorCode, String content) 发送错误页
SunServerResponse	sendOk() 发送成功状态码
SunServerResponse	sendOk(int bodyLength) 发送成功状态码
SunServerResponse	setAttr(String name, Object value) 设置属性
SunServerResponse	setCharset(Charset charset) 设置编码，默认为UTF-8
SunServerResponse	setHeader(String header, List<String> value) 设置响应头，如果已经存在，则覆盖
SunServerResponse	setHeader(String header, String value) 设置响应头，如果已经存在，则覆盖
SunServerResponse	setHeaders(Map<String,List<String>> headers) 设置所有响应头，如果已经存在，则覆盖
SunServerResponse	setStatus(int statusCode) 设置状态码
SunServerResponse	write(InputStream in, int length) 写出数据到客户端

Methods inherited from class org.dromara.hutool.http.server.engine.sun.SunServerExchangeBase

close, getExchange, getHttpContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dromara.hutool.http.server.handler.ServerResponse

getWriter, setContentLength, setContentType, setHeader, write, write, write, write, write, write, write, write, write, write, write

Constructor Detail

SunServerResponse

public SunServerResponse(com.sun.net.httpserver.HttpExchange httpExchange)

构造

Parameters:

httpExchange - HttpExchange

Method Detail

setStatus

public SunServerResponse setStatus(int statusCode)

Description copied from interface: ServerResponse

设置状态码

Specified by:

setStatus in interface ServerResponse

Parameters:

statusCode - 状态码

Returns:

this

sendOk

public SunServerResponse sendOk()

发送成功状态码

Returns:

this

sendOk

public SunServerResponse sendOk(int bodyLength)

发送成功状态码

Parameters:

bodyLength - 响应体长度，默认0表示不定长度，会输出Transfer-encoding: chunked

Returns:

this

Since:

5.5.7

send404

public SunServerResponse send404(String content)

发送404错误页

Parameters:

content - 错误页页面内容，默认text/html类型

Returns:

this

sendError

public SunServerResponse sendError(int errorCode,
                                   String content)

发送错误页

Parameters:

errorCode - HTTP错误状态码，见HttpStatus

content - 错误页页面内容，默认text/html类型

Returns:

this

send

public SunServerResponse send(int httpStatusCode,
                              long bodyLength)

发送HTTP状态码

Parameters:

httpStatusCode - HTTP状态码，见HttpStatus

bodyLength - 响应体长度，默认0表示不定长度，会输出Transfer-encoding: chunked

Returns:

this

setCharset

public SunServerResponse setCharset(Charset charset)

Description copied from interface: ServerResponse

设置编码，默认为UTF-8

Specified by:

setCharset in interface ServerResponse

Parameters:

charset - 编码

Returns:

this

getCharset

public Charset getCharset()

Description copied from interface: ServerResponse

获取编码，默认为UTF-8

Specified by:

getCharset in interface ServerResponse

Returns:

编码

getHeaders

public com.sun.net.httpserver.Headers getHeaders()

获得所有响应头，获取后可以添加新的响应头

Returns:

响应头

addHeader

public SunServerResponse addHeader(String header,
                                   String value)

Description copied from interface: ServerResponse

添加响应头，如果已经存在，则追加

Specified by:

addHeader in interface ServerResponse

Parameters:

header - 头key

value - 值

Returns:

this

setHeader

public SunServerResponse setHeader(String header,
                                   String value)

Description copied from interface: ServerResponse

设置响应头，如果已经存在，则覆盖

Specified by:

setHeader in interface ServerResponse

Parameters:

header - 头key

value - 值

Returns:

this

setHeader

public SunServerResponse setHeader(String header,
                                   List<String> value)

设置响应头，如果已经存在，则覆盖

Specified by:

setHeader in interface ServerResponse

Parameters:

header - 头key

value - 值列表

Returns:

this

setHeaders

public SunServerResponse setHeaders(Map<String,List<String>> headers)

设置所有响应头，如果已经存在，则覆盖

Parameters:

headers - 响应头map

Returns:

this

setAttr

public SunServerResponse setAttr(String name,
                                 Object value)

设置属性

Parameters:

name - 属性名

value - 属性值

Returns:

this

getOutputStream

public OutputStream getOutputStream()

Description copied from interface: ServerResponse

获取输出流，用于写出数据

Specified by:

getOutputStream in interface ServerResponse

Returns:

输出流

write

public SunServerResponse write(InputStream in,
                               int length)

写出数据到客户端

Specified by:

write in interface ServerResponse

Parameters:

in - 数据流

length - 指定响应内容长度，默认0表示不定长度，会输出Transfer-encoding: chunked

Returns:

this