ICEfaces
  1. ICEfaces
  2. ICE-9453

Clarify the recommended usage of the various Ajax Push API in ICEfaces 1.8

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: EE-1.8.2.GA_P03
    • Fix Version/s: EE-1.8.2.GA_P07
    • Component/s: Documentation
    • Labels:
      None
    • Environment:
      Ajax Push Documentation
    • Assignee Priority:
      P1
    • Affects:
      Documentation (User Guide, Ref. Guide, etc.)

      Description

      The current 1.8 documentation on using Ajax Push APIs (http://res.icesoft.org/docs/v1_8_2/htmlguide/devguide/AdvancedTopics2.html#1075177) covers the 3 available approaches:

      * PersistentFacesState - the low-level API not generally recommended for direct use by developers (requires creation and use of their own thread)
      * RenderManager API - the initial public API
      * SessionRenderer API - the later, simpler API

      While the documentation encourages using the RenderManager and SessionManager APIs rather than the PersistentFacesState directly, it doesn't expressly declare not to use the PersistentFaceState. From a support perspective, it's desirable that we more clearly define the recommend usage and best practices.

        Activity

        Repository Revision Date User Message
        ICEsoft Public SVN Repository #37042 Mon Jul 22 14:30:11 MDT 2013 deryk.sinotte ICE-9453: added API note to class and relevant methods to highlight that using PersistentFacesState directly is not the supported strategy and included a link to the online docs
        Files Changed
        Commit graph MODIFY /icefaces/trunk/icefaces/core/src/com/icesoft/faces/webapp/xmlhttp/PersistentFacesState.java

          People

          • Assignee:
            Deryk Sinotte
            Reporter:
            Deryk Sinotte
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: