org.apache.wicket.settings
Interface IResourceSettings

All Known Implementing Classes:

Settings

public interface IResourceSettings

Interface for resource related settings

resourcePollFrequency (defaults to no polling frequency) - Frequency at which resources should be polled for changes.

resourceFinder (classpath) - Set 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.

Author:

Igor Vaynberg (ivaynberg)

Method Summary

void	addResourceFactory(java.lang.String name, IResourceFactory resourceFactory) Adds a resource factory to the list of factories to consult when generating resources automatically
void	addResourceFolder(java.lang.String resourceFolder) Convenience method that sets the resource search path to a single folder.
void	addStringResourceLoader(IStringResourceLoader loader) Add a string resource loader to the chain of loaders.
boolean	getAddLastModifiedTimeToResourceReferenceUrl() Returns whether Wicket should add last modified time as resource reference URL parameter.
boolean	getDisableGZipCompression() Whether to disable gzip compression for resources.
Localizer	getLocalizer() Get the application's localizer.
IPackageResourceGuard	getPackageResourceGuard() Gets the package resource guard.
IPropertiesFactory	getPropertiesFactory() Get the property factory which will be used to load property files
IResourceFactory	getResourceFactory(java.lang.String name)
IResourceFinder	getResourceFinder() Gets the resource finder to use when searching for resources.
Duration	getResourcePollFrequency()
IResourceStreamLocator	getResourceStreamLocator()
ModificationWatcher	getResourceWatcher(boolean start)
java.util.List	getStringResourceLoaders()
boolean	getStripJavascriptCommentsAndWhitespace()
boolean	getThrowExceptionOnMissingResource()
boolean	getUseDefaultOnMissingResource()
void	setAddLastModifiedTimeToResourceReferenceUrl(boolean value) Sets whether Wicket should add last modified time as a parameter to resource reference URL (can help with browsers too aggressively caching certain resources).
void	setDisableGZipCompression(boolean disableGZipCompression) Sets whether to disable gzip compression for resources.
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	setPropertiesFactory(IPropertiesFactory factory) Set the property factory which will be used to load property files
void	setResourceFinder(IResourceFinder resourceFinder) Sets the finder 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	setStripJavascriptCommentsAndWhitespace(boolean value) Sets whether the whitespace characters and comments should be stripped for resources served through JavascriptPackageResource
void	setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)
void	setUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)

Method Detail

addResourceFactory

public void addResourceFactory(java.lang.String name,
                               IResourceFactory resourceFactory)

Adds a resource factory to the list of factories to consult when generating resources automatically

Parameters:

name - The name to give to the factory

resourceFactory - The resource factory to add

addResourceFolder

public void addResourceFolder(java.lang.String resourceFolder)

Convenience method that sets the resource search path to a single folder. use when searching for resources. By default, the resources are located on the classpath. If you want to configure other, additional, search paths, you can use this method

Parameters:

resourceFolder - The resourceFolder to set

addStringResourceLoader

public void addStringResourceLoader(IStringResourceLoader loader)

Add a string resource loader to the chain of loaders. If this is the first call to this method since the creation of the application settings then the existing chain is cleared before the new loader is added.

Parameters:

loader - The loader to be added

getDisableGZipCompression

public boolean getDisableGZipCompression()

Whether to disable gzip compression for resources. You need this on SAP, which gzips things twice.

Returns:

True if we should disable gzip compression

Since:

1.3.0

getLocalizer

public Localizer getLocalizer()

Get the application's localizer.

Returns:

The application wide localizer instance

See Also:

for means of extending the way Wicket resolves keys to localized messages.

getPackageResourceGuard

public IPackageResourceGuard getPackageResourceGuard()

Gets the package resource guard.

Returns:

The package resource guard

getPropertiesFactory

public IPropertiesFactory getPropertiesFactory()

Get the property factory which will be used to load property files

Returns:

PropertiesFactory

getResourceFactory

public IResourceFactory getResourceFactory(java.lang.String name)

Parameters:

name - Name of the factory to get

Returns:

The IResourceFactory with the given name.

getResourceFinder

public IResourceFinder getResourceFinder()

Gets the resource finder to use when searching for resources.

Returns:

Returns the resourceFinder.

See Also:

setResourceFinder(IResourceFinder)

getResourcePollFrequency

public Duration getResourcePollFrequency()

Returns:

Returns the resourcePollFrequency.

See Also:

setResourcePollFrequency(Duration)

getResourceStreamLocator

public IResourceStreamLocator getResourceStreamLocator()

Returns:

Resource locator for this application

getResourceWatcher

public ModificationWatcher getResourceWatcher(boolean start)

Parameters:

start - boolean if the resource watcher should be started if not already started.

Returns:

Resource watcher with polling frequency determined by setting, or null if no polling frequency has been set.

getStringResourceLoaders

public java.util.List getStringResourceLoaders()

Returns:

an unmodifiable list of all available string resource loaders

getThrowExceptionOnMissingResource

public boolean getThrowExceptionOnMissingResource()

Returns:

boolean

See Also:

IExceptionSettings.getThrowExceptionOnMissingResource()

getUseDefaultOnMissingResource

public boolean getUseDefaultOnMissingResource()

Returns:

Whether to use a default value (if available) when a missing resource is requested

setDisableGZipCompression

public void setDisableGZipCompression(boolean disableGZipCompression)

Sets whether to disable gzip compression for resources. You need to set this on some SAP versions, which gzip things twice.

Parameters:

disableGZipCompression -

Since:

1.3.0

setLocalizer

public void setLocalizer(Localizer localizer)

Sets the localizer which will be used to find property values.

Parameters:

localizer -

Since:

1.3.0

setPackageResourceGuard

public void setPackageResourceGuard(IPackageResourceGuard packageResourceGuard)

Sets the package resource guard.

Parameters:

packageResourceGuard - The package resource guard

setPropertiesFactory

public void setPropertiesFactory(IPropertiesFactory factory)

Set the property factory which will be used to load property files

Parameters:

factory -

setResourceFinder

public void setResourceFinder(IResourceFinder resourceFinder)

Sets the finder to use when searching for resources. By default, the resources are located on the classpath. If you want to configure other, additional, search paths, you can use this method.

Parameters:

resourceFinder - The resourceFinder to set

setResourcePollFrequency

public void setResourcePollFrequency(Duration resourcePollFrequency)

Sets the resource polling frequency. This is the duration of time between checks of resource modification times. If a resource, such as an HTML file, has changed, it will be reloaded. Default is for no resource polling to occur.

Parameters:

resourcePollFrequency - Frequency at which to poll resources

See Also:

setResourceFinder(IResourceFinder)

setResourceStreamLocator

public void setResourceStreamLocator(IResourceStreamLocator resourceStreamLocator)

Sets the resource stream locator for this application

Parameters:

resourceStreamLocator - new resource stream locator

setThrowExceptionOnMissingResource

public void setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)

Parameters:

throwExceptionOnMissingResource -

See Also:

IExceptionSettings.setThrowExceptionOnMissingResource(boolean)

setUseDefaultOnMissingResource

public void setUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)

Parameters:

useDefaultOnMissingResource - Whether to use a default value (if available) when a missing resource is requested

setStripJavascriptCommentsAndWhitespace

public void setStripJavascriptCommentsAndWhitespace(boolean value)

Sets whether the whitespace characters and comments should be stripped for resources served through JavascriptPackageResource

Parameters:

value -

getStripJavascriptCommentsAndWhitespace

public boolean getStripJavascriptCommentsAndWhitespace()

Returns:

whether the comments and whitespace characters will be stripped from resources served through JavascriptPackageResource

setAddLastModifiedTimeToResourceReferenceUrl

public void setAddLastModifiedTimeToResourceReferenceUrl(boolean value)

Sets whether Wicket should add last modified time as a parameter to resource reference URL (can help with browsers too aggressively caching certain resources).

Parameters:

value -

getAddLastModifiedTimeToResourceReferenceUrl

public boolean getAddLastModifiedTimeToResourceReferenceUrl()

Returns whether Wicket should add last modified time as resource reference URL parameter.

Returns: