org.springframework.security.web.util

Class OnCommittedResponseWrapper

java.lang.Object

HttpServletResponseWrapper

org.springframework.security.web.util.OnCommittedResponseWrapper

Direct Known Subclasses:

SaveContextOnUpdateOrErrorResponseWrapper

public abstract class OnCommittedResponseWrapper
extends HttpServletResponseWrapper

Base class for response wrappers which encapsulate the logic for handling an event when the javax.servlet.http.HttpServletResponse is committed.

Since:

4.0.2

Constructor Summary

Constructors

Constructor and Description
OnCommittedResponseWrapper(HttpServletResponse response)

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String name, java.lang.String value)
protected void	disableOnResponseCommitted() Invoke this method to disable invoking onResponseCommitted() when the javax.servlet.http.HttpServletResponse is committed.
void	flushBuffer() Makes sure onResponseCommitted() is invoked before calling the superclass flushBuffer()
ServletOutputStream	getOutputStream() Makes sure onResponseCommitted() is invoked before calling the calling getOutputStream().close() or getOutputStream().flush()
java.io.PrintWriter	getWriter() Makes sure onResponseCommitted() is invoked before calling the getWriter().close() or getWriter().flush()
protected boolean	isDisableOnResponseCommitted() Returns true if onResponseCommitted() will be invoked when the response is committed, else false.
protected abstract void	onResponseCommitted() Implement the logic for handling the javax.servlet.http.HttpServletResponse being committed
void	sendError(int sc) Makes sure onResponseCommitted() is invoked before calling the superclass sendError()
void	sendError(int sc, java.lang.String msg) Makes sure onResponseCommitted() is invoked before calling the superclass sendError()
void	sendRedirect(java.lang.String location) Makes sure onResponseCommitted() is invoked before calling the superclass sendRedirect()
void	setContentLength(int len)

Methods inherited from class java.lang.Object

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

Constructor Detail

OnCommittedResponseWrapper

public OnCommittedResponseWrapper(HttpServletResponse response)

Parameters:

response - the response to be wrapped

Method Detail

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

setContentLength

public void setContentLength(int len)

disableOnResponseCommitted

protected void disableOnResponseCommitted()

Invoke this method to disable invoking onResponseCommitted() when the javax.servlet.http.HttpServletResponse is committed. This can be useful in the event that Async Web Requests are made.

isDisableOnResponseCommitted

protected boolean isDisableOnResponseCommitted()

Returns true if onResponseCommitted() will be invoked when the response is committed, else false.

Returns:

if onResponseCommitted() is enabled

onResponseCommitted

protected abstract void onResponseCommitted()

Implement the logic for handling the javax.servlet.http.HttpServletResponse being committed

sendError

public final void sendError(int sc)
                     throws java.io.IOException

Makes sure onResponseCommitted() is invoked before calling the superclass sendError()

Throws:

java.io.IOException

sendError

public final void sendError(int sc,
                            java.lang.String msg)
                     throws java.io.IOException

Makes sure onResponseCommitted() is invoked before calling the superclass sendError()

Throws:

java.io.IOException

sendRedirect

public final void sendRedirect(java.lang.String location)
                        throws java.io.IOException

Makes sure onResponseCommitted() is invoked before calling the superclass sendRedirect()

Throws:

java.io.IOException

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws java.io.IOException

Makes sure onResponseCommitted() is invoked before calling the calling getOutputStream().close() or getOutputStream().flush()

Throws:

java.io.IOException

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException

Makes sure onResponseCommitted() is invoked before calling the getWriter().close() or getWriter().flush()

Throws:

java.io.IOException

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Makes sure onResponseCommitted() is invoked before calling the superclass flushBuffer()

Throws:

java.io.IOException