BufferedResponseImpl (tiny-码云(gitee.com))

java.lang.Object
- javax.servlet.ServletResponseWrapper
- - javax.servlet.http.HttpServletResponseWrapper
  - - org.tinygroup.weblayer.webcontext.AbstractResponseWrapper
    - - org.tinygroup.weblayer.webcontext.buffered.response.BufferedResponseImpl

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse
```
public class BufferedResponseImpl
extends AbstractResponseWrapper
```
包裹HttpServletResponse，使之输出到内存中。

Author:

renhui

Field Summary
- Fields inherited from interface javax.servlet.http.HttpServletResponse
  SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

Constructors
Constructor and Description

BufferedResponseImpl(WebContext webContext, javax.servlet.http.HttpServletResponse response)
创建一个BufferedResponseImpl。

Constructors
Constructor and Description
`BufferedResponseImpl(WebContext webContext, javax.servlet.http.HttpServletResponse response)` 创建一个`BufferedResponseImpl`。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`commitBuffer()` 将buffer中的内容提交到真正的servlet输出流中。
`void`	`flushBuffer()` 冲洗buffer。
`javax.servlet.ServletOutputStream`	`getOutputStream()` 取得输出流。
`PrintWriter`	`getWriter()` 取得输出字符流。
`boolean`	`isBuffering()` 设置是否将所有信息保存在内存中。
`ByteArray`	`peekByteBuffer()` 返回最上层的ByteArray
`String`	`peekCharBuffer()` 返回最上层的buffer
`ByteArray`	`popByteBuffer()` 弹出最近的buffer，如果堆栈中只有一个buffer，则弹出后再创建一个新的。
`String`	`popCharBuffer()` 弹出最近的buffer，如果堆栈中只有一个buffer，则弹出后再创建一个新的。
`void`	`pushBuffer()` 创建新的buffer，保存老的buffer。
`void`	`resetBuffer()` 清除所有buffers，常用于显示出现异常信息。
`void`	`setBuffering(boolean buffering)` 设置buffer模式，如果设置成`true`，表示将所有信息保存在内存中，否则直接输出到原始response中。
`void`	`setContentLength(int length)` 设置content长度。该调用只在`setBuffering(false)`时有效。

Methods inherited from class org.tinygroup.weblayer.webcontext.AbstractResponseWrapper
getServletContext, getWebContext, toString

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper
addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper
getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, reset, setBufferSize, setCharacterEncoding, setContentType, setLocale, setResponse

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

Methods inherited from interface javax.servlet.ServletResponse
getBufferSize, getCharacterEncoding, getContentType, getLocale, isCommitted, reset, setBufferSize, setCharacterEncoding, setContentType, setLocale

- Constructor Detail
  - BufferedResponseImpl
```
public BufferedResponseImpl(WebContext webContext,
                            javax.servlet.http.HttpServletResponse response)
```
    创建一个BufferedResponseImpl。
    
    Parameters:
    
    requestContext - response所在的request context
    
    response - 原始的response
- Method Detail
  - getOutputStream
```
public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException
```
    取得输出流。
    
    Specified by:
    
    getOutputStream in interface javax.servlet.ServletResponse
    
    Overrides:
    
    getOutputStream in class javax.servlet.ServletResponseWrapper
    
    Returns:
    
    response的输出流
    
    Throws:
    
    IOException - 输入输出失败
  - getWriter
```
public PrintWriter getWriter()
                      throws IOException
```
    取得输出字符流。
    
    Specified by:
    
    getWriter in interface javax.servlet.ServletResponse
    
    Overrides:
    
    getWriter in class javax.servlet.ServletResponseWrapper
    
    Returns:
    
    response的输出字符流
    
    Throws:
    
    IOException - 输入输出失败
  - setContentLength
```
public void setContentLength(int length)
```
    设置content长度。该调用只在setBuffering(false)时有效。
    
    Specified by:
    
    setContentLength in interface javax.servlet.ServletResponse
    
    Overrides:
    
    setContentLength in class javax.servlet.ServletResponseWrapper
    
    Parameters:
    
    length - content长度
  - flushBuffer
