|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IResourceSettings
Interface for resource related settings
resourcePollFrequency (defaults to no polling frequency) - Frequency at which resources should be polled for changes.
resourceFinders - Add/modify this to alter the search path for resources.
useDefaultOnMissingResource (defaults to true) - Set to true to return a default value if available when a required string resource is not found. If set to false then the throwExceptionOnMissingResource flag is used to determine how to behave. If no default is available then this is the same as if this flag were false
A ResourceStreamLocator - An Application's ResourceStreamLocator is used to find resources such as images or markup files. You can supply your own ResourceStreamLocator if your prefer to store your application's resources in a non-standard location (such as a different filesystem location, a particular JAR file or even a database) by overriding the getResourceLocator() method.
Resource Factories - Resource factories can be used to create resources dynamically from
specially formatted HTML tag attribute values. For more details, see IResourceFactory
,
DefaultButtonImageResourceFactory
and
especially LocalizedImageResource
.
A Localizer The getLocalizer() method returns an object encapsulating all of the
functionality required to access localized resources. For many localization problems, even this
will not be required, as there are convenience methods available to all components:
Component.getString(String key)
and
Component.getString(String key, IModel model)
.
stringResourceLoaders - A chain of IStringResourceLoader
instances that are
searched in order to obtain string resources used during localization. By default the chain is
set up to first search for resources against a particular component (e.g. page etc.) and then
against the application.
Method Summary | |
---|---|
void |
addResourceFactory(String name,
IResourceFactory resourceFactory)
Adds a resource factory to the list of factories to consult when generating resources automatically |
IResourceCachingStrategy |
getCachingStrategy()
gets the resource caching strategy |
ICssCompressor |
getCssCompressor()
Get the CSS compressor to remove comments and whitespace characters from css resources |
Duration |
getDefaultCacheDuration()
Get the the default cache duration for resources. |
IFileCleaner |
getFileCleaner()
|
Comparator<? super ResourceAggregator.RecordedHeaderItem> |
getHeaderItemComparator()
|
IJavaScriptCompressor |
getJavaScriptCompressor()
Get the javascript compressor to remove comments and whitespace characters from javascripts |
IPackageResourceGuard |
getPackageResourceGuard()
Gets the package resource guard . |
String |
getParentFolderPlaceholder()
Placeholder string for '..' within resource urls (which will be crippled by the browser and not work anymore). |
IPropertiesFactory |
getPropertiesFactory()
Get the property factory which will be used to load property files |
IResourceFactory |
getResourceFactory(String name)
|
List<IResourceFinder> |
getResourceFinders()
Gets the resource finders to use when searching for resources. |
Duration |
getResourcePollFrequency()
|
List<IStringResourceLoader> |
getStringResourceLoaders()
|
boolean |
getThrowExceptionOnMissingResource()
|
boolean |
getUseDefaultOnMissingResource()
|
boolean |
getUseMinifiedResources()
|
boolean |
isEncodeJSessionId()
A flag indicating whether static resources should have jsessionid encoded in their url. |
void |
setCachingStrategy(IResourceCachingStrategy strategy)
sets the resource caching strategy |
ICssCompressor |
setCssCompressor(ICssCompressor compressor)
Set the CSS compressor implemententation use e.g. |
void |
setDefaultCacheDuration(Duration defaultDuration)
Set the the default cache duration for resources. |
void |
setEncodeJSessionId(boolean encodeJSessionId)
Sets a flag indicating whether the jsessionid should be encoded in the url for resources implementing IStaticCacheableResource when
the cookies are disabled and there is an active http session. |
void |
setFileCleaner(IFileCleaner fileCleaner)
Sets a cleaner that can be used to remove files asynchronously. |
void |
setHeaderItemComparator(Comparator<? super ResourceAggregator.RecordedHeaderItem> comparator)
Sets the comparator used by the resource aggregator for sorting header items. |
IJavaScriptCompressor |
setJavaScriptCompressor(IJavaScriptCompressor compressor)
Set the javascript compressor implemententation use e.g. |
void |
setLocalizer(Localizer localizer)
Sets the localizer which will be used to find property values. |
void |
setPackageResourceGuard(IPackageResourceGuard packageResourceGuard)
Sets the package resource guard . |
void |
setParentFolderPlaceholder(String sequence)
Placeholder string for '..' within resource urls (which will be crippled by the browser and not work anymore). |
void |
setPropertiesFactory(IPropertiesFactory factory)
Set the property factory which will be used to load property files |
void |
setResourceFinders(List<IResourceFinder> resourceFinder)
Sets the finders to use when searching for resources. |
void |
setResourcePollFrequency(Duration resourcePollFrequency)
Sets the resource polling frequency. |
void |
setResourceStreamLocator(IResourceStreamLocator resourceStreamLocator)
Sets the resource stream locator for this application |
void |
setResourceWatcher(IModificationWatcher watcher)
Sets the resource watcher |
void |
setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)
|
void |
setUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)
|
void |
setUseMinifiedResources(boolean useMinifiedResources)
Sets whether to use pre-minified resources when available. |
Methods inherited from interface org.apache.wicket.resource.IPropertiesFactoryContext |
---|
getLocalizer, getResourceStreamLocator, getResourceWatcher |
Method Detail |
---|
void addResourceFactory(String name, IResourceFactory resourceFactory)
name
- The name to give to the factoryresourceFactory
- The resource factory to addDuration getDefaultCacheDuration()
Duration.NONE
IPackageResourceGuard getPackageResourceGuard()
package resource guard
.
IPropertiesFactory getPropertiesFactory()
IResourceFactory getResourceFactory(String name)
name
- Name of the factory to get
List<IResourceFinder> getResourceFinders()
WebApplication
adds the classpath
directory META-INF/resources. To configure additional search paths or filesystem paths, add
to this list.
Duration getResourcePollFrequency()
setResourcePollFrequency(Duration)
List<IStringResourceLoader> getStringResourceLoaders()
boolean getThrowExceptionOnMissingResource()
boolean getUseDefaultOnMissingResource()
void setDefaultCacheDuration(Duration defaultDuration)
defaultDuration
- default cache duration in secondsDuration.NONE
,
WebResponse.MAX_CACHE_DURATION
void setLocalizer(Localizer localizer)
localizer
- void setPackageResourceGuard(IPackageResourceGuard packageResourceGuard)
package resource guard
.
packageResourceGuard
- The package resource guardvoid setPropertiesFactory(IPropertiesFactory factory)
factory
- void setResourceFinders(List<IResourceFinder> resourceFinder)
getResourceFinders()
. Use this method if you want to completely exchange the list of
resource finders.
resourceFinder
- The resourceFinder to setvoid setResourcePollFrequency(Duration resourcePollFrequency)
resourcePollFrequency
- Frequency at which to poll resources or null
if polling should be
disabledgetResourceFinders()
void setResourceStreamLocator(IResourceStreamLocator resourceStreamLocator)
resourceStreamLocator
- new resource stream locatorvoid setResourceWatcher(IModificationWatcher watcher)
watcher
- void setFileCleaner(IFileCleaner fileCleaner)
Used internally to delete the temporary files created by FileUpload functionality
fileCleaner
- the actual cleaner implementation. Can be null
IFileCleaner getFileCleaner()
void setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)
throwExceptionOnMissingResource
- void setUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)
useDefaultOnMissingResource
- Whether to use a default value (if available) when a missing resource is requestedIJavaScriptCompressor setJavaScriptCompressor(IJavaScriptCompressor compressor)
JavaScriptPackageResource
. A typical implementation will remove comments and whitespace. But
a no-op implementation is available as well.
compressor
- The implementation to be used
IJavaScriptCompressor getJavaScriptCompressor()
JavaScriptPackageResource
. Null is a valid value.String getParentFolderPlaceholder()
::
. Resources
are protected by a IPackageResourceGuard
implementation such as
PackageResourceGuard
which you may use or extend based
on your needs.
void setParentFolderPlaceholder(String sequence)
null
and thus
will not allow to access parent folders. That is by purpose and for security reasons (see
Wicket-1992). In case you really need it, a good value for placeholder would e.g. be "$up$".
Resources additionally are protected by a
IPackageResourceGuard
implementation such as PackageResourceGuard
which you
may use or extend based on your needs.
sequence
- character sequence which must not be ambiguous within urlsgetParentFolderPlaceholder()
IResourceCachingStrategy getCachingStrategy()
void setCachingStrategy(IResourceCachingStrategy strategy)
strategy
- instance of resource caching strategyIResourceCachingStrategy
ICssCompressor setCssCompressor(ICssCompressor compressor)
CssPackageResource
. A typical
implementation will remove comments and whitespace. But a no-op implementation is available
as well.
compressor
- The implementation to be used
ICssCompressor getCssCompressor()
CssPackageResource
. Null is a valid value.void setUseMinifiedResources(boolean useMinifiedResources)
x.js
is expected to be called x.min.js
. For css
files, the same convention is used: x.min.css
is the minified version of
x.css
. When this is null, minified resources will only be used in deployment
configuration.
useMinifiedResources
- The new value for the settingboolean getUseMinifiedResources()
void setHeaderItemComparator(Comparator<? super ResourceAggregator.RecordedHeaderItem> comparator)
PriorityFirstComparator
.
comparator
- The comparator used to sort header items, when null, header items will not be
sorted.Comparator<? super ResourceAggregator.RecordedHeaderItem> getHeaderItemComparator()
boolean isEncodeJSessionId()
true
if the jsessionid should be encoded in the url for resources
implementing
IStaticCacheableResource
when the
cookies are disabled and there is an active http session.void setEncodeJSessionId(boolean encodeJSessionId)
IStaticCacheableResource
when
the cookies are disabled and there is an active http session.
encodeJSessionId
- true
when the jsessionid should be encoded, false
- otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |