MimeResponseWrapper (JSR 362 Portlet 3.0 API Specification)

java.lang.Object
- javax.portlet.filter.PortletResponseWrapper
- - javax.portlet.filter.MimeResponseWrapper

All Implemented Interfaces:

MimeResponse, PortletResponse

Direct Known Subclasses:

HeaderResponseWrapper, RenderResponseWrapper, ResourceResponseWrapper
```
public class MimeResponseWrapper
extends PortletResponseWrapper
implements MimeResponse
```
The 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.

Since:

3.0

Nested Class Summary
- Nested classes/interfaces inherited from interface javax.portlet.MimeResponse
  MimeResponse.Copy

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

Constructors
Constructor and Description

MimeResponseWrapper(MimeResponse response)

Constructors
Constructor and Description
`MimeResponseWrapper(MimeResponse response)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends PortletURL & ActionURL> T`	`createActionURL()` Creates an action URL targeting the portlet.
`ActionURL`	`createActionURL(MimeResponse.Copy option)` Creates an action URL targeting the portlet.
`<T extends PortletURL & RenderURL> T`	`createRenderURL()` Creates a render URL targeting the portlet.
`RenderURL`	`createRenderURL(MimeResponse.Copy option)` Creates a render URL targeting the portlet.
`ResourceURL`	`createResourceURL()` Creates a resource URL targeting the portlet.
`void`	`flushBuffer()` Forces any content in the buffer to be written to the underlying output stream.
`int`	`getBufferSize()` Returns the actual buffer size used for the response.
`CacheControl`	`getCacheControl()` Returns the cache control object allowing to set specific cache settings valid for the markup returned in this response.
`String`	`getCharacterEncoding()` Returns the name of the charset used for the MIME body sent in this response.
`String`	`getContentType()` Returns the MIME type that can be used to contribute markup to the render response.
`Locale`	`getLocale()` Returns the locale assigned to the response.
`OutputStream`	`getPortletOutputStream()` Returns a `OutputStream` suitable for writing binary data in the response.
`MimeResponse`	`getResponse()` Return the wrapped response object.
`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(String type)` Sets the MIME type for the response.
`void`	`setResponse(MimeResponse response)` Sets the response object being wrapped.

Methods inherited from class javax.portlet.filter.PortletResponseWrapper
addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, getProperty, getPropertyNames, getPropertyValues, 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, getProperty, getPropertyNames, getPropertyValues, setProperty

- Constructor Detail
  - MimeResponseWrapper
```
public MimeResponseWrapper(MimeResponse response)
```
    Parameters:
    
    response -
- Method Detail
  - getResponse
```
public MimeResponse getResponse()
```
    Return the wrapped response object.
    
    Overrides:
    
    getResponse in class PortletResponseWrapper
    
    Returns:
    
    the wrapped response
  - setResponse
```
public void setResponse(MimeResponse response)
```
    Sets the response object being wrapped.
    
    Parameters:
    
    response - the response to set
    
    Throws:
    
    IllegalArgumentException - if the response is null.
  - flushBuffer
```
public void flushBuffer()
                 throws IOException
```
    Description copied from interface: MimeResponse
    
    Forces any content in the buffer to be written to the underlying output stream. A call to this method automatically commits the response.
    
    Specified by:
    
    flushBuffer in interface MimeResponse
    
    Throws:
    
    IOException - if an error occurred when writing the output
    
    See Also:
    
    MimeResponse.setBufferSize(int), MimeResponse.getBufferSize(), MimeResponse.isCommitted(), MimeResponse.reset()
  - getBufferSize
```
public int getBufferSize()
```
    Description copied from interface: MimeResponse
    
    Returns the actual buffer size used for the response. If no buffering is used, this method returns 0.
    
    Specified by:
    
    getBufferSize in interface MimeResponse
    
    Returns:
    
    the actual buffer size used
    
    See Also:
    
    MimeResponse.setBufferSize(int), MimeResponse.flushBuffer(), MimeResponse.isCommitted(), MimeResponse.reset()
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Description copied from interface: MimeResponse
    
    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.
    
    Specified by:
    
    getCharacterEncoding in interface MimeResponse
    
    Returns:
    
    a String specifying the name of the charset, for example, ISO-8859-1
  - getContentType
```
public String getContentType()
```
    Description copied from interface: MimeResponse
    
    Returns the MIME type that can be used to contribute markup to the render response.
    If no content type was set previously using the MimeResponse.setContentType(java.lang.String) method this method returns null.
    
    Specified by:
    
    getContentType in interface MimeResponse
    
    Returns:
    
    the MIME type of the response, or null if no content type is set
    
    See Also:
    
    MimeResponse.setContentType(java.lang.String)
  - getLocale
```
public Locale getLocale()
```
    Description copied from interface: MimeResponse
    
    Returns the locale assigned to the response.
    
    Specified by:
    
    getLocale in interface MimeResponse
    
    Returns:
    
    Locale of this response
  - getPortletOutputStream
```
public OutputStream getPortletOutputStream()
                                    throws IOException
```
    Description copied from interface: MimeResponse
    
    Returns a 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.
    
    Specified by:
    
    getPortletOutputStream in interface MimeResponse
    
    Returns:
    
    a OutputStream for writing binary data
    
    Throws:
    
    IOException - if an input or output exception occurred
    
    See Also:
    
    MimeResponse.setContentType(java.lang.String), MimeResponse.getWriter()
  - getWriter
```
public PrintWriter getWriter()
                      throws IOException
```
    Description copied from interface: MimeResponse
    
    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 MimeResponse.setContentType(java.lang.String) method.
    Either this method or MimeResponse.getPortletOutputStream() may be called to write the body, not both.
    
    Specified by:
    
    getWriter in interface MimeResponse
    
    Returns:
    
    a PrintWriter object that can return character data to the portal
    
    Throws:
    
    IOException - if an input or output exception occurred
    
    See Also:
    
    MimeResponse.setContentType(java.lang.String), MimeResponse.getPortletOutputStream()
  - isCommitted
```
public boolean isCommitted()
```
    Description copied from interface: MimeResponse
    
    Returns a boolean indicating if the response has been committed.
    
    Specified by:
    
    isCommitted in interface MimeResponse
    
    Returns:
    
    a boolean indicating if the response has been committed
    
    See Also:
    
    MimeResponse.setBufferSize(int), MimeResponse.getBufferSize(), MimeResponse.flushBuffer(), MimeResponse.reset()
  - reset
```
public void reset()
```
    Description copied from interface: MimeResponse
    
    Clears any data that exists in the buffer as well as the properties set. If the response has been committed, this method throws an IllegalStateException.
    
    Specified by:
    
    reset in interface MimeResponse
    
    See Also:
    
    MimeResponse.setBufferSize(int), MimeResponse.getBufferSize(), MimeResponse.flushBuffer(), MimeResponse.isCommitted()
  - resetBuffer
```
public void resetBuffer()
```
    Description copied from interface: MimeResponse
    
    Clears the content of the underlying buffer in the response without clearing properties set. If the response has been committed, this method throws an IllegalStateException.
    
    Specified by:
    
    resetBuffer in interface MimeResponse
    
    See Also:
    
    MimeResponse.setBufferSize(int), MimeResponse.getBufferSize(), MimeResponse.isCommitted(), MimeResponse.reset()
  - setBufferSize
```
public void setBufferSize(int size)
```
    Description copied from interface: MimeResponse
    
    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 IllegalStateException.
    
    Specified by:
    
    setBufferSize in interface MimeResponse
    
    Parameters:
    
    size - the preferred buffer size
    
    See Also:
    
    MimeResponse.getBufferSize(), MimeResponse.flushBuffer(), MimeResponse.isCommitted(), MimeResponse.reset()
  - getCacheControl
```
public CacheControl getCacheControl()
```
    Description copied from interface: MimeResponse
    
    Returns the cache control object allowing to set specific cache settings valid for the markup returned in this response.
    
    Specified by:
    
    getCacheControl in interface MimeResponse
    
    Returns:
    
    Cache control for the current response.
  - createActionURL
```
public <T extends PortletURL & ActionURL> T createActionURL()
                                                     throws IllegalStateException
```
    Description copied from interface: MimeResponse
    
    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 MimeResponse.createRenderURL(Copy) with the parameter set to PUBLIC.
    
    Specified by:
    
    createActionURL in interface MimeResponse
    
    Returns:
    
    a portlet action URL
    
    Throws:
    
    IllegalStateException
  - createActionURL
```
public ActionURL createActionURL(MimeResponse.Copy option)
                          throws IllegalStateException
```
    Description copied from interface: MimeResponse
    
    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 option parameter.
    
    NONE
    
    All public and private parameters are removed from the URL.
    
    ALL
    
    The public and private parameters governing the current request are added to the URL.
    
    PUBLIC
    
    Only public parameters governing the current request are added to the URL.
    
    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.
    
    Specified by:
    
    createActionURL in interface MimeResponse
    
    Parameters:
    
    option - Specifies how current parameters are to be copied to the URL
    
    Returns:
    
    a portlet action URL
    
    Throws:
    
    IllegalStateException
    
    See Also:
    
    MimeResponse.Copy
  - createRenderURL
```
public <T extends PortletURL & RenderURL> T createRenderURL()
                                                     throws IllegalStateException
```
    Description copied from interface: MimeResponse
    
    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 MimeResponse.createRenderURL(Copy) with the parameter set to PUBLIC.
    
    Specified by:
    
    createRenderURL in interface MimeResponse
    
    Returns:
    
    a portlet render URL
    
    Throws:
    
    IllegalStateException
  - createRenderURL
```
public RenderURL createRenderURL(MimeResponse.Copy option)
                          throws IllegalStateException
```
    Description copied from interface: MimeResponse
    
    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 option parameter.
    
    NONE
    
    All public and private parameters are removed from the URL.
    
    ALL
    
    The public and private parameters governing the current request are added to the URL.
    
    PUBLIC
    
    Only public parameters governing the current request are added to the URL.
    
    The URL can be further extended by adding render 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 a render URL, then the public render parameter will be set to the new value or removed when the URL is activated.
    
    Specified by:
    
    createRenderURL in interface MimeResponse
    
    Parameters:
    
    option - Specifies how current parameters are to be copied to the URL
    
    Returns:
    
    a portlet render URL
    
    Throws:
    
    IllegalStateException
    
    See Also:
    
    MimeResponse.Copy
  - createResourceURL
```
public ResourceURL createResourceURL()
                              throws IllegalStateException
```
    Description copied from interface: MimeResponse
    
    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 ResourceURL, it results in a serve resource request of the ResourceServingPortlet interface.
    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 PORTLET or PAGE, the values of the render parameters, portlet mode, and window state are preserved. Otherwise, they will not be preserved.
    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, PAGE is the default.
    
    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, PAGE is the default.
    
    Specified by:
    
    createResourceURL in interface MimeResponse
    
    Returns:
    
    a portlet resource URL
    
    Throws:
    
    IllegalStateException
  - setContentType
```
public void setContentType(String type)
```
    Description copied from interface: MimeResponse
    
    Sets the MIME type for the response. The portlet should set the content type before calling MimeResponse.getWriter() or MimeResponse.getPortletOutputStream(). If the content type is not set using this method, the preferred content type as returned by PortletRequest.getResponseContentType() is used.
    Calling setContentType after getWriter or getOutputStream does not change the content type.
    
    Specified by:
    
    setContentType in interface MimeResponse
    
    Parameters:
    
    type - the content MIME type
    
    See Also:
    
    PortletRequest.getResponseContentTypes(), MimeResponse.getContentType()

Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.

Class MimeResponseWrapper

Nested Class Summary

Nested classes/interfaces inherited from interface javax.portlet.MimeResponse

Field Summary

Fields inherited from interface javax.portlet.MimeResponse

Constructor Summary

Method Summary

Methods inherited from class javax.portlet.filter.PortletResponseWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface javax.portlet.PortletResponse

Constructor Detail

MimeResponseWrapper

Method Detail

getResponse

setResponse

flushBuffer

getBufferSize

getCharacterEncoding

getContentType

getLocale

getPortletOutputStream

getWriter

isCommitted

reset

resetBuffer

setBufferSize

getCacheControl

createActionURL

createActionURL

createRenderURL

createRenderURL

createResourceURL

setContentType