net.hasor.rsf.rpc.net.http

接口 RsfHttpResponse

public interface RsfHttpResponse

Http Response 删减版

版本:

: 2017年11月22日

作者:

赵永春 (zyc@hasor.net)

方法概要

限定符和类型	方法和说明
void	addHeader(String name, String value) Adds a response header with the given name and value.
boolean	containsHeader(String name) Returns a boolean indicating whether the named response header has already been set.
void	flushBuffer() Forces any content in the buffer to be written to the client.
String	getContentType() Returns the content type used for the MIME body sent in this response.
String	getHeader(String name) Gets the value of the response header with the given name.
Collection<String>	getHeaderNames() Gets the names of the headers of this response.
Collection<String>	getHeaders(String name) Gets the values of the response header with the given name.
OutputStream	getOutputStream() Returns a OutputStream suitable for writing binary data in the response.
int	getStatus() Gets the current status code of this response.
boolean	isCommitted() Returns a boolean indicating if the response has been committed.
void	sendError(int sc) Sends an error response to the client using the specified status code and clears the buffer.
void	sendError(int sc, String msg) Sends an error response to the client using the specified status and clears the buffer.
void	setContentLength(long len) Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
void	setContentType(String type) Sets the content type of the response being sent to the client, if the response has not been committed yet.
void	setHeader(String name, String value) Sets a response header with the given name and value.

方法详细资料

getContentType

String getContentType()

Returns the content type used for the MIME body sent in this response. The content type proper must have been specified using setContentType(java.lang.String) before the response is committed. If no content type has been specified, this method returns null. If a content type has been specified, and a character encoding. If no character encoding has been specified, the charset parameter is omitted.

返回:

a String specifying the content type, for example, text/html; charset=UTF-8, or null

setContentType

void setContentType(String type)

Sets the content type of the response being sent to the client, if the response has not been committed yet. The given content type may include a character encoding specification, for example, text/html;charset=UTF-8. The response's character encoding is only set from the given content type if this method is called before getWriter is called.

This method may be called repeatedly to change content type and character encoding. This method has no effect if called after the response has been committed. It does not set the response's character encoding if it is called after getWriter has been called or after the response has been committed.

Containers must communicate the content type and the character encoding used for the servlet response's writer to the client if the protocol provides a way for doing so. In the case of HTTP, the Content-Type header is used.

参数:

type - a String specifying the MIME type of the content

另请参阅:

getOutputStream()

getOutputStream

OutputStream getOutputStream()
                      throws IOException

Returns a OutputStream suitable for writing binary data in the response. The servlet container does not encode the binary data.

返回:

a OutputStream for writing binary data

抛出:

IOException - if an input or output exception occurred

setContentLength

void setContentLength(long len)

Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.

参数:

len - an integer specifying the length of the content being returned to the client; sets the Content-Length header

flushBuffer

void flushBuffer()
          throws IOException

Forces any content in the buffer to be written to the client. A call to this method automatically commits the response, meaning the status code and headers will be written.

抛出:

IOException

另请参阅:

isCommitted()

isCommitted

boolean isCommitted()

Returns a boolean indicating if the response has been committed. A committed response has already had its status code and headers written.

返回:

a boolean indicating if the response has been committed

sendError

void sendError(int sc,
               String msg)
        throws IOException

Sends an error response to the client using the specified status and clears the buffer. The server defaults to creating the response to look like an HTML-formatted server error page containing the specified message, setting the content type to "text/html". The server will preserve cookies and may clear or update any headers needed to serve the error page as a valid response. If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back in preference to the suggested msg parameter and the msg parameter will be ignored.

If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

参数:

sc - the error status code

msg - the descriptive message

抛出:

IOException - If an input or output exception occurs

IllegalStateException - If the response was committed

sendError

void sendError(int sc)
        throws IOException

Sends an error response to the client using the specified status code and clears the buffer. The server will preserve cookies and may clear or update any headers needed to serve the error page as a valid response. If an error-page declaration has been made for the web application corresponding to the status code passed in, it will be served back the error page

If the response has already been committed, this method throws an IllegalStateException. After using this method, the response should be considered to be committed and should not be written to.

参数:

sc - the error status code

抛出:

IOException - If an input or output exception occurs

IllegalStateException - If the response was committed before this method call

getStatus

int getStatus()

Gets the current status code of this response.

返回:

the current status code of this response

containsHeader

boolean containsHeader(String name)

Returns a boolean indicating whether the named response header has already been set.

参数:

name - the header name

返回:

true if the named response header has already been set; false otherwise

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.

参数:

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)

另请参阅:

containsHeader(java.lang.String), 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.

参数:

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)

另请参阅:

setHeader(java.lang.String, java.lang.String)

getHeader

String getHeader(String name)

Gets the value of the response header with the given name.

If a response header with the given name exists and contains multiple values, the value that was added first will be returned.

This method considers only response headers set or added via setHeader(java.lang.String, java.lang.String), addHeader(java.lang.String, java.lang.String), respectively.

参数:

name - the name of the response header whose value to return

返回:

the value of the response header with the given name, or null if no header with the given name has been set on this response

getHeaders

Collection<String> getHeaders(String name)

Gets the values of the response header with the given name.

This method considers only response headers set or added via setHeader(java.lang.String, java.lang.String), addHeader(java.lang.String, java.lang.String), respectively.

Any changes to the returned Collection must not affect this HttpServletResponse.

参数:

name - the name of the response header whose values to return

返回:

a (possibly empty) Collection of the values of the response header with the given name

getHeaderNames

Collection<String> getHeaderNames()

Gets the names of the headers of this response.

This method considers only response headers set or added via setHeader(java.lang.String, java.lang.String), addHeader(java.lang.String, java.lang.String), respectively.

Any changes to the returned Collection must not affect this HttpServletResponse.

返回:

a (possibly empty) Collection of the names of the headers of this response

从以下版本开始:

Servlet 3.0