Top Description Constructors Methods
javax.portlet.filter

public Class ResourceURLWrapper

extends BaseURLWrapper
implements ResourceURL
Class Inheritance
All Implemented Interfaces
javax.portlet.ResourceURL, javax.portlet.BaseURL, javax.portlet.RenderState
Imports
javax.portlet.MutableResourceParameters, .ResourceURL
The ResourceURLWrapper provides a convenient implementation of the ResourceURL 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.
Since
3.0

Constructor Summary

AccessConstructor and Description
public
ResourceURLWrapper(ResourceURL
the wrapped object to set.
wrapped)

Method Summary

Modifier and TypeMethod and Description
public String
getCacheability()

Implements javax.portlet.ResourceURL.getCacheability.

Returns the cache level of this resource URL.
public String
getResourceID()

Implements javax.portlet.ResourceURL.getResourceID.

Returns the resource ID set on the ResourceURL or null if no resource ID was set on the URL.
public MutableResourceParameters
getResourceParameters()

Implements javax.portlet.ResourceURL.getResourceParameters.

Gets the resource parameter values set for this URL.
public ResourceURL

Returns:

the wrapped object.
getWrapped()

Overrides javax.portlet.filter.BaseURLWrapper.getWrapped.

Gets the wrapped object.
public void
setCacheability(String
the cache level of this resource URL.
cacheLevel)

Implements javax.portlet.ResourceURL.setCacheability.

Sets the cache level of this resource URL.
public void
setResourceID(String
ID for this resource URL
resourceID)

Implements javax.portlet.ResourceURL.setResourceID.

Allows setting a resource ID that can be retrieved when serving the resource through the ResourceRequest#getResourceID method.
public void
setWrapped(ResourceURL
the wrapped object to set.
wrapped)

Sets the wrapped object.

Inherited from javax.portlet.filter.BaseURLWrapper:
addPropertyappendappendgetParameterMapsetParametersetParametersetParameterssetPropertysetSecuresetWrappedtoStringwritewrite

Constructor Detail

ResourceURLWrapperback to summary
public ResourceURLWrapper(ResourceURL wrapped)
Parameters
wrapped:ResourceURL

the wrapped object to set.

Exceptions
IllegalArgumentException:
if the ResourceURL is null.

Method Detail

getCacheabilityback to summary
public String getCacheability()

Implements javax.portlet.ResourceURL.getCacheability.

Doc from javax.portlet.ResourceURL.getCacheability.

Returns the cache level of this resource URL.

Possible return values are: FULL, PORTLET or PAGE.

Returns:String

the cache level of this resource URL.

Annotations
@Override
getResourceIDback to summary
public String getResourceID()

Implements javax.portlet.ResourceURL.getResourceID.

Doc from javax.portlet.ResourceURL.getResourceID.

Returns the resource ID set on the ResourceURL or null if no resource ID was set on the URL.

Returns:String

the resource ID set on the ResourceURL,or null if no resource ID was set on the URL.

Annotations
@Override
getResourceParametersback to summary
public MutableResourceParameters getResourceParameters()

Implements javax.portlet.ResourceURL.getResourceParameters.

Doc from javax.portlet.ResourceURL.getResourceParameters.

Gets the resource parameter values set for this URL.

Resource parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.

Initially the returned object is empty.

Modifying the parameter values encapsulated by the returned object directly modifies the resource parameters applied to the URL.

PortletParameters provides a description of the parameter concept.

Returns:MutableResourceParameters

a mutable PortletParameters object representing the private and public render parameters

Annotations
@Override
getWrappedback to summary
public ResourceURL getWrapped()

Overrides javax.portlet.filter.BaseURLWrapper.getWrapped.

Gets the wrapped object.

Returns:ResourceURL

the wrapped object.

setCacheabilityback to summary
public void setCacheability(String cacheLevel)

Implements javax.portlet.ResourceURL.setCacheability.

Doc from javax.portlet.ResourceURL.setCacheability.

Sets the cache level of this resource URL.

Possible values are: FULL, PORTLET or PAGE.

Note that if this URL is created inside a serveResource call it must have at minimum the same cacheablity, or a more restrictive one, as the parent resource URL, otherwise an IllegalStateException is thrown.

The default cache level of a resource URL is either the cache level of the parent resource URL, or PAGE if no parent resource URL is available.

Parameters
cacheLevel:String

the cache level of this resource URL.

Annotations
@Override
setResourceIDback to summary
public void setResourceID(String resourceID)

Implements javax.portlet.ResourceURL.setResourceID.

Doc from javax.portlet.ResourceURL.setResourceID.

Allows setting a resource ID that can be retrieved when serving the resource through the ResourceRequest#getResourceID method.

Parameters
resourceID:String

ID for this resource URL

Annotations
@Override
setWrappedback to summary
public void setWrapped(ResourceURL wrapped)

Sets the wrapped object.

Parameters
wrapped:ResourceURL

the wrapped object to set.

Exceptions
IllegalArgumentException:
if the ResourceURL is null.