Package com.day.cq.commons.feed

Class StringResponseWrapper

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper

com.day.cq.commons.feed.StringResponseWrapper

All Implemented Interfaces:

HttpServletResponse, ServletResponse, Adaptable, SlingHttpServletResponse

public class StringResponseWrapper
extends SlingHttpServletResponseWrapper

The StringResponseWrapper is a response wrapper providing the response body as a String.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	StringResponseWrapper.AtomFeedOutputStream	The AtomFeedOutputStream allows for deferring the data to another OutputStream.

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	Description
StringResponseWrapper(SlingHttpServletResponse slingHttpServletResponse)	Creates a new StringResponseWrapper using the specified response.

Method Summary

Modifier and Type	Method	Description
ServletOutputStream	getOutputStream()	The default behavior of this method is to return getOutputStream() on the wrapped response object.
java.lang.String	getString()	Returns the response body as a String
java.io.PrintWriter	getWriter()	The default behavior of this method is to return getWriter() on the wrapped response object.

Methods inherited from class org.apache.sling.api.wrappers.SlingHttpServletResponseWrapper

adaptTo, getSlingResponse

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getResponse, isCommitted, isWrapperFor, isWrapperFor, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.http.HttpServletResponse

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getHeader, getHeaderNames, getHeaders, getStatus, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from interface javax.servlet.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentLengthLong, setContentType, setLocale

Constructor Detail

StringResponseWrapper

public StringResponseWrapper(SlingHttpServletResponse slingHttpServletResponse)

Creates a new StringResponseWrapper using the specified response.

Parameters:

slingHttpServletResponse - The response

Method Detail

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws java.io.IOException

The default behavior of this method is to return getOutputStream() on the wrapped response object.

Specified by:

getOutputStream in interface ServletResponse

Overrides:

getOutputStream in class ServletResponseWrapper

Returns:

a ServletOutputStream for writing binary data

Throws:

java.io.IOException - if an input or output exception occurred

See Also:

ServletResponse.getWriter()

getWriter

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

The default behavior of this method is to return getWriter() on the wrapped response object.

Specified by:

getWriter in interface ServletResponse

Overrides:

getWriter in class ServletResponseWrapper

Returns:

a PrintWriter object that can return character data to the client

Throws:

java.io.UnsupportedEncodingException - if the character encoding returned by getCharacterEncoding cannot be used

java.io.IOException - if an input or output exception occurred

See Also:

ServletResponse.getOutputStream(), ServletResponse.setCharacterEncoding(java.lang.String)

getString

public java.lang.String getString()
                           throws java.io.UnsupportedEncodingException

Returns the response body as a String

Returns:

The response body

Throws:

java.io.UnsupportedEncodingException - If the encoding is not supported