```
public void flushBuffer()
                 throws IOException
```
    冲洗buffer。
    
    Specified by:
    
    flushBuffer in interface javax.servlet.ServletResponse
    
    Overrides:
    
    flushBuffer in class javax.servlet.ServletResponseWrapper
    
    Throws:
    
    IOException - 如果失败
  - resetBuffer
```
public void resetBuffer()
```
    清除所有buffers，常用于显示出现异常信息。
    
    Specified by:
    
    resetBuffer in interface javax.servlet.ServletResponse
    
    Overrides:
    
    resetBuffer in class javax.servlet.ServletResponseWrapper
    
    Throws:
    
    IllegalStateException - 如果response已经commit
  - isBuffering
```
public boolean isBuffering()
```
    设置是否将所有信息保存在内存中。
    
    Returns:
    
    如果是，则返回true
  - setBuffering
```
public void setBuffering(boolean buffering)
```
    设置buffer模式，如果设置成true，表示将所有信息保存在内存中，否则直接输出到原始response中。
    此方法必须在getOutputStream和getWriter方法之前执行，否则将抛出 IllegalStateException。
    
    Parameters:
    
    buffering - 是否buffer内容
    
    Throws:
    
    IllegalStateException - getOutputStream或 getWriter方法已经被执行
  - pushBuffer
```
public void pushBuffer()
```
    创建新的buffer，保存老的buffer。
    
    Throws:
    
    IllegalStateException - 如果不在buffer模式，或getWriter 方法曾被调用，或getOutputStream方法从未被调用
  - popByteBuffer
```
public ByteArray popByteBuffer()
```
    弹出最近的buffer，如果堆栈中只有一个buffer，则弹出后再创建一个新的。
    
    Returns:
    
    最近的buffer内容，如果getOutputStream方法从未被调用，则返回空的byte array
    
    Throws:
    
    IllegalStateException - 如果不在buffer模式，或getWriter方法曾被调用
  - peekByteBuffer
```
public ByteArray peekByteBuffer()
```
    返回最上层的ByteArray
    
    Returns:
    
    最近的buffer内容，如果getOutputStream方法从未被调用，则返回空的byte array
    
    Throws:
    
    IllegalStateException - 如果不在buffer模式，或getWriter方法曾被调用
  - popCharBuffer
```
public String popCharBuffer()
```
    弹出最近的buffer，如果堆栈中只有一个buffer，则弹出后再创建一个新的。
    
    Returns:
    
    最近的buffer内容，如果getWriter方法从未被调用，则返回空的字符串
    
    Throws:
    
    IllegalStateException - 如果不在buffer模式，或getOutputStream 方法曾被调用
  - peekCharBuffer
```
public String peekCharBuffer()
```
    返回最上层的buffer
    
    Returns:
    
    最近的buffer内容，如果getWriter方法从未被调用，则返回空的字符串
    
    Throws:
    
    IllegalStateException - 如果不在buffer模式，或getOutputStream 方法曾被调用
  - commitBuffer
```
public void commitBuffer()
                  throws IOException
```
    将buffer中的内容提交到真正的servlet输出流中。
    如果从来没有执行过getOutputStream或getWriter 方法，则该方法不做任何事情。
    
    Throws:
    
    IOException - 如果输入输出失败
    
    IllegalStateException - 如果不是在buffer模式，或buffer栈中不止一个buffer

Class BufferedResponseImpl

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletResponse

Constructor Summary

Method Summary

Methods inherited from class org.tinygroup.weblayer.webcontext.AbstractResponseWrapper

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

Methods inherited from class javax.servlet.ServletResponseWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface javax.servlet.ServletResponse

Constructor Detail

BufferedResponseImpl

Method Detail

getOutputStream

getWriter

setContentLength

flushBuffer

resetBuffer

isBuffering

setBuffering

pushBuffer

popByteBuffer

peekByteBuffer

popCharBuffer

peekCharBuffer

commitBuffer