Package jakarta.portlet.filter

Class ResourceURLWrapper

java.lang.Object

jakarta.portlet.filter.RenderStateWrapper

jakarta.portlet.filter.BaseURLWrapper

jakarta.portlet.filter.ResourceURLWrapper

All Implemented Interfaces:

BaseURL, RenderState, ResourceURL

public class ResourceURLWrapper
extends BaseURLWrapper
implements 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

Field Summary

Fields inherited from class jakarta.portlet.filter.RenderStateWrapper

wrapped

Fields inherited from interface jakarta.portlet.ResourceURL

FULL, PAGE, PORTLET, SHARED

Constructor Summary

Constructors

Constructor	Description
ResourceURLWrapper(ResourceURL wrapped)

Method Summary

Modifier and Type	Method	Description
String	getCacheability()	Returns the cache level of this resource URL.
String	getResourceID()	Returns the resource ID set on the ResourceURL or null if no resource ID was set on the URL.
MutableResourceParameters	getResourceParameters()	Gets the resource parameter values set for this URL.
ResourceURL	getWrapped()	Gets the wrapped object.
void	setCacheability(String cacheLevel)	Sets the cache level of this resource URL.
void	setResourceID(String resourceID)	Allows setting a resource ID that can be retrieved when serving the resource through the ResourceRequest.getResourceID() method.
void	setWrapped(ResourceURL wrapped)	Sets the wrapped object.

Methods inherited from class jakarta.portlet.filter.BaseURLWrapper

addProperty, append, append, getParameterMap, setParameter, setParameter, setParameters, setProperty, setSecure, setWrapped, toString, write, write

Methods inherited from class jakarta.portlet.filter.RenderStateWrapper

getPortletMode, getRenderParameters, getWindowState, setWrapped

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jakarta.portlet.BaseURL

addProperty, append, append, getParameterMap, setParameter, setParameter, setParameters, setProperty, setSecure, toString, write, write

Methods inherited from interface jakarta.portlet.RenderState

getPortletMode, getRenderParameters, getWindowState

Constructor Detail

ResourceURLWrapper

public ResourceURLWrapper(ResourceURL wrapped)

Parameters:

wrapped - the wrapped object to set.

Throws:

IllegalArgumentException - if the ResourceURL is null.

Method Detail

getWrapped

public ResourceURL getWrapped()

Gets the wrapped object.

Overrides:

getWrapped in class BaseURLWrapper

Returns:

the wrapped object.

setWrapped

public void setWrapped(ResourceURL wrapped)

Sets the wrapped object.

Parameters:

wrapped - the wrapped object to set.

Throws:

IllegalArgumentException - if the ResourceURL is null.

getResourceParameters

public MutableResourceParameters getResourceParameters()

Description copied from interface: ResourceURL

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.

Specified by:

getResourceParameters in interface ResourceURL

Returns:

a mutable PortletParameters object representing the private and public render parameters

See Also:

PortletParameters, MutableResourceParameters, ResourceRequest

setResourceID

public void setResourceID(String resourceID)

Description copied from interface: ResourceURL

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

Specified by:

setResourceID in interface ResourceURL

Parameters:

resourceID - ID for this resource URL

getResourceID

public String getResourceID()

Description copied from interface: ResourceURL

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

Specified by:

getResourceID in interface ResourceURL

Returns:

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

getCacheability

public String getCacheability()

Description copied from interface: ResourceURL

Returns the cache level of this resource URL.

Possible return values are: FULL, PORTLET or PAGE.

Specified by:

getCacheability in interface ResourceURL

Returns:

the cache level of this resource URL.

setCacheability

public void setCacheability(String cacheLevel)

Description copied from interface: ResourceURL

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.

Specified by:

setCacheability in interface ResourceURL

Parameters:

cacheLevel - the cache level of this resource URL.