Appendix B ICEfaces Configuration Parameter Overview

Note: Unless otherwise noted, all parameters in the following tables start with the prefix, com.icesoft.faces.
Unless otherwise noted, all parameters should be specified in the ICEfaces application web.xml file.

Table 6 Communication


Parameter	Default Value	Notes
blockingConnectionTimeout	90000	Specifies the amount of time in milliseconds that an idle asynchronous blocking connection should be held open before being released. Normally, the blocking connection is closed and re-opened with every communication to the browser, such as user interaction or a heartbeat ping. The purpose of this setting is to remove the possibility of threads being held blocked for a long duration on a "dead" or completely inactive client connection. This value should be longer than the heartbeat interval to avoid unnecessary network traffic.
connectionLostRedirectURI	null	Specifies a page URI to redirect the client to when an asynchronous connection is lost. The parameter value must be surrounded by single quotes and an ice:outputConnectionStatus component must be present on the page. Note: This parameter is only applicable to asynchronous applications as it is the async connection lost event that triggers the redirect (com.icesoft.faces.synchronousUpdate=false, which is the ICEfaces default).
connectionTimeout	60000	Specifies the amount of time in milliseconds that the bridge will wait for a response from the server for a user-initiated request before declaring the connection lost.
heartbeatInterval	50000	Specifies the amount of time in milliseconds between heartbeat messages.
heartbeatRetries	3	Specifies how many consecutive heartbeat connection attempts may fail before the connection is considered lost.
heartbeatTimeout	30000	Specifies the number of milliseconds that a heartbeat request waits for a successful response before it is considered timed out.
sessionExpiredRedirectURI	null	Specifies a page URI to redirect the client to upon session expiry. Redirection will occur immediately when using asynchronous mode, or upon the first partial or full-submit after the session expires in synchronous mode.
useJettyContinuations	TRUE	Specifies whether ICEfaces should use Jetty Continuations for asynchronous communications. If ICEfaces is running in the Jetty servlet container, by default it will automatically attempt to use Jetty Continuations mechanism for handling asynchronous blocking connections. Specifying "useJettyContinuations=false" will disable the use of Jetty Continuations.

Table 7 Component


Parameter	Default Value	Notes
uploadDirectory	emtpy string ("")	Specific to the ice:inputFile component. Specifies the directory that uploaded files should be stored in. Works in conjunction with the uploadDirectoryAbsolute and uniqueFolder parameters. It can be set in the application's web.xml file, and can be overridden by the InputFile component's uploadDirectory property.
uploadDirectoryAbsolute	FALSE	Specific to the ice:inputFile component. Specifies whether the uploadDirectory parameter should be treated as a relative or absolute path. It can be set in the application's web.xml file, and can be overridden by the InputFile component's uploadDirectory property.
uploadMaxFileSize	3145728	Specific to the ice:inputFile component. Specifies the maximum size in bytes that an uploaded file can be. Files that exceed this size will throw an error in the fileUpload component.

Table 8 Framework


Parameter	Default Value	Notes
blockUIOnSubmit	TRUE	Specifies whether or not the users will see an hourglass pointer and be prevented from interacting with the user-interface with the mouse while a submit or partial-submit is in progress.
clientIdPoolMaxSize	100000	Specifies the size of the String pool used for caching client ID strings. The default value of 100,000 requires approximately 1MB of Java heap. Specifying an integer value of 0 will disable the client ID String pool.
compressDOM	FALSE	Specifies whether or not the server-side DOM should be compressed between view renders to reduce the amount of server heap memory required. Enabling this feature can provide significant memory consumption savings at the cost of some additional CPU cycles to perform the compression. Note: When specifying "com.icesoft.faces.compressDOM=true", the Fastinfoset.jar library (available in the /icefaces/libs/ directory) must be included in your project classpath.
compressResources	TRUE	The compressResources setting is used to tell the ICEfaces framework whether or not to compress (i.e., gzip) internal resources that are served directly by the framework. This includes theme CSS stylesheets, images, JavaScript, etc. Some browsers can have difficulty with compression (notably IE 6) and compression can be redundant for resources that are already compressed. As of this release, ICEfaces, by default, applies a list of mime-types to exclude from compression, even if the value is set to true. This list includes: application/java-archive application/pdf application/x-compress application/x-gzip application/zip audio/x-mpeg image/gif image/jpeg image/png image/tiff video/mp4 video/mpeg video/x-sgi-movie If you want to override or supplement this list and provide your own mime-types to be excluded from compression, use the compressResourcesExclusions parameter.
compressResourcesExclusions	application/java-archive application/pdf application/x-compress application/x-gzip application/zip audio/x-mpeg image/gif image/jpeg image/png image/tiff video/mp4 video/mpeg video/x-sgi-movie	This parameter is used to override or supplement the default list of mime-types that are excluded from compression by ICEfaces. The compressResourcesExclusions parameter takes a space delimited list of mime types for which compression will not be applied. Note: If you use this parameter, you are overriding the default list of mime-types that ICEfaces excludes by default and you'll need to specify all the mime-types that you want to exclude, including any of the mime-types originally excluded by default.
concurrentDOMViews	FALSE	Specifies to the ICEfaces framework whether to support multiple views of a single application from the same browser. When running in a Portlet environment, this parameter must be set to true.
cssNamePoolMaxSize	100000	Specifies the size of the String pool used for caching CSS class names strings. The default value of 100,000 requires approximately 1MB of Java heap. Specifying an integer value of 0 will disable the CSS class-name String pool.
elPoolMaxSize	100000	Specifies the size of the String pool used for caching EL expression strings. The default value of 100,000 requires approximately 1MB of Java heap. Specifying an integer value of 0 will disable the EL expression String pool.
javascriptBlockedRedirectURI	null	For clients that cannot or will not allow JavaScript, this parameter can be set to redirect the client to a specific page URI.
monitorRunnerInterval	10000	Specifies the time in milliseconds between checks made for client inactivity. The framework has an internal mechanism to detect a client's failure to pick up server-side updates (that is, when updates for client views are not picked up by the client because it is no longer re-connecting to the server). The thread used to monitor this inactivity is configured to check at the interval specified by this parameter (see blockingConnectionTimeout).
reloadInterval	2	When a JSPX page is requested, what interval, in seconds, should the compiler check for changes. If you don't want the compiler to check for changes once the page is compiled, then use a value of "-1". Setting a low refresh period helps during development to be able to edit pages in a running application. For Facelets pages (.xhtml), use the standard Facelets "facelets.REFRESH_PERIOD" configuration instead.
standardRequestScope	FALSE	The behaviour of the standardRequestScope parameter has been slightly modified. The default value is false but, since the Seam framework requires that this be set to true, the ICEfaces framework now checks for Seam integration at runtime and sets standardRequestScope to true if Seam is detected.
synchronousUpdate	FALSE	Specifies to the ICEfaces framework that synchronous update mode is to be used. By default, ICEfaces uses asynchronous update mode to support server-initated updates (Ajax Push). Setting "synchronousUpdate=true" will enable synchronous update mode and disable Ajax Push features.
xhtmlPoolMaxSize	100000	Specifies the size of the String pool used for caching literal XHTML tags and attributes strings. The default value of 100,000 requires approximately 1MB of Java heap. Specifying an integer value of 0 will disable the XHTML tags and attributes String pool.

Table 9 Integration


Parameter	Default Value	Notes
actionURLSuffix		Indicates to the ICEfaces framework that viewIds need to be modified during actions for compatability with Seam and Spring Web Flow. Should be set to '.seam' for Seam applications and '.iface' for Spring Web Flow applications.

Table 10 Portlet


Parameter	Default Value	Notes
adjustPortletSessionInactiveInterval	TRUE	Deprecated. See portlet.adjustSessionInactiveInterval.
portlet.renderStyles	TRUE	By default, when used inside an ice:portlet container, ICEfaces components will render out the JSR-168 standard portlet CSS style classes in addition to the ICEfaces component theme style classes in order to adopt the portal container's theme. To disable this behavior, set this parameter to false.
EDIT	null	Deprecated. See portlet.editPageURL.
HELP	null	Deprecated. See portlet.helpPageURL.
hiddenPortletAttributes	empty string	Deprecated. See portlet.hiddenAttributes.
portlet.adjustSessionInactiveInterval	TRUE	Because ICEfaces' Ajax communication does not go through the portal container, the portlet session access time is not properly updated during typical user activity. This results in premature session timeout. ICEfaces has internal logic to increase the inactive interval to accommodate this. This feature is disabled by setting this parameter to false.
portlet.editPageURL	null	The ICEfaces specific portlet parameter for specifying the resource to use as the portlet EDIT page.
portlet.helpPageURL	null	The ICEfaces specific portlet parameter for specifying the resource to use as the portlet HELP page.
portlet.hiddenAttributes	empty string	Portlet attributes that are specific to a portlet container may not be properly maintained by ICEfaces. These custom request attributes can be properly tracked and retained by adding this parameter and a space delimited list of attribute keys as the value.
portlet.renderStyles	TRUE	By default, when used inside an ice:portlet container, ICEfaces components will render out the JSR-168 standard portlet CSS style classes in addition to the ICEfaces component theme style classes in order to adopt the portal container's theme. To disable this behavior, set this parameter to false.
portlet.viewPageURL	null	The ICEfaces specific portlet parameter for specifying the resource to use as the portlet VIEW page.
VIEW	null	Deprecated. See portlet.viewPageURL.

Table 11 Push Server


Parameter	Default Value	Notes
blockingRequestHandler	auto-detect	Part of an ICEfaces application's web.xml file, it instructs the ICEfaces framework to use the desired Blocking Request Handler. Use "auto-detect" to auto-detect the Blocking Request Handler, "push-server" to enforce the usage of the Push Server, or "icefaces" to enforce the usage of ICEfaces itself.
blockingRequestHandlerContext	null	Part of an ICEfaces application web.xml file, it represents the context that Push Server is running in. If the deployed context of the Push Server is changed, then this value should be adjusted to match.
localAddress	null	Specifies a local IP address for the Application server that the ICEfaces application(s) and the Push Server are deployed to. Note: Only required to be specified if using a none-default port number AND either a Portlet server or an Application server with the older Servlet v2.3 library
localPort	null	Specifies the local port number for the Application server that the ICEfaces application(s) and the Push Server are deployed to. Note: Only required to be specified if using a none-default port number AND either a Portlet server or an Application server with the older Servlet v2.3 library.