org.apache.wicket.request.resource.caching

Interface IStaticCacheableResource

All Superinterfaces:

IClusterable, IResource, Serializable

All Known Implementing Classes:

ConcatBundleResource, ContextRelativeResource, CssPackageResource, JavaScriptPackageResource, PackageResource

public interface IStaticCacheableResource
extends IResource

static resource which does not change for the lifetime of the application and should be considered a candidate for long-term caching.

Since:

1.5

Author:

Peter Ertl

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.wicket.request.resource.IResource

IResource.Attributes

Method Summary

Methods

Modifier and Type	Method and Description
IResourceStream	getCacheableResourceStream() get static resource stream which will be unique to the related caching key getCacheKey()
Serializable	getCacheKey() get unique caching key for the resource stream produced by getCacheableResourceStream()
boolean	isCachingEnabled() controls whether caching of the resource is enabled or disabled

Methods inherited from interface org.apache.wicket.request.resource.IResource

respond

Method Detail

isCachingEnabled

boolean isCachingEnabled()

controls whether caching of the resource is enabled or disabled

Returns:

@{code true} if caching is enabled

getCacheKey

Serializable getCacheKey()

get unique caching key for the resource stream produced by getCacheableResourceStream()

Returns:

serializable key with properly supports #equals(Object) and #hashCode()

getCacheableResourceStream

IResourceStream getCacheableResourceStream()

get static resource stream which will be unique to the related caching key getCacheKey()

Returns:

stream or null if no stream could be found