wicket
Class ApplicationSettings

java.lang.Object
  wicket.ApplicationSettings

public class ApplicationSettings

extends java.lang.Object

Contains application settings as property values. All settings exposed are generic to any kind of protocol or markup.

Application settings properties:

bufferResponse (defaults to true) - True if the application should buffer responses. This does require some additional memory, but helps keep exception displays accurate because the whole rendering process completes before the page is sent to the user, thus avoiding the possibility of a partially rendered page.
componentIdAttribute (defaults to "wicket") - The markup attribute which denotes the ids of components to be attached

componentUseCheck (defaults to true) - Causes the framework to do a check after rendering each page to ensure that each component was used in rendering the markup. If components are found that are not referenced in the markup, an appropriate error will be displayed

compressWhitespace (defaults to false) - Causes pages to render with redundant whitespace removed. Whitespace stripping is not HTML or JavaScript savvy and can conceivably break pages, but should provide significant performance improvements.

unexpectedExceptionDisplay (defaults to SHOW_EXCEPTION_PAGE) - Determines how exceptions are displayed to the developer or user

maxPages - The maximum number of pages in the user's session before old pages are expired.

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.

stripComments (defaults to false) - Set to true to strip HTML comments during markup loading

stripComponentIds (defaults to false) - Set to true to strip component id attributes during rendering

throwExceptionOnMissingResource (defaults to true) - Set to true to throw a runtime exception if a required string resource is not found. Set to false to return the requested resource key surrounded by pairs of question mark characters (e.g. "??missingKey??")

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

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.

defaultPageFactory - the factory class that is used for constructing page instances.

renderStrategy - Sets in what way the render part of a request is handled. Basically, there are two different options:

• Direct, ApplicationSettings.ONE_PASS_RENDER. Everything is handled in one physical request. This is efficient, and is the best option if you want to do sophisticated clustering. It does not however, shield you from what is commonly known as the Double submit problem
• Using a redirect. This follows the pattern as described at the serverside and that is commonly known as Redirect after post. Wicket takes it one step further to do any rendering after a redirect, so that not only form submits are shielded from the double submit problem, but also the IRequestListener handlers (that could be e.g. a link that deletes a row). With this pattern, you have two options to choose from:
  • ApplicationSettings.REDIRECT_TO_RENDER. This option first handles the 'action' part of the request, which is either page construction (bookmarkable pages or the home page) or calling a IRequestListener handler, such as Link.onClick. When that part is done, a redirect is issued to the render part, which does all the rendering of the page and its components. Be aware that this may mean, depending on whether you access any models in the action part of the request, that attachement and detachement of some models is done twice for a request.
  • ApplicationSettings.REDIRECT_TO_BUFFER. This option handles both the action- and the render part of the request in one physical request, but instead of streaming the result to the browser directly, it is kept in memory, and a redirect is issue to get this buffered result (after which it is immediately removed). This option currently is the default render strategy, as it shields you from the double submit problem, while being more efficient and less error prone regarding to detachable models.
Note that this parameter sets the default behaviour, but that you can manually set whether any redirecting is done by calling method RequestCycle.setRedirect. Setting the redirect flag when the application is configured to use ONE_PASS_RENDER, will result in a redirect of type REDIRECT_TO_RENDER. When the application is configured to use REDIRECT_TO_RENDER or REDIRECT_TO_BUFFER, setting the redirect flag to false, will result in that request begin rendered and streamed in one pass.
More documentation is available about each setting in the setter method for the property.

Author:

Jonathan Locke, Chris Turner, Eelco Hillenius, Juergen Donnerstag, Johan Compagner

Nested Class Summary

static class	ApplicationSettings.RenderStrategy Enumerated type for different ways of handling the render part of requests.
static class	ApplicationSettings.UnexpectedExceptionDisplay Enumerated type for different ways of displaying unexpected exceptions.

Field Summary

static ApplicationSettings.RenderStrategy	ONE_PASS_RENDER All logical parts of a request (the action and render part) are handled within the same request.
static ApplicationSettings.RenderStrategy	REDIRECT_TO_BUFFER All logical parts of a request (the action and render part) are handled within the same request, but instead of streaming the render result to the browser directly, the result is cached on the server.
static ApplicationSettings.RenderStrategy	REDIRECT_TO_RENDER The render part of a request (opposed to the 'action part' which is either the construction of a bookmarkable page or the execution of a IRequestListener handler) is handled by a seperate request by issueing a redirect request to the browser.
static ApplicationSettings.UnexpectedExceptionDisplay	SHOW_EXCEPTION_PAGE Indicates that an exception page appropriate to development should be shown when an unexpected exception is thrown.
static ApplicationSettings.UnexpectedExceptionDisplay	SHOW_INTERNAL_ERROR_PAGE Indicates a generic internal error page should be shown when an unexpected exception is thrown.
static ApplicationSettings.UnexpectedExceptionDisplay	SHOW_NO_EXCEPTION_PAGE Indicates that no exception page should be shown when an unexpected exception is thrown.

Constructor Summary

ApplicationSettings(Application application)
Create the application settings, carrying out any necessary initialisations.

Method Summary

ApplicationSettings	addResourceFolder(java.lang.String resourceFolder) Convenience method that sets the resource search path to a single folder.
ApplicationSettings	addStringResourceLoader(IStringResourceLoader loader) Add a string resource loader to the chain of loaders.
void	configure(java.lang.String configurationType) Configures application settings for a given configuration type.
void	configure(java.lang.String configurationType, IResourceFinder resourceFinder) Configures application settings for a given configuration type.
void	configure(java.lang.String configurationType, java.lang.String resourceFolder) Convenience method that configures application settings for a given configuration type.
boolean	getAutomaticLinking() If true, automatic link resolution is enabled.
boolean	getBufferResponse()
boolean	getComponentUseCheck() Get whether component use should be checked or not.
boolean	getCompressWhitespace()
CookieValuePersisterSettings	getCookieValuePersisterSettings() Get the defaults to be used by persistence manager
java.lang.Class	getCryptClass()
java.lang.String	getDefaultAfterDisabledLink()
java.lang.String	getDefaultBeforeDisabledLink()
IClassResolver	getDefaultClassResolver() Gets the default resolver to use when finding classes
java.util.Locale	getDefaultLocale()
java.lang.String	getDefaultMarkupEncoding()
IPageFactory	getDefaultPageFactory() Gets the default factory to be used when creating pages
java.lang.String	getEncryptionKey() Get encryption key used to encode/decode passwords e.g.
int	getMaxPages() Gets the maximum number of pages held in a session.
int	getMaxPageVersions()
ApplicationSettings.RenderStrategy	getRenderStrategy() Gets in what way the render part of a request is handled.
IResourceFinder	getResourceFinder() Gets the resource finder to use when searching for resources.
Duration	getResourcePollFrequency()
java.lang.String	getResponseRequestEncoding() In order to do proper form parameter decoding it is important that the response and the following request have the same encoding.
(package private) java.util.List	getStringResourceLoaders() Internal method to expose the string resource loaders configured within the settings to the localization helpers that need to work with them.
boolean	getStripComments()
boolean	getStripWicketTags() Gets whether to remove wicket tags from the output.
boolean	getStripXmlDeclarationFromOutput()
boolean	getThrowExceptionOnMissingResource()
ApplicationSettings.UnexpectedExceptionDisplay	getUnexpectedExceptionDisplay()
boolean	getUseDefaultOnMissingResource()
java.lang.String	getValidatorResourceKey(IValidator validator, FormComponent formComponent) This method builds a resource key for use by form component validators using IValidatorResourceKeyFactory.
boolean	getVersionPagesByDefault()
protected IResourceFinder	newResourceFinder() This method returns a default Path object.
void	setAutomaticLinking(boolean automaticLinking) Application default for automatic link resolution.
void	setBufferResponse(boolean bufferResponse)
ApplicationSettings	setComponentUseCheck(boolean componentUseCheck) Enables or disables checking for unused components.
ApplicationSettings	setCompressWhitespace(boolean compressWhitespace) Turns on whitespace compression.
void	setCookieValuePersisterSettings(CookieValuePersisterSettings cookieValuePersisterSettings)
ApplicationSettings	setCryptClass(java.lang.Class crypt) Set new Class to be used for de-/encryption
ApplicationSettings	setDefaultAfterDisabledLink(java.lang.String defaultAfterDisabledLink)
ApplicationSettings	setDefaultBeforeDisabledLink(java.lang.String defaultBeforeDisabledLink)
ApplicationSettings	setDefaultClassResolver(IClassResolver defaultClassResolver) Sets the default class resolver to use when finding classes.
void	setDefaultLocale(java.util.Locale defaultLocale)
void	setDefaultMarkupEncoding(java.lang.String encoding) Set default encoding for markup files.
ApplicationSettings	setDefaultPageFactory(IPageFactory defaultPageFactory) Sets the default factory to be used when creating pages.
ApplicationSettings	setEncryptionKey(java.lang.String encryptionKey) Set encryption key used to encode/decode PasswordTextFields e.g.
ApplicationSettings	setMaxPages(int maxPages) Sets the maximum number of pages held in a session.
void	setMaxPageVersions(int maxPageVersions)
void	setRenderStrategy(ApplicationSettings.RenderStrategy renderStrategy) Sets in what way the render part of a request is handled.
ApplicationSettings	setResourceFinder(IResourceFinder resourceFinder) Sets the finder to use when searching for resources.
ApplicationSettings	setResourcePollFrequency(Duration resourcePollFrequency) Sets the resource polling frequency.
void	setResponseRequestEncoding(java.lang.String responseRequestEncoding) In order to do proper form parameter decoding it is important that the response and the following request have the same encoding.
ApplicationSettings	setStripComments(boolean stripComments) Enables stripping of markup comments denoted in markup by HTML comment tagging.
ApplicationSettings	setStripWicketTags(boolean stripWicketTags) Sets whether to remove wicket tags from the output.
void	setStripXmlDeclarationFromOutput(boolean strip)
ApplicationSettings	setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)
ApplicationSettings	setUnexpectedExceptionDisplay(ApplicationSettings.UnexpectedExceptionDisplay unexpectedExceptionDisplay) The exception display type determines how the framework displays exceptions to you as a developer or user.
ApplicationSettings	setUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)
void	setValidatorResourceKeyFactory(IValidatorResourceKeyFactory factory) This method is used to replace the default IValidatorResourceKeyFactory implementation with a user specific one
void	setVersionPagesByDefault(boolean pagesVersionedByDefault)

Methods inherited from class java.lang.Object

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

Field Detail

ONE_PASS_RENDER

public static final ApplicationSettings.RenderStrategy ONE_PASS_RENDER

All logical parts of a request (the action and render part) are handled within the same request. To enable a the client side redirect for a request, users can set the 'redirect' property of RequestCycleto true (getRequestCycle.setRedirect(true)), after which the behaviour will be like RenderStragegy 'REDIRECT_TO_RENDER'.

This strategy is more efficient than the 'REDIRECT_TO_RENDER' strategy, and doesn't have some of the potential problems of it, it also does not solve the double submit problem. It is however the best option to use when you want to do sophisticated (non-sticky session) clustering.

REDIRECT_TO_BUFFER

public static final ApplicationSettings.RenderStrategy REDIRECT_TO_BUFFER

All logical parts of a request (the action and render part) are handled within the same request, but instead of streaming the render result to the browser directly, the result is cached on the server. A client side redirect command is issued to the browser specifically to render this request.

REDIRECT_TO_RENDER

public static final ApplicationSettings.RenderStrategy REDIRECT_TO_RENDER

The render part of a request (opposed to the 'action part' which is either the construction of a bookmarkable page or the execution of a IRequestListener handler) is handled by a seperate request by issueing a redirect request to the browser. This is commonly known as the 'redirect after submit' pattern, though in our case, we use it for GET and POST requests instead of just the POST requests. To cancel the client side redirect for a request, users can set the 'redirect' property of RequestCycleto false (getRequestCycle.setRedirect(false)).

This pattern solves the 'refresh' problem. While it is a common feature of browsers to refresh/ reload a web page, this results in problems in many dynamic web applications. For example, when you have a link with an event handler that e.g. deletes a row from a list, you usually want to ignore refresh requests after that link is clicked on. By using this strategy, the refresh request only results in the re-rendering of the page without executing the event handler again.

Though it solves the refresh problem, it introduces potential problems, as the request that is logically one, are actually two seperate request. Not only is this less efficient, but this also can mean that within the same request attachement/ detachement of models is done twice (in case you use models in the bookmarkable page constructors and IRequestListener handlers). If you use this strategy, you should be aware of this possibily, and should also be aware that for one logical request, actually two instances of RequestCycle are created and processed.

SHOW_EXCEPTION_PAGE

public static final ApplicationSettings.UnexpectedExceptionDisplay SHOW_EXCEPTION_PAGE

Indicates that an exception page appropriate to development should be shown when an unexpected exception is thrown.

SHOW_INTERNAL_ERROR_PAGE

public static final ApplicationSettings.UnexpectedExceptionDisplay SHOW_INTERNAL_ERROR_PAGE

Indicates a generic internal error page should be shown when an unexpected exception is thrown.

SHOW_NO_EXCEPTION_PAGE

public static final ApplicationSettings.UnexpectedExceptionDisplay SHOW_NO_EXCEPTION_PAGE

Indicates that no exception page should be shown when an unexpected exception is thrown.

Constructor Detail

ApplicationSettings

public ApplicationSettings(Application application)

Create the application settings, carrying out any necessary initialisations.

Parameters:

application - The application that these settings are for

Method Detail

addResourceFolder

public final ApplicationSettings 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

Returns:

This

addStringResourceLoader

public final ApplicationSettings 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

Returns:

This

configure

public final void configure(java.lang.String configurationType)

Configures application settings for a given configuration type.

Parameters:

configurationType - The configuration type. Must currently be either "development" or "deployment". If the type is 'development', the classpath is polled for changes

configure

public final void configure(java.lang.String configurationType,
                            IResourceFinder resourceFinder)

Configures application settings for a given configuration type.

Parameters:

configurationType - The configuration type. Must currently be either "development" or "deployment". If the type is 'development', the given resourceFinder is polled for changes

resourceFinder - Finder for looking up resources

See Also:

File.pathSeparator

configure

public final void configure(java.lang.String configurationType,
                            java.lang.String resourceFolder)

Convenience method that configures application settings for a given configuration type.

Parameters:

configurationType - The configuration type. Must currently be either "development" or "deployment". If the type is 'development', the given resourceFolder is polled for changes

resourceFolder - Folder for polling resources

See Also:

File.pathSeparator

getAutomaticLinking

public final boolean getAutomaticLinking()

If true, automatic link resolution is enabled. Disabled by default.

Returns:

Returns the automaticLinking.

See Also:

AutoLinkResolver, WicketLinkTagHandler

getBufferResponse

public final boolean getBufferResponse()

Returns:

True if this application buffers its responses

getComponentUseCheck

public final boolean getComponentUseCheck()

Get whether component use should be checked or not.

Returns:

True if component use should be checked

See Also:

setComponentUseCheck(boolean)

getCompressWhitespace

public final boolean getCompressWhitespace()

Returns:

Returns the compressWhitespace.

See Also:

setCompressWhitespace(boolean)

getCookieValuePersisterSettings

public final CookieValuePersisterSettings getCookieValuePersisterSettings()

Get the defaults to be used by persistence manager

Returns:

CookieValuePersisterSettings

getCryptClass

public final java.lang.Class getCryptClass()

Returns:

Returns the cryptClass.

getDefaultAfterDisabledLink

public final java.lang.String getDefaultAfterDisabledLink()

Returns:

Returns the defaultAfterDisabledLink.

getDefaultBeforeDisabledLink

public final java.lang.String getDefaultBeforeDisabledLink()

Returns:

Returns the defaultBeforeDisabledLink.

getDefaultClassResolver

public final IClassResolver getDefaultClassResolver()

Gets the default resolver to use when finding classes

Returns:

Default class resolver

getDefaultLocale

public final java.util.Locale getDefaultLocale()

Returns:

Returns the defaultLocale.

getDefaultPageFactory

public final IPageFactory getDefaultPageFactory()

Gets the default factory to be used when creating pages

Returns:

The default page factory

getEncryptionKey

public final java.lang.String getEncryptionKey()

Get encryption key used to encode/decode passwords e.g.

Returns:

encryption key

getDefaultMarkupEncoding

public final java.lang.String getDefaultMarkupEncoding()

Returns:

Returns default encoding of markup files. If null, the operating system provided encoding will be used.

Since:

1.1

getMaxPages

public final int getMaxPages()

Gets the maximum number of pages held in a session.

Returns:

Returns the maxPages.

See Also:

setMaxPages(int)

getMaxPageVersions

public final int getMaxPageVersions()

Returns:

Returns the maxPageVersions.

getRenderStrategy

public final ApplicationSettings.RenderStrategy getRenderStrategy()

Gets in what way the render part of a request is handled.

Returns:

the render strategy

getResourceFinder

public final IResourceFinder getResourceFinder()

Gets the resource finder to use when searching for resources. If no resource finder has been set explicitly via setResourceFinder(), the factory method newResourceFinder() will be called to create a resource finder.

Returns:

Returns the resourceFinder.

See Also:

setResourceFinder(IResourceFinder)

getResourcePollFrequency

public final Duration getResourcePollFrequency()

Returns:

Returns the resourcePollFrequency.

See Also:

setResourcePollFrequency(Duration)

getStripComments

public final boolean getStripComments()

Returns:

Returns the stripComments.

See Also:

setStripComments(boolean)

getStripWicketTags

public final boolean getStripWicketTags()

Gets whether to remove wicket tags from the output.

Returns:

whether to remove wicket tags from the output

getStripXmlDeclarationFromOutput

public final boolean getStripXmlDeclarationFromOutput()

Returns:

if true, xml declaration will be removed.

Since:

1.1

getThrowExceptionOnMissingResource

public final boolean getThrowExceptionOnMissingResource()

Returns:

Whether to throw an exception when a missing resource is requested

getUnexpectedExceptionDisplay

public final ApplicationSettings.UnexpectedExceptionDisplay getUnexpectedExceptionDisplay()

Returns:

Returns the unexpectedExceptionDisplay.

See Also:

setUnexpectedExceptionDisplay(ApplicationSettings.UnexpectedExceptionDisplay)

getUseDefaultOnMissingResource

public final boolean getUseDefaultOnMissingResource()

Returns:

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

getVersionPagesByDefault

public final boolean getVersionPagesByDefault()

Returns:

Returns the pagesVersionedByDefault.

setAutomaticLinking

public final void setAutomaticLinking(boolean automaticLinking)

Application default for automatic link resolution. Please

Parameters:

automaticLinking - The automaticLinking to set.

See Also:

and, for more details.

setBufferResponse

public final void setBufferResponse(boolean bufferResponse)

Parameters:

bufferResponse - True if this application should buffer responses.

setComponentUseCheck

public final ApplicationSettings setComponentUseCheck(boolean componentUseCheck)

Enables or disables checking for unused components. Component checking is on by defaults and only minor efficiency can be gained from turning it off in a production environment.

Parameters:

componentUseCheck -

Returns:

This

setCompressWhitespace

public final ApplicationSettings setCompressWhitespace(boolean compressWhitespace)

Turns on whitespace compression. Multiple occurrences of space/tab characters will be compressed to a single space. Multiple line breaks newline/carriage-return will also be compressed to a single newline.

Compression is currently not HTML aware and so it may be possible for whitespace compression to break pages. For this reason, whitespace compression is off by default and you should test your application throroughly after turning whitespace compression on.

Spaces are removed from markup at markup load time and there should be no effect on page rendering speed. In fact, your pages should render faster with whitespace compression enabled.

Parameters:

compressWhitespace - The compressWhitespace to set.

Returns:

This

setCookieValuePersisterSettings

public final void setCookieValuePersisterSettings(CookieValuePersisterSettings cookieValuePersisterSettings)

Parameters:

cookieValuePersisterSettings - The cookieValuePersisterSettings to set.

setCryptClass

public final ApplicationSettings setCryptClass(java.lang.Class crypt)

