Java Portlet API V3.0 3.0.1 · javax.portlet.filter.RenderRequestWrapper

The RenderRequestWrapper provides a convenient implementation of the RenderRequest interface that can be subclassed by developers. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.

Constructor Summary

Access	Constructor and Description
public	RenderRequestWrapper(RenderRequest the render request to wrap request) Creates an `RenderRequest` adaptor wrapping the given request object.

Method Summary

Modifier and Type	Method and Description
public String	getETag() Implements javax.portlet.RenderRequest.getETag. Returns the validation tag if the portlet container has a cached response for this validation tag, or `null` if no cached response exists.
public RenderRequest	Returns: the wrapped request getRequest() Overrides javax.portlet.filter.PortletRequestWrapper.getRequest. Return the wrapped request object.
public void	setRequest(RenderRequest the request to set request) Sets the request object being wrapped.

Constructor Detail

RenderRequestWrapper back to summary

RenderRequestWrapper	back to summary
public RenderRequestWrapper(RenderRequest request) Creates an `RenderRequest` adaptor wrapping the given request object. Parameters request:RenderRequest the render request to wrap Exceptions IllegalArgumentException: if the request is `null`

public RenderRequestWrapper(RenderRequest request)

Creates an RenderRequest adaptor wrapping the given request object.

Parameters

request:RenderRequest: the render request to wrap

Exceptions

IllegalArgumentException:: if the request is null

Method Detail

getETag back to summary

getETag	back to summary
public String getETag() Implements javax.portlet.RenderRequest.getETag. Doc from javax.portlet.RenderRequest.getETag. Returns the validation tag if the portlet container has a cached response for this validation tag, or `null` if no cached response exists. This call returns the same value as `RenderRequest.getProperty(RenderRequest.ETAG)`. Returns:String the validation tag if the portlet container has a cached response for this validation tag, or `null` if no cached response exists. Annotations @Override

public String getETag()

Implements javax.portlet.RenderRequest.getETag.

Doc from javax.portlet.RenderRequest.getETag.

Returns the validation tag if the portlet container has a cached response for this validation tag, or null if no cached response exists.

This call returns the same value as RenderRequest.getProperty(RenderRequest.ETAG).

Returns:String

the validation tag if the portlet container has a cached response for this validation tag, or null if no cached response exists.

Annotations

@Override

getRequest	back to summary
public RenderRequest getRequest() Overrides javax.portlet.filter.PortletRequestWrapper.getRequest. Return the wrapped request object. Returns:RenderRequest the wrapped request

getRequest

back to summary

public RenderRequest getRequest()

Overrides javax.portlet.filter.PortletRequestWrapper.getRequest.

Return the wrapped request object.

Returns:RenderRequest: the wrapped request

setRequest	back to summary
public void setRequest(RenderRequest request) Sets the request object being wrapped. Parameters request:RenderRequest the request to set Exceptions IllegalArgumentException: if the request is null.

setRequest