|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.wicket.settings.Settings
public final class Settings
Contains settings exposed via IXXXSettings interfaces. It is not a good idea to use this class directly, instead use the provided IXXXSettings interfaces.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface org.apache.wicket.settings.IExceptionSettings |
|---|
IExceptionSettings.UnexpectedExceptionDisplay |
| Nested classes/interfaces inherited from interface org.apache.wicket.settings.IRequestCycleSettings |
|---|
IRequestCycleSettings.RenderStrategy |
| Field Summary |
|---|
| Fields inherited from interface org.apache.wicket.settings.IExceptionSettings |
|---|
SHOW_EXCEPTION_PAGE, SHOW_INTERNAL_ERROR_PAGE, SHOW_NO_EXCEPTION_PAGE |
| Fields inherited from interface org.apache.wicket.settings.IRequestCycleSettings |
|---|
ONE_PASS_RENDER, REDIRECT_TO_BUFFER, REDIRECT_TO_RENDER |
| Fields inherited from interface org.apache.wicket.settings.ISecuritySettings |
|---|
DEFAULT_ENCRYPTION_KEY |
| Constructor Summary | |
|---|---|
Settings(Application application)
Create the application settings, carrying out any necessary initializations. |
|
| Method Summary | |
|---|---|
void |
addComponentResolver(IComponentResolver resolver)
Adds a component resolver to the list. |
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. use when searching for resources. |
void |
addResponseFilter(IResponseFilter responseFilter)
Adds a response filter to the list. |
void |
addStringResourceLoader(IStringResourceLoader loader)
Add a string resource loader to the chain of loaders. |
java.lang.Class |
getAccessDeniedPage()
Gets the access denied page class. |
boolean |
getAddLastModifiedTimeToResourceReferenceUrl()
Returns whether Wicket should add last modified time as resource reference URL parameter. |
IAuthorizationStrategy |
getAuthorizationStrategy()
Gets the authorization strategy. |
boolean |
getAutomaticLinking()
If true, automatic link resolution is enabled. |
boolean |
getAutomaticMultiWindowSupport()
Gets whether Wicket should try to support opening multiple windows for the same session transparently. |
boolean |
getBufferResponse()
|
IClassResolver |
getClassResolver()
Gets the default resolver to use when finding classes |
java.util.List |
getComponentResolvers()
Get the (modifiable) list of IComponentResolvers. |
boolean |
getComponentUseCheck()
|
boolean |
getCompressWhitespace()
|
CookieValuePersisterSettings |
getCookieValuePersisterSettings()
Get the defaults to be used by persistence manager |
ICryptFactory |
getCryptFactory()
|
java.lang.String |
getDefaultAfterDisabledLink()
|
java.lang.String |
getDefaultBeforeDisabledLink()
|
java.lang.String |
getDefaultMarkupEncoding()
|
Bytes |
getDefaultMaximumUploadSize()
Gets the default maximum size for uploads. |
boolean |
getDisableGZipCompression()
Whether to disable gzip compression for resources. |
boolean |
getEnforceMounts()
Gets whether mounts should be enforced. |
boolean |
getGatherExtendedBrowserInfo()
Gets whether Wicket should try to get extensive client info by redirecting to a page that polls for client capabilities. |
java.lang.Class |
getInternalErrorPage()
Gets internal error page class. |
Localizer |
getLocalizer()
Get the application's localizer. |
IMarkupCache |
getMarkupCache()
The markup cache also loads the markup if not yet available in the cache. |
IMarkupParserFactory |
getMarkupParserFactory()
|
int |
getMaxPageMaps()
Gets maximum number of page maps allowed in this session |
IPackageResourceGuard |
getPackageResourceGuard()
Gets the package resource guard. |
java.lang.Class |
getPageExpiredErrorPage()
Gets the page expired page class. |
IPageFactory |
getPageFactory()
Gets the factory to be used when creating pages |
IPageMapEvictionStrategy |
getPageMapEvictionStrategy()
Gets the strategy for evicting pages from the page map. |
IPropertiesFactory |
getPropertiesFactory()
Get the property factory which will be used to load property files |
boolean |
getRecordSessionSize()
|
IRequestCycleSettings.RenderStrategy |
getRenderStrategy()
Gets in what way the render part of a request is handled. |
int |
getRequestsWindowSize()
|
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 |
getResponseFilters()
|
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. |
java.util.List |
getStringResourceLoaders()
|
boolean |
getStripComments()
|
boolean |
getStripJavascriptCommentsAndWhitespace()
|
boolean |
getStripWicketTags()
Gets whether to remove wicket tags from the output. |
boolean |
getStripXmlDeclarationFromOutput()
|
boolean |
getThrowExceptionOnMissingResource()
|
boolean |
getThrowExceptionOnMissingXmlDeclaration()
|
Duration |
getTimeout()
Gets the time that a request will by default be waiting for the previous request to be handled before giving up. |
IUnauthorizedComponentInstantiationListener |
getUnauthorizedComponentInstantiationListener()
|
IExceptionSettings.UnexpectedExceptionDisplay |
getUnexpectedExceptionDisplay()
|
boolean |
getUseDefaultOnMissingResource()
|
java.lang.String |
getVersion()
Gets the Wicket version. |
boolean |
getVersionPagesByDefault()
|
boolean |
isAjaxDebugModeEnabled()
Returns status of ajax debug mode. |
boolean |
isLinePreciseReportingOnAddComponentEnabled()
Returns status of line precise error reporting for added components that are not present in the markup: it points to the line where the component was added to the hierarchy in your Java classes. |
boolean |
isLinePreciseReportingOnNewComponentEnabled()
Returns status of line precise error reporting for new components that are not present in the markup: it points to the line where the component was created in your Java classes. |
boolean |
isOutputMarkupContainerClassName()
Returns whether the output of markup container's should be wrapped by comments containing the container's class name. |
boolean |
isPageIdUniquePerSession()
Returns whether the page id is unique per session. |
boolean |
isRequestLoggerEnabled()
|
void |
setAccessDeniedPage(java.lang.Class accessDeniedPage)
Sets the access denied page class. |
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 |
setAjaxDebugModeEnabled(boolean enable)
Enables or disables ajax debug mode. |
void |
setAuthorizationStrategy(IAuthorizationStrategy strategy)
Sets the authorization strategy. |
void |
setAutomaticLinking(boolean automaticLinking)
Application default for automatic link resolution. |
void |
setAutomaticMultiWindowSupport(boolean automaticMultiWindowSupport)
Sets whether Wicket should try to support opening multiple windows for the same session transparently. |
void |
setBufferResponse(boolean bufferResponse)
|
void |
setClassResolver(IClassResolver defaultClassResolver)
Sets the default class resolver to use when finding classes. |
void |
setComponentUseCheck(boolean componentUseCheck)
Sets componentUseCheck debug settings |
void |
setCompressWhitespace(boolean compressWhitespace)
Turns on whitespace compression. |
void |
setCookieValuePersisterSettings(CookieValuePersisterSettings cookieValuePersisterSettings)
|
void |
setCryptFactory(ICryptFactory cryptFactory)
Sets the factory that will be used to create crypt objects. |
void |
setDefaultAfterDisabledLink(java.lang.String defaultAfterDisabledLink)
|
void |
setDefaultBeforeDisabledLink(java.lang.String defaultBeforeDisabledLink)
|
void |
setDefaultMarkupEncoding(java.lang.String encoding)
Set default encoding for markup files. |
void |
setDefaultMaximumUploadSize(Bytes defaultMaximumUploadSize)
Sets the default maximum size for uploads. |
void |
setDisableGZipCompression(boolean disableGZipCompression)
Sets whether to disable gzip compression for resources. |
void |
setEnforceMounts(boolean enforce)
Sets whether mounts should be enforced. |
void |
setGatherExtendedBrowserInfo(boolean gatherExtendedBrowserInfo)
Sets whether Wicket should try to get extensive client info by redirecting to a page that polls for client capabilities. |
void |
setInternalErrorPage(java.lang.Class internalErrorPage)
Sets internal error page class. |
void |
setLinePreciseReportingOnAddComponentEnabled(boolean enable)
Enables line precise error reporting for added components that are not present in the markup: it points to the line where the component was added to the hierarchy in your Java classes. |
void |
setLinePreciseReportingOnNewComponentEnabled(boolean enable)
Enables line precise error reporting for new components that are not present in the markup: it points to the line where the component was created in your Java classes. |
void |
setLocalizer(Localizer localizer)
Sets the localizer which will be used to find property values. |
void |
setMarkupCache(IMarkupCache markupCache)
Sets a new markup cache which will also be used to load markup if not yet available in the cache. |
void |
setMarkupParserFactory(IMarkupParserFactory factory)
Sets the markup parser factory that will be used to generate parsers for markup. |
void |
setMaxPageMaps(int maxPageMaps)
Sets maximum number of page maps allowed in this session |
void |
setOutputMarkupContainerClassName(boolean enable)
Enables wrapping output of markup container in html comments that contain markup container's class name. |
void |
setPackageResourceGuard(IPackageResourceGuard packageResourceGuard)
Sets the package resource guard. |
void |
setPageExpiredErrorPage(java.lang.Class pageExpiredErrorPage)
Sets the page expired page class. |
void |
setPageFactory(IPageFactory defaultPageFactory)
Sets the factory to be used when creating pages. |
void |
setPageIdUniquePerSession(boolean value)
Sets whether the id of a page should be unique across the entire session. |
void |
setPageMapEvictionStrategy(IPageMapEvictionStrategy pageMapEvictionStrategy)
Sets the strategy for evicting pages from the page map. |
void |
setPropertiesFactory(IPropertiesFactory factory)
Set the property factory which will be used to load property files |
void |
setRecordSessionSize(boolean record)
Enable/Disable the recording of the session size for every request. |
void |
setRenderStrategy(IRequestCycleSettings.RenderStrategy renderStrategy)
Sets in what way the render part of a request is handled. |
void |
setRequestLoggerEnabled(boolean enable)
Enable/Disable the request logger. |
void |
setRequestsWindowSize(int size)
Set the window of all the requests that is kept in memory for viewing. |
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 |
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. |
void |
setStripComments(boolean stripComments)
Enables stripping of markup comments denoted in markup by HTML comment tagging. |
void |
setStripJavascriptCommentsAndWhitespace(boolean value)
Sets whether the whitespace characters and comments should be stripped for resources served through JavascriptPackageResource |
void |
setStripWicketTags(boolean stripWicketTags)
Sets whether to remove wicket tags from the output. |
void |
setStripXmlDeclarationFromOutput(boolean strip)
|
void |
setThrowExceptionOnMissingResource(boolean throwExceptionOnMissingResource)
|
void |
setThrowExceptionOnMissingXmlDeclaration(boolean throwException)
If true, an exception is thrown if the markup file does not contain a xml declaration |
void |
setTimeout(Duration timeout)
Sets the time that a request will by default be waiting for the previous request to be handled before giving up. |
void |
setUnauthorizedComponentInstantiationListener(IUnauthorizedComponentInstantiationListener unauthorizedComponentInstantiationListener)
|
void |
setUnexpectedExceptionDisplay(IExceptionSettings.UnexpectedExceptionDisplay unexpectedExceptionDisplay)
The exception display type determines how the framework displays exceptions to you as a developer or user. |
void |
setUseDefaultOnMissingResource(boolean useDefaultOnMissingResource)
|
void |
setVersionPagesByDefault(boolean pagesVersionedByDefault)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Settings(Application application)
application - The application that these settings are for| Method Detail |
|---|
public void addComponentResolver(IComponentResolver resolver)
IPageSettings
addComponentResolver in interface IPageSettingsresolver - The IComponentResolver that is addedIPageSettings.addComponentResolver(org.apache.wicket.markup.resolver.IComponentResolver)
public void addResourceFactory(java.lang.String name,
IResourceFactory resourceFactory)
IResourceSettings
addResourceFactory in interface IResourceSettingsname - The name to give to the factoryresourceFactory - The resource factory to addIResourceSettings.addResourceFactory(java.lang.String,
org.apache.wicket.IResourceFactory)public void addResourceFolder(java.lang.String resourceFolder)
IResourceSettings
addResourceFolder in interface IResourceSettingsresourceFolder - The resourceFolder to setIResourceSettings.addResourceFolder(java.lang.String)public void addResponseFilter(IResponseFilter responseFilter)
IRequestCycleSettings
addResponseFilter in interface IRequestCycleSettingsresponseFilter - The IResponseFilter that is addedIRequestCycleSettings.addResponseFilter(org.apache.wicket.IResponseFilter)public void addStringResourceLoader(IStringResourceLoader loader)
IResourceSettings
addStringResourceLoader in interface IResourceSettingsloader - The loader to be addedIResourceSettings.addStringResourceLoader(org.apache.wicket.resource.loader.IStringResourceLoader)public java.lang.Class getAccessDeniedPage()
IApplicationSettings
getAccessDeniedPage in interface IApplicationSettingsIApplicationSettings.getAccessDeniedPage()public IAuthorizationStrategy getAuthorizationStrategy()
ISecuritySettings
getAuthorizationStrategy in interface ISecuritySettingsISecuritySettings.getAuthorizationStrategy()public boolean getAutomaticLinking()
IMarkupSettings
getAutomaticLinking in interface IMarkupSettingsIMarkupSettings.getAutomaticLinking()public boolean getAutomaticMultiWindowSupport()
IPageSettings
Currently, Wicket trying to do this is a best effort that is not completely fail
safe. When the client does not support cookies, support gets tricky and incomplete. See
WebPage's internals for the implementation.
getAutomaticMultiWindowSupport in interface IPageSettingsIPageSettings.getAutomaticMultiWindowSupport()public boolean getBufferResponse()
getBufferResponse in interface IRequestCycleSettingsIRequestCycleSettings.getBufferResponse()public IClassResolver getClassResolver()
IApplicationSettings
getClassResolver in interface IApplicationSettingsIApplicationSettings.getClassResolver()public java.util.List getComponentResolvers()
getComponentResolvers in interface IPageSettingsfor an examplepublic boolean getComponentUseCheck()
getComponentUseCheck in interface IDebugSettingsIDebugSettings.getComponentUseCheck()public boolean getCompressWhitespace()
getCompressWhitespace in interface IMarkupSettingsIMarkupSettings.getCompressWhitespace()public CookieValuePersisterSettings getCookieValuePersisterSettings()
ISecuritySettings
getCookieValuePersisterSettings in interface ISecuritySettingsISecuritySettings.getCookieValuePersisterSettings()public ICryptFactory getCryptFactory()
getCryptFactory in interface ISecuritySettingsISecuritySettings.getCryptFactory()public java.lang.String getDefaultAfterDisabledLink()
getDefaultAfterDisabledLink in interface IMarkupSettingsIMarkupSettings.getDefaultAfterDisabledLink()public java.lang.String getDefaultBeforeDisabledLink()
getDefaultBeforeDisabledLink in interface IMarkupSettingsIMarkupSettings.getDefaultBeforeDisabledLink()public java.lang.String getDefaultMarkupEncoding()
getDefaultMarkupEncoding in interface IMarkupSettingsIMarkupSettings.getDefaultMarkupEncoding()public boolean getDisableGZipCompression()
IResourceSettings
getDisableGZipCompression in interface IResourceSettingsIResourceSettings.getDisableGZipCompression()public boolean getEnforceMounts()
ISecuritySettings
getEnforceMounts in interface ISecuritySettingsISecuritySettings.getEnforceMounts()public boolean getGatherExtendedBrowserInfo()
IRequestCycleSettingsa page that polls for client capabilities. This method is used by
the default implementation of WebRequestCycle.newClientInfo(), so if that method is
overridden, there is no guarantee this method will be taken into account.
getGatherExtendedBrowserInfo in interface IRequestCycleSettingsIRequestCycleSettings.getGatherExtendedBrowserInfo()public java.lang.Class getInternalErrorPage()
IApplicationSettings
getInternalErrorPage in interface IApplicationSettingsIApplicationSettings.getInternalErrorPage()public Localizer getLocalizer()
IResourceSettings
getLocalizer in interface IResourceSettingsIResourceSettings.getLocalizer()public void setLocalizer(Localizer localizer)
IResourceSettings
setLocalizer in interface IResourceSettingsIResourceSettings.setLocalizer(org.apache.wicket.Localizer)public IMarkupParserFactory getMarkupParserFactory()
getMarkupParserFactory in interface IMarkupSettingsIMarkupSettings.getMarkupParserFactory()public final int getMaxPageMaps()
ISessionSettings
getMaxPageMaps in interface ISessionSettingsISessionSettings.getMaxPageMaps()public IPackageResourceGuard getPackageResourceGuard()
IResourceSettingspackage resource guard.
getPackageResourceGuard in interface IResourceSettingsIResourceSettings.getPackageResourceGuard()public java.lang.Class getPageExpiredErrorPage()
IApplicationSettings
getPageExpiredErrorPage in interface IApplicationSettingsIApplicationSettings.getPageExpiredErrorPage()public IPageFactory getPageFactory()
ISessionSettings
getPageFactory in interface ISessionSettingsISessionSettings.getPageFactory()public IPageMapEvictionStrategy getPageMapEvictionStrategy()
ISessionSettings
getPageMapEvictionStrategy in interface ISessionSettingsISessionSettings.getPageMapEvictionStrategy()public IPropertiesFactory getPropertiesFactory()
IResourceSettings
getPropertiesFactory in interface IResourceSettingsIResourceSettings.getPropertiesFactory()public IRequestCycleSettings.RenderStrategy getRenderStrategy()
IRequestCycleSettings
getRenderStrategy in interface IRequestCycleSettingsIRequestCycleSettings.getRenderStrategy()public IResourceFactory getResourceFactory(java.lang.String name)
getResourceFactory in interface IResourceSettingsname - Name of the factory to get
IResourceSettings.getResourceFactory(java.lang.String)public IResourceFinder getResourceFinder()
IResourceSettings
getResourceFinder in interface IResourceSettingsIResourceSettings.getResourceFinder()public Duration getResourcePollFrequency()
getResourcePollFrequency in interface IResourceSettingsIResourceSettings.getResourcePollFrequency()public IResourceStreamLocator getResourceStreamLocator()
getResourceStreamLocator in interface IResourceSettingsIResourceSettings.getResourceStreamLocator()public ModificationWatcher getResourceWatcher(boolean start)
getResourceWatcher in interface IResourceSettingsstart - boolean if the resource watcher should be started if not already started.
IResourceSettings.getResourceWatcher(boolean)public java.util.List getResponseFilters()
getResponseFilters in interface IRequestCycleSettingsIRequestCycleSettings.getResponseFilters()public java.lang.String getResponseRequestEncoding()
IRequestCycleSettings
getResponseRequestEncoding in interface IRequestCycleSettingsIRequestCycleSettings.getResponseRequestEncoding()public java.util.List getStringResourceLoaders()
getStringResourceLoaders in interface IResourceSettingsIResourceSettings.getStringResourceLoaders()public boolean getStripComments()
getStripComments in interface IMarkupSettingsIMarkupSettings.getStripComments()public boolean getStripWicketTags()
IMarkupSettings
getStripWicketTags in interface IMarkupSettingsIMarkupSettings.getStripWicketTags()public boolean getStripXmlDeclarationFromOutput()
getStripXmlDeclarationFromOutput in interface IMarkupSettingsIMarkupSettings.getStripXmlDeclarationFromOutput()public boolean getThrowExceptionOnMissingResource()
getThrowExceptionOnMissingResource in interface IExceptionSettingsgetThrowExceptionOnMissingResource in interface IResourceSettingsIResourceSettings.getThrowExceptionOnMissingResource()public Duration getTimeout()
IRequestCycleSettings
getTimeout in interface IRequestCycleSettingsIRequestCycleSettings.getTimeout()public IUnauthorizedComponentInstantiationListener getUnauthorizedComponentInstantiationListener()
getUnauthorizedComponentInstantiationListener in interface ISecuritySettingsISecuritySettings.getUnauthorizedComponentInstantiationListener()public IExceptionSettings.UnexpectedExceptionDisplay getUnexpectedExceptionDisplay()
getUnexpectedExceptionDisplay in interface IExceptionSettingsgetUnexpectedExceptionDisplay in interface IRequestCycleSettingsIRequestCycleSettings.getUnexpectedExceptionDisplay()public boolean getUseDefaultOnMissingResource()
getUseDefaultOnMissingResource in interface IResourceSettingsIResourceSettings.getUseDefaultOnMissingResource()public java.lang.String getVersion()
IFrameworkSettings
getVersion in interface IFrameworkSettingsIFrameworkSettings.getVersion()public boolean getVersionPagesByDefault()
getVersionPagesByDefault in interface IPageSettingsIPageSettings.getVersionPagesByDefault()public boolean isAjaxDebugModeEnabled()
IDebugSettingsIDebugSettings for
details
isAjaxDebugModeEnabled in interface