Set new Class to be used for de-/encryption

Parameters:

crypt -

Returns:

This

setDefaultAfterDisabledLink

public final ApplicationSettings setDefaultAfterDisabledLink(java.lang.String defaultAfterDisabledLink)

Parameters:

defaultAfterDisabledLink - The defaultAfterDisabledLink to set.

Returns:

This

setDefaultBeforeDisabledLink

public final ApplicationSettings setDefaultBeforeDisabledLink(java.lang.String defaultBeforeDisabledLink)

Parameters:

defaultBeforeDisabledLink - The defaultBeforeDisabledLink to set.

Returns:

This

setDefaultClassResolver

public final ApplicationSettings setDefaultClassResolver(IClassResolver defaultClassResolver)

Sets the default class resolver to use when finding classes.

Parameters:

defaultClassResolver - The default class resolver

Returns:

This

setDefaultLocale

public final void setDefaultLocale(java.util.Locale defaultLocale)

Parameters:

defaultLocale - The defaultLocale to set.

setDefaultPageFactory

public final ApplicationSettings setDefaultPageFactory(IPageFactory defaultPageFactory)

Sets the default factory to be used when creating pages.

Parameters:

defaultPageFactory - The default factory

Returns:

This

setEncryptionKey

public final ApplicationSettings setEncryptionKey(java.lang.String encryptionKey)

Set encryption key used to encode/decode PasswordTextFields e.g.

Parameters:

encryptionKey -

Returns:

This

setDefaultMarkupEncoding

public final void setDefaultMarkupEncoding(java.lang.String encoding)

Set default encoding for markup files. If null, the encoding provided by the operating system will be used.

Parameters:

encoding -

Since:

1.1

setMaxPages

public final ApplicationSettings setMaxPages(int maxPages)

Sets the maximum number of pages held in a session. If a page is added to a user's session when the session is full, the oldest page in the session will be expired. The primary purpose of setting a maximum number of pages in a session is to limit the resources consumed by server-side state.

Parameters:

maxPages - The maxPages to set.

Returns:

This

setMaxPageVersions

public final void setMaxPageVersions(int maxPageVersions)

Parameters:

maxPageVersions - The maxPageVersion to set.

setRenderStrategy

public final void setRenderStrategy(ApplicationSettings.RenderStrategy renderStrategy)

Sets in what way the render part of a request is handled. Basically, there are two different options:

• Direct, ApplicationSettings.ONE_PASS_RENDER. Everything is handled in one physical request. This is efficient, and is the best option if you want to do sophisticated clustering. It does not however, shield you from what is commonly known as the Double submit problem
• Using a redirect. This follows the pattern as described at the serverside and that is commonly known as Redirect after post. Wicket takes it one step further to do any rendering after a redirect, so that not only form submits are shielded from the double submit problem, but also the IRequestListener handlers (that could be e.g. a link that deletes a row). With this pattern, you have two options to choose from:
  • ApplicationSettings.REDIRECT_TO_RENDER. This option first handles the 'action' part of the request, which is either page construction (bookmarkable pages or the home page) or calling a IRequestListener handler, such as Link.onClick. When that part is done, a redirect is issued to the render part, which does all the rendering of the page and its components. Be aware that this may mean, depending on whether you access any models in the action part of the request, that attachement and detachement of some models is done twice for a request.
  • ApplicationSettings.REDIRECT_TO_BUFFER. This option handles both the action- and the render part of the request in one physical request, but instead of streaming the result to the browser directly, it is kept in memory, and a redirect is issue to get this buffered result (after which it is immediately removed). This option currently is the default render strategy, as it shields you from the double submit problem, while being more efficient and less error prone regarding to detachable models.
  Note that this parameter sets the default behaviour, but that you can manually set whether any redirecting is done by calling method RequestCycle.setRedirect. Setting the redirect flag when the application is configured to use ONE_PASS_RENDER, will result in a redirect of type REDIRECT_TO_RENDER. When the application is configured to use REDIRECT_TO_RENDER or REDIRECT_TO_BUFFER, setting the redirect flag to false, will result in that request begin rendered and streamed in one pass.

  Parameters:

  renderStrategy - the render strategy that should be used by default.

setResourceFinder

public final ApplicationSettings 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

Returns:

This

setResourcePollFrequency

public final ApplicationSettings 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

Returns:

This

See Also:

setResourceFinder(IResourceFinder)

setStripComments

public final ApplicationSettings setStripComments(boolean stripComments)

Enables stripping of markup comments denoted in markup by HTML comment tagging.

Parameters:

stripComments - True to strip markup comments from rendered pages

Returns:

This

setStripWicketTags

public final ApplicationSettings setStripWicketTags(boolean stripWicketTags)

Sets whether to remove wicket tags from the output.

Parameters:

stripWicketTags - whether to remove wicket tags from the output

Returns:

This

setStripXmlDeclarationFromOutput

public final void setStripXmlDeclarationFromOutput(boolean strip)

Parameters:

strip - if true, xml declaration will be stripped from output

Since:

1.1

setThrowExceptionOnMissingResource

public final ApplicationSettings setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)

Parameters:

throwExceptionOnMissingResource - Whether to throw an exception when a missing resource is requested

Returns:

This

setUnexpectedExceptionDisplay

public final ApplicationSettings setUnexpectedExceptionDisplay(ApplicationSettings.UnexpectedExceptionDisplay unexpectedExceptionDisplay)

The exception display type determines how the framework displays exceptions to you as a developer or user.

The default value for exception display type is SHOW_EXCEPTION_PAGE. When this value is set and an unhandled runtime exception is thrown by a page, a redirect to a helpful exception display page will occur.

This is a developer feature, however, and you may want to instead show an internal error page without developer details that allows a user to start over at the application's home page. This can be accomplished by setting the exception display type to SHOW_INTERNAL_ERROR_PAGE.

Finally, if you are having trouble with the exception display pages themselves, you can disable exception displaying entirely with the value SHOW_NO_EXCEPTION_PAGE. This will cause the framework to re-throw any unhandled runtime exceptions after wrapping them in a ServletException wrapper.

Parameters:

unexpectedExceptionDisplay - The unexpectedExceptionDisplay to set.

Returns:

This

setUseDefaultOnMissingResource

public final ApplicationSettings setUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)

Parameters:

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

Returns:

This

setVersionPagesByDefault

public final void setVersionPagesByDefault(boolean pagesVersionedByDefault)

Parameters:

pagesVersionedByDefault - The pagesVersionedByDefault to set.

newResourceFinder

protected IResourceFinder newResourceFinder()

This method returns a default Path object. Subclasses should override this implementation to return any specialized ResourceFinder.

Returns:

IResourceFinder implementation

getStringResourceLoaders

final java.util.List getStringResourceLoaders()

Internal method to expose the string resource loaders configured within the settings to the localization helpers that need to work with them.

Returns:

The string resource loaders

getResponseRequestEncoding

public final java.lang.String getResponseRequestEncoding()

In order to do proper form parameter decoding it is important that the response and the following request have the same encoding. see http://www.crazysquirrel.com/computing/general/form-encoding.jspx for additional information.

Returns:

The request and response encoding

setResponseRequestEncoding

public final void setResponseRequestEncoding(java.lang.String responseRequestEncoding)

In order to do proper form parameter decoding it is important that the response and the following request have the same encoding. see http://www.crazysquirrel.com/computing/general/form-encoding.jspx for additional information. Default encoding: UTF-8

Parameters:

responseRequestEncoding - The request and response encoding to be used.

setValidatorResourceKeyFactory

public void setValidatorResourceKeyFactory(IValidatorResourceKeyFactory factory)

This method is used to replace the default IValidatorResourceKeyFactory implementation with a user specific one

Parameters:

factory - the user defined implementation of IValidatorResourceKeyFactory

getValidatorResourceKey

public java.lang.String getValidatorResourceKey(IValidator validator,
                                                FormComponent formComponent)

This method builds a resource key for use by form component validators using IValidatorResourceKeyFactory.

Parameters:

validator - the validator that is processing the error

formComponent - the form component that is in error

Returns:

resource key for validator's error message

See Also:

IValidatorResourceKeyFactory, DefaultValidatorResourceKeyFactory