MimeResponseWrapper provides
a convenient implementation of the MimeResponse interface that
can be subclassed by developers. This class
implements the Wrapper or Decorator pattern. Methods default to calling
through to the wrapped response object. | Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public <T extends PortletURL & ActionURL> T | createActionURL()
Implements javax.
Creates an action URL targeting the portlet.
|
| public ActionURL | createActionURL(MimeResponse.
Specifies how current parameters are to be copied to the URL optionImplements javax.
Creates an action URL targeting the portlet.
|
| public <T extends PortletURL & RenderURL> T | createRenderURL()
Implements javax.
Creates a render URL targeting the portlet.
|
| public RenderURL | createRenderURL(MimeResponse.
Specifies how current parameters are to be copied to the URL optionImplements javax.
Creates a render URL targeting the portlet.
|
| public ResourceURL | createResourceURL()
Implements javax.
Creates a resource URL targeting the portlet.
|
| public void | flushBuffer()
Implements javax. |
| public int | getBufferSize()
Implements javax. |
| public CacheControl | getCacheControl()
Implements javax. |
| public String | getCharacterEncoding()
Implements javax. |
| public String | getContentType()
Implements javax. |
| public Locale | getLocale()
Implements javax. |
| public OutputStream | getPortletOutputStream()
Implements javax. OutputStream suitable for writing binary data in
the response.
|
| public MimeResponse | Returns: the wrapped responseOverrides javax. |
| public PrintWriter | getWriter()
Implements javax. |
| public boolean | isCommitted()
Implements javax. |
| public void | reset()
Implements javax. |
| public void | resetBuffer()
Implements javax. |
| public void | setBufferSize(int
the preferred buffer size size)Implements javax. |
| public void | setContentType(String
the content MIME type type)Implements javax. |
| public void |
| MimeResponseWrapper | back to summary |
|---|---|
| public MimeResponseWrapper(MimeResponse response) | |
| createActionURL | back to summary |
|---|---|
| public <T extends PortletURL & ActionURL> T createActionURL() throws IllegalStateException Implements javax. Doc from javax.
Creates an action URL targeting the portlet.
Action URLs are used to create forms or links that, when triggered,
update the render state in a non-idempotent manner.
If a request is triggered by the URL, it results in an action request. The returned action URL will not contain any private render parameters per default not contain any parameters from the current request. The returned URL can be further extended by adding portlet-specific action parameters, portlet mode, and window state. If no additional portlet mode, window state or security modifier is set on the URL, the values from the current render or resource request are preserved. Public render parameters do not need to be explicitly added to the returned action URL, unless the public render parameter value is to be changed. Any public render parameters associated with the portlet will automatically be available during action request processing resulting from activation of the URL. If a public render parameter value is set or removed on an action URL, then the public render parameter will be set to the new value or removed when the URL is activated.
The effect of this method is the same as calling
| |
| createActionURL | back to summary |
|---|---|
| public ActionURL createActionURL(MimeResponse. Implements javax. Doc from javax.
Creates an action URL targeting the portlet.
Action URLs are used to create forms or links that, when triggered,
update the render state in a non-idempotent manner.
If a request is triggered by the URL, it results in an action request.
The new action URL will contain render parameters from the
current request as specified by the
The returned URL can be further extended by adding action parameters, portlet mode, and window state. If no additional portlet mode, window state or security modifier is set on the URL, the values from the current render or resource request are preserved. If a public render parameter value is set or removed on an action URL, then the public render parameter will be set to the new value or removed when the URL is activated.
| |
| createRenderURL | back to summary |
|---|---|
| public <T extends PortletURL & RenderURL> T createRenderURL() throws IllegalStateException Implements javax. Doc from javax.
Creates a render URL targeting the portlet.
Render URLs cause idempotent requests that move the portlet to a
new view state, for example, to view a different page of data.
If a request is triggered by the URL, it results in a render request. The returned render URL will not contain any private render parameters from the current request. The created URL will per default not contain any parameters of the current render request. The returned URL can be further extended by adding portlet-specific render parameters, portlet mode, and window state. If no portlet mode, window state or security modifier is set on the URL, the values from the current render or resource request are preserved.
Public render parameters do not need to be explicitly added to the returned
render URL, unless the public render parameter value is to be changed.
Any public render parameters associated with
the portlet will automatically be available during render request processing resulting
from activation of the URL.
If a public render parameter value is set or removed on a render URL, then the public render parameter will be set to the new value or removed when the URL is activated.
The effect of this method is the same as calling
| |
| createRenderURL | back to summary |
|---|---|
| public RenderURL createRenderURL(MimeResponse. Implements javax. Doc from javax.
Creates a render URL targeting the portlet.
Render URLs cause idempotent requests that move the portlet to a
new view state, for example, to view a different page of data.
If a request is triggered by the URL, it results in a render request.
The new render URL will contain render parameters from the
current request as specified by the
If a public render parameter value is set or removed on a render URL, then the public render parameter will be set to the new value or removed when the URL is activated.
| |
| createResourceURL | back to summary |
|---|---|
| public ResourceURL createResourceURL() throws IllegalStateException Implements javax. Doc from javax.
Creates a resource URL targeting the portlet.
Resource URLs are used to trigger requests for content that applies
to the current portlet view state.
If a request is triggered by the The security settings can be changed for the URL. If the security settings are not explicitly set, the values governing the current request are preserved. The current render parameters, portlet mode, and window state are preserved depending on the cacheability setting for the returned resource URL.
If cacheability is set to If allowed by the cacheability setting, public and private render parameters are added to the URL with their current values. The render parameter values cannot be changed on the URL. The URL can be further extended by adding portlet-specific resource parameters.
The URL will contain the current
cacheability setting of the parent resource by default.
If no parent resource is available,
If a request is triggered by the PortletURL, it results in a serve
resource request of the
ResourceServingPortlet interface.
The returned URL can be further extended by adding portlet-specific parameters .
The created URL will by default contain the current
cacheability setting of the parent resource.
If no parent resource is available,
| |
| flushBuffer | back to summary |
|---|---|
| public void flushBuffer() throws IOException Implements javax. Doc from javax. Forces any content in the buffer to be written to the underlying output stream. A call to this method automatically commits the response.
| |
| getBufferSize | back to summary |
|---|---|
| public int getBufferSize() Implements javax. Doc from javax. Returns the actual buffer size used for the response. If no buffering is used, this method returns 0.
| |
| getCacheControl | back to summary |
|---|---|
| public CacheControl getCacheControl() Implements javax. Doc from javax. Returns the cache control object allowing to set specific cache settings valid for the markup returned in this response.
| |
| getCharacterEncoding | back to summary |
|---|---|
| public String getCharacterEncoding() Implements javax. Doc from javax. Returns the name of the charset used for the MIME body sent in this response. See RFC 2047 for more information about character encoding and MIME. | |
| getContentType | back to summary |
|---|---|
| public String getContentType() Implements javax. Doc from javax. Returns the MIME type that can be used to contribute markup to the render response.
If no content type was set previously using the | |
| getLocale | back to summary |
|---|---|
| public Locale getLocale() Implements javax. Doc from javax. Returns the locale assigned to the response. | |
| getPortletOutputStream | back to summary |
|---|---|
| public OutputStream getPortletOutputStream() throws IOException Implements javax. Doc from javax. Returns a
Before calling this method the content type of the render response must
be set using the
Calling
Either this method or
| |
| getResponse | back to summary |
|---|---|
| public MimeResponse getResponse() Overrides javax. Return the wrapped response object.
| |
| getWriter | back to summary |
|---|---|
| public PrintWriter getWriter() throws IOException Implements javax. Doc from javax. Returns a PrintWriter object that can send character text to the portal.
Before calling this method the content type of the render response should
be set using the
Either this method or
| |
| isCommitted | back to summary |
|---|---|
| public boolean isCommitted() Implements javax. Doc from javax. Returns a boolean indicating if the response has been committed.
| |
| reset | back to summary |
|---|---|
| public void reset() Implements javax. Doc from javax. Clears any data that exists in the buffer as well as the properties set.
If the response has been committed, this method throws an
| |
| resetBuffer | back to summary |
|---|---|
| public void resetBuffer() Implements javax. Doc from javax. Clears the content of the underlying buffer in the response without
clearing properties set. If the response has been committed, this method
throws an
| |
| setBufferSize | back to summary |
|---|---|
| public void setBufferSize(int size) Implements javax. Doc from javax. Sets the preferred buffer size for the body of the response. The portlet container will use a buffer at least as large as the size requested.
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
| |
| setContentType | back to summary |
|---|---|
| public void setContentType(String type) Implements javax. Doc from javax. Sets
the MIME type for the response. The portlet should set the
content type before calling
Calling
| |
| setResponse | back to summary |
|---|---|
| public void setResponse(MimeResponse response) Sets the response object being wrapped.
| |