|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.portlet.filter.PortletResponseWrapper javax.portlet.filter.RenderResponseWrapper
public class RenderResponseWrapper
The RenderResponseWrapper
provides a convenient
implementation of the RenderResponse
interface
that can be subclassed by developers wishing to adapt the response.
This class implements the Wrapper or Decorator pattern.
Methods default to calling through to the wrapped response object.
RenderResponse
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 |
Constructor Summary | |
---|---|
RenderResponseWrapper(RenderResponse response)
Creates an RenderResponse adaptor
wrapping the given response object. |
Method Summary | |
---|---|
PortletURL |
createActionURL()
The default behavior of this method is to call createActionURL() on the wrapped response object. |
PortletURL |
createRenderURL()
The default behavior of this method is to call createRenderURL() on the wrapped response object. |
ResourceURL |
createResourceURL()
The default behavior of this method is to call createResourceURL() on the wrapped response object. |
void |
flushBuffer()
The default behavior of this method is to call flushBuffer() on the wrapped response object. |
int |
getBufferSize()
The default behavior of this method is to call getBufferSize() on the wrapped response object. |
CacheControl |
getCacheControl()
The default behavior of this method is to call getCacheControl() on the wrapped response object. |
String |
getCharacterEncoding()
The default behavior of this method is to call getCharacterEncoding() on the wrapped response object. |
String |
getContentType()
The default behavior of this method is to call getContentType() on the wrapped response object. |
Locale |
getLocale()
The default behavior of this method is to call getLocale() on the wrapped response object. |
OutputStream |
getPortletOutputStream()
The default behavior of this method is to call getPortletOutputStream() on the wrapped response object. |
RenderResponse |
getResponse()
Return the wrapped response object. |
PrintWriter |
getWriter()
The default behavior of this method is to call getWriter() on the wrapped response object. |
boolean |
isCommitted()
The default behavior of this method is to call isCommitted() on the wrapped response object. |
void |
reset()
The default behavior of this method is to call reset() on the wrapped response object. |
void |
resetBuffer()
The default behavior of this method is to call resetBuffer() on the wrapped response object. |
void |
setBufferSize(int size)
The default behavior of this method is to call setBufferSize(size) on the wrapped response object. |
void |
setContentType(String type)
The default behavior of this method is to call setContentType(type) on the wrapped response object. |
void |
setNextPossiblePortletModes(Collection<PortletMode> portletModes)
The default behavior of this method is to call setNextPossiblePortletModes() on the wrapped response object. |
void |
setResponse(RenderResponse response)
Sets the response object being wrapped. |
void |
setTitle(String title)
The default behavior of this method is to call setTitle(title) on the wrapped response object. |
Methods inherited from class javax.portlet.filter.PortletResponseWrapper |
---|
addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, setProperty, 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.PortletResponse |
---|
addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, setProperty |
Constructor Detail |
---|
public RenderResponseWrapper(RenderResponse response)
RenderResponse
adaptor
wrapping the given response object.
response
- the event response to wrap
IllegalArgumentException
- if the response is null
Method Detail |
---|
public void flushBuffer() throws IOException
flushBuffer()
on the wrapped response object.
flushBuffer
in interface MimeResponse
IOException
- if an error occurred when writing the outputMimeResponse.setBufferSize(int)
,
MimeResponse.getBufferSize()
,
MimeResponse.isCommitted()
,
MimeResponse.reset()
public int getBufferSize()
getBufferSize()
on the wrapped response object.
getBufferSize
in interface MimeResponse
MimeResponse.setBufferSize(int)
,
MimeResponse.flushBuffer()
,
MimeResponse.isCommitted()
,
MimeResponse.reset()
public String getCharacterEncoding()
getCharacterEncoding()
on the wrapped response object.
getCharacterEncoding
in interface MimeResponse
String
specifying the name of the charset, for
example, ISO-8859-1
public String getContentType()
getContentType()
on the wrapped response object.
getContentType
in interface MimeResponse
null
if no
content type is setMimeResponse.setContentType(java.lang.String)
public Locale getLocale()
getLocale()
on the wrapped response object.
getLocale
in interface MimeResponse
public OutputStream getPortletOutputStream() throws IOException
getPortletOutputStream()
on the wrapped response object.
getPortletOutputStream
in interface MimeResponse
OutputStream
for writing binary data
IOException
- if an input or output exception occurredMimeResponse.setContentType(java.lang.String)
,
MimeResponse.getWriter()
public PrintWriter getWriter() throws IOException
getWriter()
on the wrapped response object.
getWriter
in interface MimeResponse
PrintWriter
object that can return character
data to the portal
IOException
- if an input or output exception occurredMimeResponse.setContentType(java.lang.String)
,
MimeResponse.getPortletOutputStream()
public boolean isCommitted()
isCommitted()
on the wrapped response object.
isCommitted
in interface MimeResponse
MimeResponse.setBufferSize(int)
,
MimeResponse.getBufferSize()
,
MimeResponse.flushBuffer()
,
MimeResponse.reset()
public void reset()
reset()
on the wrapped response object.
reset
in interface MimeResponse
MimeResponse.setBufferSize(int)
,
MimeResponse.getBufferSize()
,
MimeResponse.flushBuffer()
,
MimeResponse.isCommitted()
public void resetBuffer()
resetBuffer()
on the wrapped response object.
resetBuffer
in interface MimeResponse
MimeResponse.setBufferSize(int)
,
MimeResponse.getBufferSize()
,
MimeResponse.isCommitted()
,
MimeResponse.reset()
public void setBufferSize(int size)
setBufferSize(size)
on the wrapped response object.
setBufferSize
in interface MimeResponse
size
- the preferred buffer sizeMimeResponse.getBufferSize()
,
MimeResponse.flushBuffer()
,
MimeResponse.isCommitted()
,
MimeResponse.reset()
public void setContentType(String type)
setContentType(type)
on the wrapped response object.
setContentType
in interface MimeResponse
setContentType
in interface RenderResponse
type
- the content MIME typePortletRequest.getResponseContentTypes()
,
MimeResponse.getContentType()
public void setTitle(String title)
setTitle(title)
on the wrapped response object.
setTitle
in interface RenderResponse
title
- portlet title as text String or resource URIpublic CacheControl getCacheControl()
getCacheControl()
on the wrapped response object.
getCacheControl
in interface MimeResponse
public void setNextPossiblePortletModes(Collection<PortletMode> portletModes)
setNextPossiblePortletModes()
on the wrapped response object.
setNextPossiblePortletModes
in interface RenderResponse
portletModes
- Enumeration
of PortletMode
objects with the
next possible portlet modes that the make sense from the
portlet point of view, must not be null
or an
empty enumeration.public RenderResponse getResponse()
getResponse
in class PortletResponseWrapper
public void setResponse(RenderResponse response)
response
- the response to set
IllegalArgumentException
- if the response is null.public PortletURL createActionURL() throws IllegalStateException
createActionURL()
on the wrapped response object.
createActionURL
in interface MimeResponse
IllegalStateException
public PortletURL createRenderURL() throws IllegalStateException
createRenderURL()
on the wrapped response object.
createRenderURL
in interface MimeResponse
IllegalStateException
public ResourceURL createResourceURL() throws IllegalStateException
createResourceURL()
on the wrapped response object.
createResourceURL
in interface MimeResponse
IllegalStateException
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |