|
Portlet API (V0.7.1) | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The RenderResponse
defines an object to assist a portlet in
sending a response to the portal. The portlet container creates a RenderResponse
object and passes it as an argument to the render method of the portlet.
See the Internet RFCs such as RFC 2045 for more information on MIME.
RenderRequest
,
PortletResponse
Field Summary | |
static java.lang.String |
EXPIRATION_CACHE
Property to set the expiration time in seconds for this response using the setProperty method. |
Method Summary | |
PortletURL |
createActionURL()
Creates a portlet URL pointing to the current portlet mode and current window state, triggering an action request and a render request. |
PortletURL |
createRenderURL()
Creates a portlet URL pointing to the current portlet mode and current window state, triggering a render call. |
java.lang.String |
encodeNamespace(java.lang.String aValue)
Maps the given string value into this portlet namespace and therefore ensures the uniqueness of the string value in the whole portal page. |
void |
flushBuffer()
Forces any content in the buffer to be written to the client. |
int |
getBufferSize()
Returns the actual buffer size used for the response. |
java.lang.String |
getCharacterEncoding()
Returns the name of the charset used for the MIME body sent in this response. |
java.lang.String |
getContentType()
Returns the MIME type that can be used to contribute markup to the render response. |
java.util.Locale |
getLocale()
Returns the locale assigned to the response. |
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. |
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 |
setBufferSize(int size)
Sets the preferred buffer size for the body of the response. |
void |
setContentType(java.lang.String type)
Sets the MIME type for the render response. |
void |
setTitle(java.lang.String title)
This method can be called to set the title of a portlet. |
Methods inherited from interface javax.portlet.PortletResponse |
addProperty, encodeURL, setProperty |
Field Detail |
public static final java.lang.String EXPIRATION_CACHE
setProperty
method.
If the expiration value is set to 0, caching is disabled for this portlet; if the value is set to -1, the cache does not expire.
The value is "portlet.expiration-cache"
.
Method Detail |
public java.lang.String getContentType()
If no content type was set previously using the setContentType(java.lang.String)
method
this method retuns null
.
null
if no content type is setsetContentType(java.lang.String)
public PortletURL createRenderURL()
The created URL will per default not contain any parameters of the current render request.
public PortletURL createActionURL()
The created URL will per default not contain any parameters of the current render request.
public java.lang.String encodeNamespace(java.lang.String aValue)
If the string passed to the encodeNamespace
method
must be a valid identifier as defined in the 3.8 Identifier Section
of the Java Language Specification Second Edition, the returned
string is also a valid identifier.
If null
is passed as value this method
returns the portlet namespace.
aValue
- the name to be mappedpublic void setTitle(java.lang.String title)
The value can be either a text String or a resource URI.
title
- portlet title as text String or resource URIpublic void setContentType(java.lang.String type)
getWriter()
or
getPortletOutputStream()
.
Calling setContentType
after getWriter
or getOutputStream
does not change the content type.
type
- the content MIME typejava.lang.IllegalArgumentException
- if the given type is not in the list returned
by PortletRequest.getResponseContentTypes
PortletRequest.getResponseContentTypes()
,
getContentType()
public java.lang.String getCharacterEncoding()
See RFC 2047 (http://ds.internic.net/rfc/rfc2045.txt) for more information about character encoding and MIME.
String
specifying the
name of the charset, for
example, ISO-8859-1
public java.io.PrintWriter getWriter() throws java.io.IOException
Before calling this method the content type of the
render response must be set using the setContentType(java.lang.String)
method.
Either this method or getPortletOutputStream()
may be
called to write the body, not both.
PrintWriter
object that
can return character data to the portaljava.io.IOException
- if an input or output exception occurredjava.lang.IllegalStateException
- if the getPortletOutputStream
method
has been called on this response,
or if no content type was set using the
setContentType
method.setContentType(java.lang.String)
,
getPortletOutputStream()
public java.util.Locale getLocale()
public void setBufferSize(int size)
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 throws an
IllegalStateException
.
size
- the preferred buffer sizejava.lang.IllegalStateException
- if this method is called after
content has been written, or the
portlet container does not support bufferinggetBufferSize()
,
flushBuffer()
,
isCommitted()
,
reset()
public int getBufferSize()
Depending on the portlet container implementation the buffer may be shared by serveral portlets.
setBufferSize(int)
,
flushBuffer()
,
isCommitted()
,
reset()
public void flushBuffer() throws java.io.IOException
java.io.IOException
- if an error occured when writing the outputsetBufferSize(int)
,
getBufferSize()
,
isCommitted()
,
reset()
public void resetBuffer()
IllegalStateException
.IllegalStateException
- if this method is called after
response is comittedsetBufferSize(int)
,
getBufferSize()
,
isCommitted()
,
reset()
public boolean isCommitted()
setBufferSize(int)
,
getBufferSize()
,
flushBuffer()
,
reset()
public void reset()
IllegalStateException
.java.lang.IllegalStateException
- if the response has already been
committedsetBufferSize(int)
,
getBufferSize()
,
flushBuffer()
,
isCommitted()
public java.io.OutputStream getPortletOutputStream() throws java.io.IOException
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 setContentType(java.lang.String)
method.
Calling flush()
on the OutputStream commits the response.
Either this method or getWriter()
may be called to write the body, not both.
OutputStream
for writing binary datajava.lang.IllegalStateException
- if the getWriter
method
has been called on this response, or
if no content type was set using the
setContentType
method.java.io.IOException
- if an input or output exception occurredsetContentType(java.lang.String)
,
getWriter()
|
Portlet API (V0.7.1) | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |