IcefacesProperties

java.lang.Object
- org.joinfaces.autoconfigure.icefaces.IcefacesProperties

```
@ConfigurationProperties(value="jsf.icefaces")
public class IcefacesProperties
extends java.lang.Object
```
Configuration properties for ICEfaces.

See Also:

http://www.icesoft.org/wiki/display/ICE/Configuration+Parameters

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IcefacesProperties.Ace

static class IcefacesProperties.FileEntry

static class IcefacesProperties.Render

Nested Classes
Modifier and Type	Class and Description
`static class`	`IcefacesProperties.Ace`
`static class`	`IcefacesProperties.FileEntry`
`static class`	`IcefacesProperties.Render`

Constructor Summary

Constructors
Constructor and Description

IcefacesProperties()

Constructors
Constructor and Description
`IcefacesProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(java.lang.Object other)`
`boolean`	`equals(java.lang.Object o)`
`IcefacesProperties.Ace`	`getAce()`
`java.lang.Boolean`	`getAutoid()` Setting org.icefaces.autoid to true causes the majority of standard JSF components to write their IDs to the page.
`java.lang.Boolean`	`getBlockUiOnSubmit()` Setting org.icefaces.blockUIOnSubmit to true tells ICEfaces that the user interface (UI) should block any subsequent requests until the current request has been processed.
`java.lang.Boolean`	`getClientSideElementUpdateDetermination()` Applications or components that use ice.onElementUpdate javascript registration function can choose to use server or client side implementation for the callback matching of the elements that were updated or removed from the document.
`java.lang.Boolean`	`getCoalesceResources()` Setting org.icefaces.coalesceResources to true indicates to the ICEfaces core framework that the resources required by the rendered components are to be coalesced.
`java.lang.Boolean`	`getCompressDom()` Setting org.icefaces.compressDOM to true indicates to the ICEfaces core framework that the server-side DOM representation of the current view should be serialized and compressed between requests.
`java.lang.Boolean`	`getCompressResources()` By default, ICEfaces will not gzip compress any resource responses.
`java.lang.String`	`getConnectionLostRedirectUri()` Setting org.icefaces.connectionLostRedirectURI to a valid URI tells ICEfaces that when the Ajax Push connection is lost, that the client is to be redirected to the specified page.
`java.lang.Boolean`	`getDeltaSubmit()` Setting org.icefaces.deltaSubmit to true tells ICEfaces that form submission should be handled in a special way to minimize what is sent across the wire.
`java.lang.Boolean`	`getDisableDefaultErrorPopups()` This parameter can be used to disable the popups rendered by default when a network error, session expiry or server error occurs.
`java.lang.Boolean`	`getFetchPendingNotificationsOnLoad()` The default value of true for org.icefaces.fetchPendingNotificationsOnLoad indicates that whenever the blocking connection switches over to another window each window will issue a request for the updates that were potentially issued during the switch.
`IcefacesProperties.FileEntry`	`getFileEntry()`
`java.lang.Boolean`	`getFocusManaged()` By default, when ICEfaces is available, focus retention will ensure that the focused element in the page preserves its focus when the partial update modified the element.
`java.lang.Boolean`	`getGenerateHeadUpdate()` This parameter can be used to enable (or disable) successful update of the HTML head element.
`java.lang.Boolean`	`getLazyPush()` By default, when using Ajax Push, the feature is activated in a lazy fashion.
`java.lang.Boolean`	`getLazyWindowScope()` By default, when using window-scoped beans, the window management is activated in a lazy fashion.
`java.util.List<java.lang.String>`	`getMandatoryResourceConfiguration()` The org.icefaces.mandatoryResourceConfiguration context-parameter may be set to one of three values: none, all, or a space delimited list of components.
`java.lang.Boolean`	`getMessagePersistence()` By default, when ICEfaces is available, FacesMessages are persisted across different partial submits from the same page.
`java.lang.String`	`getPublicContextPath()` Setting org.icefaces.publicContextPath to a valid path tells ICEfaces to replace the natural context path (usually, the web-application name) of all resources, form URLs, local bookmarks and local redirects to the specified path.
`IcefacesProperties.Render`	`getRender()`
`java.lang.Boolean`	`getReplayNavigationOnReload()` This parameter can be used to replay the navigation rules when the page is reloaded.
`java.lang.String`	`getSessionExpiredRedirectUri()` Setting org.icefaces.sessionExpiredRedirectURI to a valid URI tells ICEfaces that when the user session expires, that the client is to be redirected to the specified page.
`java.lang.String`	`getSessionTimeoutRedirectUri()` Setting org.icefaces.sessionTimeoutRedirectURII to a valid URI tells ICEfaces that when the user session expires due to user inactivity, that the client is to be redirected to the specified page.
`java.lang.Boolean`	`getStandardFormSerialization()` By default, ICEfaces does optimized serialization and submission of form elements based on the element that triggered the submission.
`java.lang.Boolean`	`getStrictSessionTimeout()` The default value of false for org.icefaces.strictSessionTimeout indicates that ICEfaces should not interfere with container-managed control of session timeout.
`java.lang.Boolean`	`getSubtreeDiff()` By default, when using ICEfaces, Ajax-specified subtree diffing is always done.
`java.lang.Boolean`	`getUniqueResourceUrls()` The default value of "true" will cause ICEfaces to append random numbers to certain resource URLs, thereby preventing caching.
`java.util.List<java.lang.String>`	`getVersionableTypes()` By default, ICEfaces adds a version number parameter to the URL of most resource types.
`java.time.Duration`	`getWarnBeforeSessionExpiryInterval()` A value, in milliseconds, indicating the interval of how much earlier the warning that the session is about to expire is to be issued.
`java.time.Duration`	`getWindowScopeExpiration()` A value, in milliseconds, indicating how long window-scoped values should remain valid in the session after a reload or redirect occurs.
`int`	`hashCode()`
`void`	`setAutoid(java.lang.Boolean autoid)` Setting org.icefaces.autoid to true causes the majority of standard JSF components to write their IDs to the page.
`void`	`setBlockUiOnSubmit(java.lang.Boolean blockUiOnSubmit)` Setting org.icefaces.blockUIOnSubmit to true tells ICEfaces that the user interface (UI) should block any subsequent requests until the current request has been processed.
`void`	`setClientSideElementUpdateDetermination(java.lang.Boolean clientSideElementUpdateDetermination)` Applications or components that use ice.onElementUpdate javascript registration function can choose to use server or client side implementation for the callback matching of the elements that were updated or removed from the document.
`void`	`setCoalesceResources(java.lang.Boolean coalesceResources)` Setting org.icefaces.coalesceResources to true indicates to the ICEfaces core framework that the resources required by the rendered components are to be coalesced.
`void`	`setCompressDom(java.lang.Boolean compressDom)` Setting org.icefaces.compressDOM to true indicates to the ICEfaces core framework that the server-side DOM representation of the current view should be serialized and compressed between requests.
`void`	`setCompressResources(java.lang.Boolean compressResources)` By default, ICEfaces will not gzip compress any resource responses.
`void`	`setConnectionLostRedirectUri(java.lang.String connectionLostRedirectUri)` Setting org.icefaces.connectionLostRedirectURI to a valid URI tells ICEfaces that when the Ajax Push connection is lost, that the client is to be redirected to the specified page.
`void`	`setDeltaSubmit(java.lang.Boolean deltaSubmit)` Setting org.icefaces.deltaSubmit to true tells ICEfaces that form submission should be handled in a special way to minimize what is sent across the wire.
`void`	`setDisableDefaultErrorPopups(java.lang.Boolean disableDefaultErrorPopups)` This parameter can be used to disable the popups rendered by default when a network error, session expiry or server error occurs.
`void`	`setFetchPendingNotificationsOnLoad(java.lang.Boolean fetchPendingNotificationsOnLoad)` The default value of true for org.icefaces.fetchPendingNotificationsOnLoad indicates that whenever the blocking connection switches over to another window each window will issue a request for the updates that were potentially issued during the switch.
`void`	`setFocusManaged(java.lang.Boolean focusManaged)` By default, when ICEfaces is available, focus retention will ensure that the focused element in the page preserves its focus when the partial update modified the element.
`void`	`setGenerateHeadUpdate(java.lang.Boolean generateHeadUpdate)` This parameter can be used to enable (or disable) successful update of the HTML head element.
`void`	`setLazyPush(java.lang.Boolean lazyPush)` By default, when using Ajax Push, the feature is activated in a lazy fashion.
`void`	`setLazyWindowScope(java.lang.Boolean lazyWindowScope)` By default, when using window-scoped beans, the window management is activated in a lazy fashion.
`void`	`setMandatoryResourceConfiguration(java.util.List<java.lang.String> mandatoryResourceConfiguration)` The org.icefaces.mandatoryResourceConfiguration context-parameter may be set to one of three values: none, all, or a space delimited list of components.
`void`	`setMessagePersistence(java.lang.Boolean messagePersistence)` By default, when ICEfaces is available, FacesMessages are persisted across different partial submits from the same page.
`void`	`setPublicContextPath(java.lang.String publicContextPath)` Setting org.icefaces.publicContextPath to a valid path tells ICEfaces to replace the natural context path (usually, the web-application name) of all resources, form URLs, local bookmarks and local redirects to the specified path.
`void`	`setReplayNavigationOnReload(java.lang.Boolean replayNavigationOnReload)` This parameter can be used to replay the navigation rules when the page is reloaded.
`void`	`setSessionExpiredRedirectUri(java.lang.String sessionExpiredRedirectUri)` Setting org.icefaces.sessionExpiredRedirectURI to a valid URI tells ICEfaces that when the user session expires, that the client is to be redirected to the specified page.
`void`	`setSessionTimeoutRedirectUri(java.lang.String sessionTimeoutRedirectUri)` Setting org.icefaces.sessionTimeoutRedirectURII to a valid URI tells ICEfaces that when the user session expires due to user inactivity, that the client is to be redirected to the specified page.
`void`	`setStandardFormSerialization(java.lang.Boolean standardFormSerialization)` By default, ICEfaces does optimized serialization and submission of form elements based on the element that triggered the submission.
`void`	`setStrictSessionTimeout(java.lang.Boolean strictSessionTimeout)` The default value of false for org.icefaces.strictSessionTimeout indicates that ICEfaces should not interfere with container-managed control of session timeout.
`void`	`setSubtreeDiff(java.lang.Boolean subtreeDiff)` By default, when using ICEfaces, Ajax-specified subtree diffing is always done.
`void`	`setUniqueResourceUrls(java.lang.Boolean uniqueResourceUrls)` The default value of "true" will cause ICEfaces to append random numbers to certain resource URLs, thereby preventing caching.
`void`	`setVersionableTypes(java.util.List<java.lang.String> versionableTypes)` By default, ICEfaces adds a version number parameter to the URL of most resource types.
`void`	`setWarnBeforeSessionExpiryInterval(java.time.Duration warnBeforeSessionExpiryInterval)` A value, in milliseconds, indicating the interval of how much earlier the warning that the session is about to expire is to be issued.
`void`	`setWindowScopeExpiration(java.time.Duration windowScopeExpiration)` A value, in milliseconds, indicating how long window-scoped values should remain valid in the session after a reload or redirect occurs.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IcefacesProperties
```
public IcefacesProperties()
```
- Method Detail
  - getFetchPendingNotificationsOnLoad
```
public java.lang.Boolean getFetchPendingNotificationsOnLoad()
```
    The default value of true for org.icefaces.fetchPendingNotificationsOnLoad indicates that whenever the blocking connection switches over to another window each window will issue a request for the updates that were potentially issued during the switch. In use cases where is reasonable to have the request for updates disabled setting the value to false can decrease the network traffic in applications that use many windows.
    
    Since:
    
    ICEfaces 4.1
  - getGenerateHeadUpdate
```
public java.lang.Boolean getGenerateHeadUpdate()
```
    This parameter can be used to enable (or disable) successful update of the HTML head element. The parameter is usually set in applications where the CSS or Javascript resource references change while interacting with the rendered page. Since ICEfaces 4.0 this feature is enabled by default because most of the times the JSF built-in update handling for the page header does not work.
    
    Since:
    
    ICEfaces 3.1
  - getWarnBeforeSessionExpiryInterval
```
public java.time.Duration getWarnBeforeSessionExpiryInterval()
```
    A value, in milliseconds, indicating the interval of how much earlier the warning that the session is about to expire is to be issued. For details on how to setup a callback that will be invoked on before session expiry see ice.onBeforeSessionExpiry API.
    
    Since:
    
    ICEfaces 3.3
  - getAutoid
```
public java.lang.Boolean getAutoid()
```
    Setting org.icefaces.autoid to true causes the majority of standard JSF components to write their IDs to the page. This allows ICEfaces to apply page updates at a fine granularity. With this parameter set to false, page updates can only be applied for components that have manually specified IDs. This parameter is provided for fallback to completely standard behavior; it is not generally intended to be set to false for application use.
    
    Since:
    
    ICEfaces 2.0
  - getBlockUiOnSubmit
```
public java.lang.Boolean getBlockUiOnSubmit()
```
    Setting org.icefaces.blockUIOnSubmit to true tells ICEfaces that the user interface (UI) should block any subsequent requests until the current request has been processed. This is provided to help prevent double-submits in applications that require this feature.
    
    Since:
    
    ICEfaces 2.0
  - getClientSideElementUpdateDetermination
```
public java.lang.Boolean getClientSideElementUpdateDetermination()
```
    Applications or components that use ice.onElementUpdate javascript registration function can choose to use server or client side implementation for the callback matching of the elements that were updated or removed from the document. The client side implementation can be quite slow in Internet Explorer when large updates are received. Choosing the server side implementation is generally recommended because it is equally fast in all browsers at the expense of some memory and required processing power on the server.
    
    Since:
    
    ICEfaces 3.4
  - getCoalesceResources
```
public java.lang.Boolean getCoalesceResources()
```
    Setting org.icefaces.coalesceResources to true indicates to the ICEfaces core framework that the resources required by the rendered components are to be coalesced. The coalescing is applied to Javascript and CSS resources resulting into two separate resources, one for the coalesced Javascript and the other for the coalesced CSS. By reducing the numbers of requests made by the browser the page load time will improve significantly.
    The feature uses the Resource dependencies metadata to coalesce the resources in the correct order. Any request issued after the first GET request (for the user session) that changes the type and number of required resources will trigger only the loading of the newly required resources. This behaviour avoids the continuous reloading of the coalesced resource, every time the set of required resources has changed.
    mandatoryResourceConfiguration can be used to pre-define the resources that are needed right away (on session start). This way the application can be configured to deterministically coalesce the resources that are known to be used most of the time.
    The default value for the parameter used to enable/disable the coalescing is false.
    
    Since:
    
    ICEfaces 3.3
  - getCompressDom
```
public java.lang.Boolean getCompressDom()
```
    Setting org.icefaces.compressDOM to true indicates to the ICEfaces core framework that the server-side DOM representation of the current view should be serialized and compressed between requests. The default value of false leaves the DOM representation intact between requests.
    
    Since:
    
    ICEfaces 2.0
  - getCompressResources
```
public java.lang.Boolean getCompressResources()
```
    By default, ICEfaces will not gzip compress any resource responses. Setting org.icefaces.compressedResources to true instructs ICEfaces to compress certain resources - namely compat component resources that are served via the CompatResourceServlet and ACE or application resources registered using one of the applicable methods in the ResourceRegistry (e.g. addSessionResource).
    
    Since:
    
    ICEfaces 2.0
  - getConnectionLostRedirectUri
```
public java.lang.String getConnectionLostRedirectUri()
```
    Setting org.icefaces.connectionLostRedirectURI to a valid URI tells ICEfaces that when the Ajax Push connection is lost, that the client is to be redirected to the specified page.
    
    Since:
    
    ICEfaces 2.0
  - getDeltaSubmit
```
public java.lang.Boolean getDeltaSubmit()
```
    Setting org.icefaces.deltaSubmit to true tells ICEfaces that form submission should be handled in a special way to minimize what is sent across the wire. The parameters of a form post are compared to the previous submission and only those that have changed are sent to the server. The rest of the form parameters are reconstructed on the server from the cached DOM and then processed normally.
    
    Since:
    
    ICEfaces 2.0
  - getDisableDefaultErrorPopups
```
public java.lang.Boolean getDisableDefaultErrorPopups()
```
    This parameter can be used to disable the popups rendered by default when a network error, session expiry or server error occurs. The parameter is usually set when an application or component developer wants to have rendered only the defined custom indicators.
    
    Since:
    
    ICEfaces 2.0
  - getFileEntry
```
public IcefacesProperties.FileEntry getFileEntry()
```
  - getFocusManaged
```
public java.lang.Boolean getFocusManaged()
```
    By default, when ICEfaces is available, focus retention will ensure that the focused element in the page preserves its focus when the partial update modified the element. By setting the org.icefaces.focusManaged parameter to false, this feature can be disabled.
    
    Since:
    
    ICEfaces 2.0
  - getAce
```
public IcefacesProperties.Ace getAce()
```
  - getLazyPush
```
public java.lang.Boolean getLazyPush()
```
    By default, when using Ajax Push, the feature is activated in a lazy fashion. This means that the blocking connection used for doing Ajax Push is not activated until the first push is requested. Setting org.icefaces.lazyPush to false tells ICEfaces to automatically activate ICEpush for each session and each page in the entire application.
    
    Since:
    
    ICEfaces 2.0
  - getLazyWindowScope
```
public java.lang.Boolean getLazyWindowScope()
```
    By default, when using window-scoped beans, the window management is activated in a lazy fashion. This means that if there are no window scoped beans or view scoped beans annotated with @WindowDisposed then no dispose-window request is sent upon window closure (detection of window closing is not enabled). Setting org.icefaces.lazyWindowScope to false tells ICEfaces to always send a dispose-window request upon window closure regardless of the window scope map being empty or not. This context parameter is application-wide.
    
    Since:
    
    ICEfaces 3.0
  - getMandatoryResourceConfiguration
```
public java.util.List<java.lang.String> getMandatoryResourceConfiguration()
```
    The org.icefaces.mandatoryResourceConfiguration context-parameter may be set to one of three values: none, all, or a space delimited list of components.
    
    Since:
    
    ICEfaces 2.0
  - getMessagePersistence
```
public java.lang.Boolean getMessagePersistence()
```
    By default, when ICEfaces is available, FacesMessages are persisted across different partial submits from the same page. This is done to better support forms that use incremental validation via singleSubmit tag.
    
    Since:
    
    ICEfaces 3.0
  - getPublicContextPath
```
public java.lang.String getPublicContextPath()
```
    Setting org.icefaces.publicContextPath to a valid path tells ICEfaces to replace the natural context path (usually, the web-application name) of all resources, form URLs, local bookmarks and local redirects to the specified path. This is useful when the application is served publicly through a reverse proxy or load balancer and one wants to avoid defining complex URL rewriting rules.
    
    Since:
    
    ICEfaces 2.0
  - getRender
```
public IcefacesProperties.Render getRender()
```
  - getReplayNavigationOnReload
```
public java.lang.Boolean getReplayNavigationOnReload()
```
    This parameter can be used to replay the navigation rules when the page is reloaded. The parameter is usually set in applications where it is desirable to avoid the content being reset to the first page (before non-redirect navigation was triggered) when reloading.
    
    Since:
    
    ICEfaces 3.0
  - getSessionExpiredRedirectUri
```
public java.lang.String getSessionExpiredRedirectUri()
```
    Setting org.icefaces.sessionExpiredRedirectURI to a valid URI tells ICEfaces that when the user session expires, that the client is to be redirected to the specified page. When using ICEpush, or <icecore:refresh>, the user will be redirected automatically on session expiry. Otherwise, they will be redirected on the next request after session expiry.
    
    Since:
    
    ICEfaces 2.0
  - getSessionTimeoutRedirectUri
```
public java.lang.String getSessionTimeoutRedirectUri()
```
    Setting org.icefaces.sessionTimeoutRedirectURII to a valid URI tells ICEfaces that when the user session expires due to user inactivity, that the client is to be redirected to the specified page. When using ICEpush, or <icecore:refresh>, the user will be redirected automatically on session expiry. Otherwise, they will be redirected on the next request after session expiry.
    
    Since:
    
    ICEfaces EE 4.1.0.GA, EE 3.3.0.GA_P04, 4.2
  - getStandardFormSerialization
```
public java.lang.Boolean getStandardFormSerialization()
```
    By default, ICEfaces does optimized serialization and submission of form elements based on the element that triggered the submission. Setting standardFormSerialization to true indicates that ICEfaces should do a normal, standard, full form submission.
    
    Since:
    
    ICEfaces 2.0
  - getStrictSessionTimeout
```
public java.lang.Boolean getStrictSessionTimeout()
```
    The default value of false for org.icefaces.strictSessionTimeout indicates that ICEfaces should not interfere with container-managed control of session timeout. In this case, each user request and each Ajax Push request will extend the session. Setting org.icefaces.strictSessionTimeout to true indicates that ICEfaces should attempt to enforce the configured session timeout by ignoring any Ajax Push activity so that only user-triggered requests will extend the session.
    
    Since:
    
    ICEfaces 2.0
  - getSubtreeDiff
```
public java.lang.Boolean getSubtreeDiff()
```
    By default, when using ICEfaces, Ajax-specified subtree diffing is always done. Setting org.icefaces.subtreeDiff to false indicates that ICEfaces will not perform a DOM diff on the rendered subtrees. Instead the rendered output of subtrees is sent directly to the browser, thus not updating the server-side DOM.
    
    Since:
    
    ICEfaces 3.0
  - getUniqueResourceUrls
```
public java.lang.Boolean getUniqueResourceUrls()
```
    The default value of "true" will cause ICEfaces to append random numbers to certain resource URLs, thereby preventing caching. This is useful for development, but can interfere with Portlet URL generation.
    
    Since:
    
    ICEfaces 2.0
  - getVersionableTypes
```
public java.util.List<java.lang.String> getVersionableTypes()
```
    By default, ICEfaces adds a version number parameter to the URL of most resource types. The version number parameter is used to ensure that the resources can be cached by the browser and that previously cached resources are not used for newer builds or releases of the software. Normally, the version number parameter consists of the release version of the software (e.g. "3_3_0") and the build date ("130829" - Aug. 29th, 2013) = "v=3_3_0_130829".
    
    Since:
    
    ICEfaces 3.3
  - getWindowScopeExpiration
```
public java.time.Duration getWindowScopeExpiration()
```
    A value, in milliseconds, indicating how long window-scoped values should remain valid in the session after a reload or redirect occurs. This allows for postbacks that might occur quickly after a reload or redirect to successfully retrieve the relevant window-scoped values.
    
    Since:
    
    ICEfaces 2.0
  - setFetchPendingNotificationsOnLoad
```
public void setFetchPendingNotificationsOnLoad(java.lang.Boolean fetchPendingNotificationsOnLoad)
```
    The default value of true for org.icefaces.fetchPendingNotificationsOnLoad indicates that whenever the blocking connection switches over to another window each window will issue a request for the updates that were potentially issued during the switch. In use cases where is reasonable to have the request for updates disabled setting the value to false can decrease the network traffic in applications that use many windows.
    
    Since:
    
    ICEfaces 4.1
  - setGenerateHeadUpdate
```
public void setGenerateHeadUpdate(java.lang.Boolean generateHeadUpdate)
```
    This parameter can be used to enable (or disable) successful update of the HTML head element. The parameter is usually set in applications where the CSS or Javascript resource references change while interacting with the rendered page. Since ICEfaces 4.0 this feature is enabled by default because most of the times the JSF built-in update handling for the page header does not work.
    
    Since:
    
    ICEfaces 3.1
  - setWarnBeforeSessionExpiryInterval
```
public void setWarnBeforeSessionExpiryInterval(java.time.Duration warnBeforeSessionExpiryInterval)
```
    A value, in milliseconds, indicating the interval of how much earlier the warning that the session is about to expire is to be issued. For details on how to setup a callback that will be invoked on before session expiry see ice.onBeforeSessionExpiry API.
    
    Since:
    
    ICEfaces 3.3
  - setAutoid
```
public void setAutoid(java.lang.Boolean autoid)
```
    Setting org.icefaces.autoid to true causes the majority of standard JSF components to write their IDs to the page. This allows ICEfaces to apply page updates at a fine granularity. With this parameter set to false, page updates can only be applied for components that have manually specified IDs. This parameter is provided for fallback to completely standard behavior; it is not generally intended to be set to false for application use.
    
    Since:
    
    ICEfaces 2.0
  - setBlockUiOnSubmit
```
public void setBlockUiOnSubmit(java.lang.Boolean blockUiOnSubmit)
```
    Setting org.icefaces.blockUIOnSubmit to true tells ICEfaces that the user interface (UI) should block any subsequent requests until the current request has been processed. This is provided to help prevent double-submits in applications that require this feature.
    
    Since:
    
    ICEfaces 2.0
  - setClientSideElementUpdateDetermination
```
public void setClientSideElementUpdateDetermination(java.lang.Boolean clientSideElementUpdateDetermination)
```
    Applications or components that use ice.onElementUpdate javascript registration function can choose to use server or client side implementation for the callback matching of the elements that were updated or removed from the document. The client side implementation can be quite slow in Internet Explorer when large updates are received. Choosing the server side implementation is generally recommended because it is equally fast in all browsers at the expense of some memory and required processing power on the server.
    
    Since:
    
    ICEfaces 3.4
  - setCoalesceResources
```
public void setCoalesceResources(java.lang.Boolean coalesceResources)
```
    Setting org.icefaces.coalesceResources to true indicates to the ICEfaces core framework that the resources required by the rendered components are to be coalesced. The coalescing is applied to Javascript and CSS resources resulting into two separate resources, one for the coalesced Javascript and the other for the coalesced CSS. By reducing the numbers of requests made by the browser the page load time will improve significantly.
    The feature uses the Resource dependencies metadata to coalesce the resources in the correct order. Any request issued after the first GET request (for the user session) that changes the type and number of required resources will trigger only the loading of the newly required resources. This behaviour avoids the continuous reloading of the coalesced resource, every time the set of required resources has changed.
    mandatoryResourceConfiguration can be used to pre-define the resources that are needed right away (on session start). This way the application can be configured to deterministically coalesce the resources that are known to be used most of the time.
    The default value for the parameter used to enable/disable the coalescing is false.
    
    Since:
    
    ICEfaces 3.3
  - setCompressDom
```
public void setCompressDom(java.lang.Boolean compressDom)
```
    Setting org.icefaces.compressDOM to true indicates to the ICEfaces core framework that the server-side DOM representation of the current view should be serialized and compressed between requests. The default value of false leaves the DOM representation intact between requests.
    
    Since:
    
    ICEfaces 2.0
  - setCompressResources
```
public void setCompressResources(java.lang.Boolean compressResources)
```
    By default, ICEfaces will not gzip compress any resource responses. Setting org.icefaces.compressedResources to true instructs ICEfaces to compress certain resources - namely compat component resources that are served via the CompatResourceServlet and ACE or application resources registered using one of the applicable methods in the ResourceRegistry (e.g. addSessionResource).
    
    Since:
    
    ICEfaces 2.0
  - setConnectionLostRedirectUri
```
public void setConnectionLostRedirectUri(java.lang.String connectionLostRedirectUri)
```
    Setting org.icefaces.connectionLostRedirectURI to a valid URI tells ICEfaces that when the Ajax Push connection is lost, that the client is to be redirected to the specified page.
    
    Since:
    
    ICEfaces 2.0
  - setDeltaSubmit
```
public void setDeltaSubmit(java.lang.Boolean deltaSubmit)
```
    Setting org.icefaces.deltaSubmit to true tells ICEfaces that form submission should be handled in a special way to minimize what is sent across the wire. The parameters of a form post are compared to the previous submission and only those that have changed are sent to the server. The rest of the form parameters are reconstructed on the server from the cached DOM and then processed normally.
    
    Since:
    
    ICEfaces 2.0
  - setDisableDefaultErrorPopups
```
public void setDisableDefaultErrorPopups(java.lang.Boolean disableDefaultErrorPopups)
```
    This parameter can be used to disable the popups rendered by default when a network error, session expiry or server error occurs. The parameter is usually set when an application or component developer wants to have rendered only the defined custom indicators.
    
    Since:
    
    ICEfaces 2.0
  - setFocusManaged
```
public void setFocusManaged(java.lang.Boolean focusManaged)
```
    By default, when ICEfaces is available, focus retention will ensure that the focused element in the page preserves its focus when the partial update modified the element. By setting the org.icefaces.focusManaged parameter to false, this feature can be disabled.
    
    Since:
    
    ICEfaces 2.0
  - setLazyPush
```
public void setLazyPush(java.lang.Boolean lazyPush)
```
    By default, when using Ajax Push, the feature is activated in a lazy fashion. This means that the blocking connection used for doing Ajax Push is not activated until the first push is requested. Setting org.icefaces.lazyPush to false tells ICEfaces to automatically activate ICEpush for each session and each page in the entire application.
    
    Since:
    
    ICEfaces 2.0
  - setLazyWindowScope
```
public void setLazyWindowScope(java.lang.Boolean lazyWindowScope)
```
    By default, when using window-scoped beans, the window management is activated in a lazy fashion. This means that if there are no window scoped beans or view scoped beans annotated with @WindowDisposed then no dispose-window request is sent upon window closure (detection of window closing is not enabled). Setting org.icefaces.lazyWindowScope to false tells ICEfaces to always send a dispose-window request upon window closure regardless of the window scope map being empty or not. This context parameter is application-wide.
    
    Since:
    
    ICEfaces 3.0
  - setMandatoryResourceConfiguration
```
public void setMandatoryResourceConfiguration(java.util.List<java.lang.String> mandatoryResourceConfiguration)
```
    The org.icefaces.mandatoryResourceConfiguration context-parameter may be set to one of three values: none, all, or a space delimited list of components.
    
    Since:
    
    ICEfaces 2.0
  - setMessagePersistence
```
public void setMessagePersistence(java.lang.Boolean messagePersistence)
```
    By default, when ICEfaces is available, FacesMessages are persisted across different partial submits from the same page. This is done to better support forms that use incremental validation via singleSubmit tag.
    
    Since:
    
    ICEfaces 3.0
  - setPublicContextPath
```
public void setPublicContextPath(java.lang.String publicContextPath)
```
    Setting org.icefaces.publicContextPath to a valid path tells ICEfaces to replace the natural context path (usually, the web-application name) of all resources, form URLs, local bookmarks and local redirects to the specified path. This is useful when the application is served publicly through a reverse proxy or load balancer and one wants to avoid defining complex URL rewriting rules.
    
    Since:
    
    ICEfaces 2.0
  - setReplayNavigationOnReload
```
public void setReplayNavigationOnReload(java.lang.Boolean replayNavigationOnReload)
```
    This parameter can be used to replay the navigation rules when the page is reloaded. The parameter is usually set in applications where it is desirable to avoid the content being reset to the first page (before non-redirect navigation was triggered) when reloading.
    
    Since:
    
    ICEfaces 3.0
  - setSessionExpiredRedirectUri
```
public void setSessionExpiredRedirectUri(java.lang.String sessionExpiredRedirectUri)
```
    Setting org.icefaces.sessionExpiredRedirectURI to a valid URI tells ICEfaces that when the user session expires, that the client is to be redirected to the specified page. When using ICEpush, or <icecore:refresh>, the user will be redirected automatically on session expiry. Otherwise, they will be redirected on the next request after session expiry.
    
    Since:
    
    ICEfaces 2.0
  - setSessionTimeoutRedirectUri
```
public void setSessionTimeoutRedirectUri(java.lang.String sessionTimeoutRedirectUri)
```
    Setting org.icefaces.sessionTimeoutRedirectURII to a valid URI tells ICEfaces that when the user session expires due to user inactivity, that the client is to be redirected to the specified page. When using ICEpush, or <icecore:refresh>, the user will be redirected automatically on session expiry. Otherwise, they will be redirected on the next request after session expiry.
    
    Since:
    
    ICEfaces EE 4.1.0.GA, EE 3.3.0.GA_P04, 4.2
  - setStandardFormSerialization
```
public void setStandardFormSerialization(java.lang.Boolean standardFormSerialization)
```
    By default, ICEfaces does optimized serialization and submission of form elements based on the element that triggered the submission. Setting standardFormSerialization to true indicates that ICEfaces should do a normal, standard, full form submission.
    
    Since:
    
    ICEfaces 2.0
  - setStrictSessionTimeout
```
public void setStrictSessionTimeout(java.lang.Boolean strictSessionTimeout)
```
    The default value of false for org.icefaces.strictSessionTimeout indicates that ICEfaces should not interfere with container-managed control of session timeout. In this case, each user request and each Ajax Push request will extend the session. Setting org.icefaces.strictSessionTimeout to true indicates that ICEfaces should attempt to enforce the configured session timeout by ignoring any Ajax Push activity so that only user-triggered requests will extend the session.
    
    Since:
    
    ICEfaces 2.0
  - setSubtreeDiff
```
public void setSubtreeDiff(java.lang.Boolean subtreeDiff)
```
    By default, when using ICEfaces, Ajax-specified subtree diffing is always done. Setting org.icefaces.subtreeDiff to false indicates that ICEfaces will not perform a DOM diff on the rendered subtrees. Instead the rendered output of subtrees is sent directly to the browser, thus not updating the server-side DOM.
    
    Since:
    
    ICEfaces 3.0
  - setUniqueResourceUrls
```
public void setUniqueResourceUrls(java.lang.Boolean uniqueResourceUrls)
```
    The default value of "true" will cause ICEfaces to append random numbers to certain resource URLs, thereby preventing caching. This is useful for development, but can interfere with Portlet URL generation.
    
    Since:
    
    ICEfaces 2.0
  - setVersionableTypes
```
public void setVersionableTypes(java.util.List<java.lang.String> versionableTypes)
```
    By default, ICEfaces adds a version number parameter to the URL of most resource types. The version number parameter is used to ensure that the resources can be cached by the browser and that previously cached resources are not used for newer builds or releases of the software. Normally, the version number parameter consists of the release version of the software (e.g. "3_3_0") and the build date ("130829" - Aug. 29th, 2013) = "v=3_3_0_130829".
    
    Since:
    
    ICEfaces 3.3
  - setWindowScopeExpiration
```
public void setWindowScopeExpiration(java.time.Duration windowScopeExpiration)
```
    A value, in milliseconds, indicating how long window-scoped values should remain valid in the session after a reload or redirect occurs. This allows for postbacks that might occur quickly after a reload or redirect to successfully retrieve the relevant window-scoped values.
    
    Since:
    
    ICEfaces 2.0
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class IcefacesProperties

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IcefacesProperties

Method Detail

getFetchPendingNotificationsOnLoad

getGenerateHeadUpdate

getWarnBeforeSessionExpiryInterval

getAutoid

getBlockUiOnSubmit

getClientSideElementUpdateDetermination

getCoalesceResources

getCompressDom

getCompressResources

getConnectionLostRedirectUri

getDeltaSubmit

getDisableDefaultErrorPopups

getFileEntry

getFocusManaged

getAce

getLazyPush

getLazyWindowScope

getMandatoryResourceConfiguration

getMessagePersistence

getPublicContextPath

getRender

getReplayNavigationOnReload

getSessionExpiredRedirectUri

getSessionTimeoutRedirectUri

getStandardFormSerialization

getStrictSessionTimeout

getSubtreeDiff

getUniqueResourceUrls

getVersionableTypes

getWindowScopeExpiration

setFetchPendingNotificationsOnLoad

setGenerateHeadUpdate

setWarnBeforeSessionExpiryInterval

setAutoid

setBlockUiOnSubmit

setClientSideElementUpdateDetermination

setCoalesceResources

setCompressDom

setCompressResources

setConnectionLostRedirectUri

setDeltaSubmit

setDisableDefaultErrorPopups

setFocusManaged

setLazyPush

setLazyWindowScope

setMandatoryResourceConfiguration

setMessagePersistence

setPublicContextPath

setReplayNavigationOnReload

setSessionExpiredRedirectUri

setSessionTimeoutRedirectUri

setStandardFormSerialization

setStrictSessionTimeout

setSubtreeDiff

setUniqueResourceUrls

setVersionableTypes

setWindowScopeExpiration

equals

canEqual

hashCode

toString