javax.portlet.filter

Class ResourceResponseWrapper

java.lang.Object

javax.portlet.filter.PortletResponseWrapper

javax.portlet.filter.MimeResponseWrapper

javax.portlet.filter.ResourceResponseWrapper

All Implemented Interfaces:

MimeResponse, PortletResponse, ResourceResponse

public class ResourceResponseWrapper
extends MimeResponseWrapper
implements ResourceResponse

The ResourceResponseWrapper provides a convenient implementation of the ResourceResponse 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:

2.0

See Also:

ResourceResponse

Nested Class Summary

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

MimeResponse.Copy

Field Summary

Fields inherited from interface javax.portlet.ResourceResponse

HTTP_STATUS_CODE

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
ResourceResponseWrapper(ResourceResponse response) Creates an ResourceResponse adaptor wrapping the given response object.

Method Summary

Modifier and Type	Method and Description
ResourceResponse	getResponse() Return the wrapped response object.
int	getStatus() Gets the current HTTP status code for the response.
void	setCharacterEncoding(String charset) Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.
void	setContentLength(int len) Sets the length of the content body in the response.
void	setContentLengthLong(long len) Sets the length of the content body in the response.
void	setLocale(Locale loc) Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate.
void	setResponse(ResourceResponse response) Sets the response object being wrapped.
void	setStatus(int sc) Sets the HTTP status code for this request.

Methods inherited from class javax.portlet.filter.MimeResponseWrapper

createActionURL, createActionURL, createRenderURL, createRenderURL, createResourceURL, flushBuffer, getBufferSize, getCacheControl, getCharacterEncoding, getContentType, getLocale, getPortletOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setContentType, setResponse

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.ResourceResponse

createActionURL, createActionURL, createRenderURL, createRenderURL, createResourceURL

Methods inherited from interface javax.portlet.MimeResponse

flushBuffer, getBufferSize, getCacheControl, getCharacterEncoding, getContentType, getLocale, getPortletOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setContentType

Methods inherited from interface javax.portlet.PortletResponse

addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, getProperty, getPropertyNames, getPropertyValues, setProperty

Constructor Detail

ResourceResponseWrapper

public ResourceResponseWrapper(ResourceResponse response)

Creates an ResourceResponse adaptor wrapping the given response object.

Parameters:

response - the event response to wrap

Throws:

IllegalArgumentException - if the response is null

Method Detail

getResponse

public ResourceResponse getResponse()

Return the wrapped response object.

Overrides:

getResponse in class MimeResponseWrapper

Returns:

the wrapped response

setResponse

public void setResponse(ResourceResponse response)

Sets the response object being wrapped.

Parameters:

response - the response to set

Throws:

IllegalArgumentException - if the response is null.

setCharacterEncoding

public void setCharacterEncoding(String charset)

Description copied from interface: ResourceResponse

Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. If the character encoding has already been set by either the portlet container, setContentType(java.lang.String) or setLocale(java.util.Locale), this method overrides it. Calling setContentType(java.lang.String) with the String of text/html and calling this method with the String of UTF-8 is equivalent with calling setContentType with the String of text/html; charset=UTF-8.

This method can be called repeatedly to change the character encoding. This method has no effect if it is called after getWriter has been called or after the response has been committed.

Specified by:

setCharacterEncoding in interface ResourceResponse

Parameters:

charset - a String specifying only the character set defined by IANA Character Sets (http://www.iana.org/assignments/character-sets)

setLocale

public void setLocale(Locale loc)

Description copied from interface: ResourceResponse

Sets the locale of the response, setting the headers (including the Content-Type's charset) as appropriate. This method should be called before a call to getWriter(). By default, the response locale is the default locale provided by the portlet container.

This method has no effect if it is called after the response has been committed.

Specified by:

setLocale in interface ResourceResponse

Parameters:

loc - the new locale of the response

setContentLength

public void setContentLength(int len)

Description copied from interface: ResourceResponse

Sets the length of the content body in the response.

This method has no effect if it is called after the response has been committed.

Specified by:

setContentLength in interface ResourceResponse

Parameters:

len - an integer specifying the length of the content being returned; sets the Content-Length header

setStatus

public void setStatus(int sc)

Description copied from interface: ResourceResponse

Sets the HTTP status code for this request.

The status code should be a valid value as defined in IETF rfc2616 "Hypertext Transfer Protocol -- HTTP/1.1" . The status code constants "SC_*" defined in HttpServletResponse may be used.

This method has no effect if it is called after the response has been committed.

Specified by:

setStatus in interface ResourceResponse

Parameters:

sc - an integer specifying the status code for this request

See Also:

HttpServletResponse, HttpServletResponse.setStatus(int)

getStatus

public int getStatus()

Description copied from interface: ResourceResponse

Gets the current HTTP status code for the response.

Specified by:

getStatus in interface ResourceResponse

Returns:

The HTTP status code

See Also:

HttpServletResponse, HttpServletResponse.getStatus()

setContentLengthLong

public void setContentLengthLong(long len)

Description copied from interface: ResourceResponse

Sets the length of the content body in the response.

This method has no effect if it is called after the response has been committed.

Specified by:

setContentLengthLong in interface ResourceResponse

Parameters:

len - a long specifying the length of the content being returned; sets the Content-Length header