The lack of documentation for the com.icesoft.faces.delegateNonIface option caused me some grief.

I didn't know the feature existed, and I had to look through the source code to find it.

JSF-Portlet guys like me who have tons of legacy JSF portlets (some of which may be running side-by-side with ICEfaces portlets) need to have the D2DViewHandler delegate to other view handlers (in my case, the Sun-JSF-Portlet-Bridge ViewHandlerImpl). So the com.icesoft.faces.delegateNonIface option must be set to "true" in web.xml for many portlet developers, I would think.

– Neil

Changed Fix Version(s) to 1.7.2 and assigned it to Deryk.

Some early investigation:

com.icesoft.faces.delegateNonIface: not there anymore?
com.icesoft.faces.doJSFStateManagement: documented!
com.icesoft.faces.actionURLSuffix: not documented yet.
com.icesoft.faces.reloadInterval: documented!
com.icesoft.faces.openAjaxHub: not documented yet.
com.icesoft.faces.streamWriting: not documented yet.
com.icesoft.faces.async.server: documented!
com.icesoft.faces.VIEW: deprecated and documented!
ContextEventRepeater: not documented yet.

Depends on ICE-3014 which will likely expand the ContextEventRepeater's API.

com.icesoft.faces.delegateNonIface

This context parameter is no longer used by the ICEfaces framework to determine delegation in the view handler. This was done for 1.7 so the impact at this point should be well understood. It should simply be removed from the documentation - perhaps with a note.

com.icesoft.faces.doJSFStateManagement

As we move to implement actual state saving in the framework, the meaning of this parameter is going to change. Currently it is documented to handle the calling of the StateManager lifecycle in a Seam environment without actually performing state saving in the ICEfaces framework. The planned change is to co-opt this parameter for "real" state saving. The goal is to have the default set to true (meaning that ICEfaces will always perform state saving) while setting it to false will revert to original ICEfaces behaviour - were a persistent component tree is maintained between requests. The Seam case will switch to use Seam detection logic to turn on the appropriate logic automatically when needed.

com.icesoft.faces.actionURLSuffix

Accurately documented in the Appendix of the Dev Guide.

com.icesoft.faces.reloadInterval

Accurately documented in the Appendix of the Dev Guide.

com.icesoft.faces.openAjaxHub

To have the ICEfaces framework automatically add the Open Ajax Hub (openajax.js) to each ICEfaces page, set this parameter to true. This is not currently documented and needs a code adjustment to work properly. Opened http://jira.icefaces.org/browse/ICE-3491 to capture this work.

com.icesoft.faces.streamWriting

It appears that this parameter is no longer necessary although it is still checked in various places in the code (components and core). Since it's not documented, we should look at deprecating its usage and removing it from the product code. Opened http://jira.icefaces.org/browse/ICE-3494 to capture this work.

com.icesoft.faces.async.server

Accurately documented in the Appendix of the Dev Guide.

com.icesoft.faces.VIEW

Deprecated and documented. This was the old parameter for specifying the portlet view when using ICEfaces. It's been replaced and the whole thing is already fully documented.

com.icesoft.faces.noCompress

By default, ICEfaces compresses various resources that is serves directly from the framework like CSS files, images, etc. To turn off compression for all these resources, use the com.icesoft.faces.compressResources parameter. However, there are certain situations where you may want to turn off compression for a sub-set of resources. For example, some browsers can have difficulty with this compression (notably IE 6). Compression can also be redundant for resources that are already at an optimum size. This parameter takes a space delimited list of mime types (e.g. image/gif image/png), for which compression will not be applied. By default, compression is not applied to the following list of mime-types:

image/gif image/png image/jpeg image/tiff application/pdf application/zip application/x-compress application/x-gzip application/java-archive video/x-sgi-movie audio/x-mpeg video/mp4 video/mpeg

The work for this was done in http://jira.icefaces.org/browse/ICE-3145. I'm not currently convinced that the current implementation and interaction with com.icesoft.faces.compressResources parameter is as clear as it should be.

ContextEventRepeater

This is a not a parameter per se but a listener that is typically configured by default because it sits in icefaces.jar/META-INF/include.tld as:

<listener>
<listener-class>com.icesoft.faces.util.event.servlet.ContextEventRepeater</listener-class>
</listener>

App servers that don't support configuring listeners this way may need to include this listener in their web.xml document.

The ContextEventRepeater implements both the HttpSessionListener and ServletContextListener interfaces and was designed to forward servlet events to different parts of the ICEfaces framework. These events are typically of interest for gracefully and/or proactively keeping track of valid sessions and allowing for orderly shut down.

com.icesoft.faces.standardRequestScope

The description may need to be modified for this as we plan to add automatic detection for Seam making the default true in that environment.

Adding additional documentation for compressResources*:

com.icesoft.faces.compressResources

There are however, resources that won't benefit from this compression. By default, ICEfaces applies a list of mime-types to exclude from being compressed. This list is:

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 wish to override this list and provide your own mime-types to be excluded from compression, use the com.icesoft.faces.compressResourcesExclusions parameter.

com.icesoft.faces.compressResourcesExclusions

Some browsers can have difficulty with compression (notably IE 6) so ICEfaces excludes a number of certain mime-types. Compression can also be redundant for resources that are already compressed. The compressResourcesExclusions parameter takes a space delimited list of mime types for which compression will not be applied. For example:

<context-param>
<param-name>com.icesoft.faces.compressResourcesExclusions</param-name>
<param-value>image/gif image/png</param-value>
</context-param>

Please note that if you use this parameter, you are overriding the default list of mime-types that ICEfaces excludes by default. If you want to add a new mime-type to the list, then you'll need to include the entire list in addition to the additional mime-type you want to exclude.

Added updates for compressResources and compressResourcesExclusions to the Release Notes for 1.7.2.

The rest are either for 1.8 now or shouldn't be published (OpenAjax).

Retargeting for 1.8 to be included in the official doc guide updates.

Docs for updated config. params.

Note that the "noCompress" param was replaced by the compressResourceExclusions param and no longer needs to be documented.

Changes are applied to ICEfaces Developer's Guide as of 1.8.0-RC1.