ICEfaces EE 3.3 ReadMe.html

Welcome to ICEfaces EE 3.3!

This bundle contains software source-code and executables for ICEfaces EE 3.3

Documentation related to ICEfaces EE 3.3 and the use of this bundle can be found in the ICEfaces EE Wiki.

Documentation Quick-links

Both Binary and Source Bundles are available for download. The contents of each bundle type vary, as described below.

Binary Bundle

The binary bundle comes with the ICEfaces EE libraries pre-compiled and the sample applications pre-built to run on "servlet-profile" platforms, such as Tomcat 7, using the Mojarra JSF 2.1 runtime libraries included with this release bundle. The binary bundle also includes all the source files for the sample applications, but not the ICEfaces libraries themselves.

The icefaces-ee directory of the binary bundle contains:

docs

The ICEfaces EE API and TLD documentation.

ace - JavaDocs and TLD docs for the ICEfaces Advanced Components (API and TLD).
compat - JavaDocs and TLD docs for the ICEfaces 1.x compatibility APIs (compat/api), and the ICE Components (compat/comps/api, compat/comps/tld).
core - JavaDocs and TLD docs for the core framework APIs and icecore tags.
ee-comps

ee-accessible - JavaDocs and TLD docs for the ICEfaces EE Accessible Components.
ee-composite - JavaDocs and TLD docs for the ICEfaces EE Composite Components.

icepush-ee

api - JavaDocs for the ICEpush EE public APIs.

The Enterprise Push Server library and distributable wars. See the Enterprise Push Server topic in the ICEfaces EE Wiki for more information.

dist

eps-servlet2.war - EPS war for Servlet 2.x specification application servers.
eps-servlet3.war - EPS war for Servlet 3.x specification application servers.

eps.jar - EPS jar library for inclusion into applications.

The ICEfaces EE libraries along with any required 3rd-party run-time libraries.

icefaces-ee.jar - The core ICEfaces EE framework.
icefaces-ee-ext.jar - The ICEfaces EE Core Extensions library (optional).
icefaces-ee-ace.jar - The ICEfaces ACE Components (ICEfaces Advanced Components) library (optional).
icefaces-ee-accessible.jar - The ICEfaces EE Accessible Components library (optional).
icefaces-ee-compat.jar - ICEfaces Compatibility library that includes the ICE Components and a set of ICEfaces 1.x core APIs to ease migration of existing ICEfaces 1.x applications to ICEfaces 3. (optional)
icefaces-ee-composite.jar - The ICEfaces EE Composite Components library (optional).
icefaces-ee-pfb-ext.jar - The ICEfaces EE PortletFaces Bridge Extensions library (req. for commerical portal containers).
icepush-ee.jar - The ICEpush EE library, provides push functionality to the ICEfaces EE framework (optional).

licenses

Summary of legal licenses used by ICEfaces EE and 3rd party libraries.

maven2

Project files to support installing ICEfaces EE into a local Maven2 repository.

project-builder

Project Builder for generating new ICEfaces EE Facelets projects.
See the ICEfaces Project Builder topic in the ICEfaces EE Wiki for more information.

samples

ace/themes

A set of jQuery ThemeRoller themes that have been converted to work with the ACE Components.
See the ACE ThemeRoller Support Wiki topic for details on how to configure and use these in your application.

compat

ICEfaces 1.x sample applications that have been ported to ICEfaces 3 using the ICE Components and the core compatibility APIs.
See the ICE Components and Compatibility topics in the ICEfaces Wiki for more information.

/auctionMonitor

core

ICEfaces core framework sample applications. Demonstrates using the ICEfaces framework with standard JSF h: components.

/auction

A simulated online auction application using only standard JSF components. Demonstrates core benefits of the ICEfaces framework, including the use of push to asynchronously update user's browsers when an auction bid occurs.

/portlets/chat

A simple ICEfaces chat portlet that demonstrates using ICEfaces and ICEpush in a portal environment.

dist

Contains all the sample app .wars prebuilt for "servlet-profile" platforms, such as Tomcat.

ee-comps

ICEfaces Enterprise Components sample applications.

/ee-accessible-showcase

ICEfaces EE Accessible Components Showcase sample application.

/ee-composite-showcase

ICEfaces EE Composite Components Showcase sample application.

Enterprise Push Server sample applications.

/poll

EPS Poller sample application demonstrates using EPS for Ajax Push application with support for clustered fail-over.

showcase

ICEfaces Showcase sample application demonstrates key ICEfaces framework features and includes comprehensive demonstrations of both the ICE and ACE Components sets.
See the ICE Components and ACE Components topics in the ICEfaces Wiki for more information.

/showcase
/showcase-portlets

Source Bundle

The source bundle contains all the same libraries and applications as the binary bundle but also includes the complete source code for the ICEfaces EE libraries themselves, and additional required ICEfaces EE build-time libraries. The source bundle does not contain any pre-built ICEfaces EE libraries or example .wars.

The structure of the source bundle varies greatly from the binary bundle. It is recommended that source bundle users compile and generate the binary-bundle structure before attempting to use the ICEfaces EE artifacts included in the source bundle.

Use the "ant bundle" command in the top-level "icefaces-ee" directory to generate the binary bundle structure. Once the binary bundle structure has been created, it can be used just as the binary distribution bundle is.

Support