|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.ServletResponseWrapper
javax.servlet.http.HttpServletResponseWrapper
org.apache.pluto.internal.impl.PortletResponseImpl
org.apache.pluto.internal.impl.MimeResponseImpl
public class MimeResponseImpl
Field Summary |
---|
Fields inherited from interface javax.portlet.MimeResponse |
---|
CACHE_SCOPE, ETAG, EXPIRATION_CACHE, MARKUP_HEAD_ELEMENT, NAMESPACED_RESPONSE, PRIVATE_SCOPE, PUBLIC_SCOPE, USE_CACHED_CONTENT |
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 | |
---|---|
MimeResponseImpl(PortletContainer container,
InternalPortletWindow internalPortletWindow,
javax.servlet.http.HttpServletRequest servletRequest,
javax.servlet.http.HttpServletResponse servletResponse)
|
Method Summary | |
---|---|
void |
addDateHeader(java.lang.String arg0,
long arg1)
|
void |
addHeader(java.lang.String arg0,
java.lang.String arg1)
|
void |
addIntHeader(java.lang.String arg0,
int arg1)
|
void |
flushBuffer()
Forces any content in the buffer to be written to the underlying output stream. |
CacheControl |
getCacheControl()
Returns the cache control object allowing to set specific cache settings valid for the markup returned in this response. |
java.lang.String |
getCharacterEncoding()
Returns the name of the charset used for the MIME body sent in this response. |
java.util.Locale |
getLocale()
Returns the locale assigned to the response. |
javax.servlet.ServletOutputStream |
getOutputStream()
TODO: javadoc about why we are using a wrapped writer here. |
java.io.OutputStream |
getPortletOutputStream()
Returns a OutputStream suitable for writing binary data in
the response. |
java.io.PrintWriter |
getWriter()
Returns a PrintWriter object that can send character text to the portal. |
boolean |
isCommitted()
Returns a boolean indicating if the response has been committed. |
protected boolean |
isValidContentType(java.lang.String contentType)
Checks if the specified content type is valid (supported by the portlet). |
void |
reset()
Clears any data that exists in the buffer as well as the properties set. |
void |
resetBuffer()
Clears the content of the underlying buffer in the response without clearing properties set. |
void |
sendRedirect(java.lang.String arg0)
|
void |
setBufferSize(int size)
Sets the preferred buffer size for the body of the response. |
void |
setDateHeader(java.lang.String arg0,
long arg1)
|
void |
setHeader(java.lang.String arg0,
java.lang.String arg1)
|
void |
setIntHeader(java.lang.String arg0,
int arg1)
|
void |
setStatus(int arg0)
|
void |
setStatus(int arg0,
java.lang.String arg1)
|
Methods inherited from class org.apache.pluto.internal.impl.PortletResponseImpl |
---|
addCookie, addProperty, addProperty, addProperty, addProperty, containsHeader, createActionURL, createElement, createRenderURL, createResourceURL, createResourceURL, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, getContainer, getHttpServletRequest, getHttpServletResponse, getInternalPortletWindow, getNamespace, isForwarded, isIncluded, sendError, sendError, setForwarded, setIncluded, setProperty |
Methods inherited from class javax.servlet.ServletResponseWrapper |
---|
getBufferSize, getContentType, getResponse, setCharacterEncoding, setContentLength, setContentType, setLocale, setResponse |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.portlet.MimeResponse |
---|
addProperty, createActionURL, createRenderURL, createResourceURL, getBufferSize, getContentType, setContentType |
Methods inherited from interface javax.portlet.PortletResponse |
---|
addProperty, addProperty, createElement, encodeURL, getNamespace, setProperty |
Methods inherited from interface javax.servlet.ServletResponse |
---|
getBufferSize, getContentType, setCharacterEncoding, setContentLength, setContentType, setLocale |
Constructor Detail |
---|
public MimeResponseImpl(PortletContainer container, InternalPortletWindow internalPortletWindow, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse)
Method Detail |
---|
public void flushBuffer() throws java.io.IOException
MimeResponse
flushBuffer
in interface MimeResponse
flushBuffer
in interface javax.servlet.ServletResponse
flushBuffer
in class javax.servlet.ServletResponseWrapper
java.io.IOException
- if an error occurred when writing the outputMimeResponse.setBufferSize(int)
,
MimeResponse.getBufferSize()
,
MimeResponse.isCommitted()
,
MimeResponse.reset()
public CacheControl getCacheControl()
MimeResponse
getCacheControl
in interface MimeResponse
public java.lang.String getCharacterEncoding()
MimeResponse
See RFC 2047 for more information about character encoding and MIME.
getCharacterEncoding
in interface MimeResponse
getCharacterEncoding
in interface javax.servlet.ServletResponse
getCharacterEncoding
in class javax.servlet.ServletResponseWrapper
String
specifying the name of the charset, for
example, ISO-8859-1
public java.util.Locale getLocale()
MimeResponse
getLocale
in interface MimeResponse
getLocale
in interface javax.servlet.ServletResponse
getLocale
in class javax.servlet.ServletResponseWrapper
public java.io.OutputStream getPortletOutputStream() throws java.io.IOException
MimeResponse
OutputStream
suitable for writing binary data in
the response. The portlet container does not encode the binary data.
Before calling this method the content type of the render response must
be set using the MimeResponse.setContentType(java.lang.String)
method.
Calling flush()
on the OutputStream commits the response.
Either this method or MimeResponse.getWriter()
may be called to write the body,
not both.
getPortletOutputStream
in interface MimeResponse
OutputStream
for writing binary data
java.io.IOException
- if an input or output exception occurredPortletResponseImpl.getOutputStream()
,
getWriter()
public java.io.PrintWriter getWriter() throws java.io.IOException, java.lang.IllegalStateException
MimeResponse
Before calling this method the content type of the render response must
be set using the MimeResponse.setContentType(java.lang.String)
method.
Either this method or MimeResponse.getPortletOutputStream()
may be called to
write the body, not both.
getWriter
in interface MimeResponse
getWriter
in interface javax.servlet.ServletResponse
getWriter
in class PortletResponseImpl
PrintWriter
object that can return character
data to the portal
java.io.IOException
- if an input or output exception occurred
java.lang.IllegalStateException
- if the getPortletOutputStream
method has
been called on this response, or if no content type was
set using the setContentType
method.PortletResponseImpl.getWriter()
,
getPortletOutputStream()
public boolean isCommitted()
MimeResponse
isCommitted
in interface MimeResponse
isCommitted
in interface javax.servlet.ServletResponse
isCommitted
in class javax.servlet.ServletResponseWrapper
MimeResponse.setBufferSize(int)
,
MimeResponse.getBufferSize()
,
MimeResponse.flushBuffer()
,
MimeResponse.reset()
public void reset()
MimeResponse
IllegalStateException
.
reset
in interface MimeResponse
reset
in interface javax.servlet.ServletResponse
reset
in class javax.servlet.ServletResponseWrapper
MimeResponse.setBufferSize(int)
,
MimeResponse.getBufferSize()
,
MimeResponse.flushBuffer()
,
MimeResponse.isCommitted()
public void resetBuffer()
MimeResponse
IllegalStateException
.
resetBuffer
in interface MimeResponse
resetBuffer
in interface javax.servlet.ServletResponse
resetBuffer
in class javax.servlet.ServletResponseWrapper
MimeResponse.setBufferSize(int)
,
MimeResponse.getBufferSize()
,
MimeResponse.isCommitted()
,
MimeResponse.reset()
public void setBufferSize(int size)
MimeResponse
This method must be called before any response body content is written;
if content has been written, or the portlet container does not support
buffering, this method may throw an IllegalStateException
.
setBufferSize
in interface MimeResponse
setBufferSize
in interface javax.servlet.ServletResponse
setBufferSize
in class javax.servlet.ServletResponseWrapper
size
- the preferred buffer sizeMimeResponse.getBufferSize()
,
MimeResponse.flushBuffer()
,
MimeResponse.isCommitted()
,
MimeResponse.reset()
public void addDateHeader(java.lang.String arg0, long arg1)
addDateHeader
in interface javax.servlet.http.HttpServletResponse
addDateHeader
in class javax.servlet.http.HttpServletResponseWrapper
public void addHeader(java.lang.String arg0, java.lang.String arg1)
addHeader
in interface javax.servlet.http.HttpServletResponse
addHeader
in class javax.servlet.http.HttpServletResponseWrapper
public void addIntHeader(java.lang.String arg0, int arg1)
addIntHeader
in interface javax.servlet.http.HttpServletResponse
addIntHeader
in class javax.servlet.http.HttpServletResponseWrapper
public javax.servlet.ServletOutputStream getOutputStream() throws java.lang.IllegalStateException, java.io.IOException
PortletResponseImpl
getOutputStream
in interface javax.servlet.ServletResponse
getOutputStream
in class PortletResponseImpl
java.lang.IllegalStateException
java.io.IOException
PrintWriterServletOutputStream
public void sendRedirect(java.lang.String arg0) throws java.io.IOException
sendRedirect
in interface javax.servlet.http.HttpServletResponse
sendRedirect
in class javax.servlet.http.HttpServletResponseWrapper
java.io.IOException
public void setDateHeader(java.lang.String arg0, long arg1)
setDateHeader
in interface javax.servlet.http.HttpServletResponse
setDateHeader
in class javax.servlet.http.HttpServletResponseWrapper
public void setHeader(java.lang.String arg0, java.lang.String arg1)
setHeader
in interface javax.servlet.http.HttpServletResponse
setHeader
in class javax.servlet.http.HttpServletResponseWrapper
public void setIntHeader(java.lang.String arg0, int arg1)
setIntHeader
in interface javax.servlet.http.HttpServletResponse
setIntHeader
in class javax.servlet.http.HttpServletResponseWrapper
public void setStatus(int arg0, java.lang.String arg1)
setStatus
in interface javax.servlet.http.HttpServletResponse
setStatus
in class javax.servlet.http.HttpServletResponseWrapper
public void setStatus(int arg0)
setStatus
in interface javax.servlet.http.HttpServletResponse
setStatus
in class javax.servlet.http.HttpServletResponseWrapper
protected boolean isValidContentType(java.lang.String contentType)
contentType
- the content type to check.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |