Functional Specification

Project Woodstock Functional Specification

1 Project Description

Project Woodstock 4.1 continues to offer additional Java Server Faces-based user interface components. This version includes Ajax enabled basic components, dynamic validation for a text field, plus 5 new Ajax enabled components. Woodstock 4.1 is an open source development effort which is included in NetBeans 6.0.

1.1 Definition

Project Woodstock requires a Java EE 5 compliant web container, includes support for facelets, enhanced basic components, text field dynamic validation (optionally), text area autosave (optionally), plus a new accordion component, bubble help component, editable field component, popup menu componnet and Ajax-enabled table, as well as the usual round of bug fixes.

1.2 Motivation, Goals, and Requirements

The main motivation for Project Woodstock 4.1 is to provide additional consumer requested components as well as enhancements to existing components.

1.3 Changes From the Previous Release

The major change from version 4.0 was to offer client side renderers to the set of basic components.

1.4 Program Plan Overview

1.4.1 Development

The main features of Woodstock include: client side renderers for the basic components; support for facelets, dynamic validation for the text field, phase 1 of the next generation table, accordion, bubble help, popup menu, and editable field components, along with bug fixes. The development phase posts bi-weekly builds to woodstock.dev.java.net.

1.4.2 Quality Assurance/Testing

The quality criteria will be specified in the Woodstock Test Plan and will include testing for component run time behavior, component Visual Web design time behavior, automation coverage, minimal performance measurements, as well as platform and browser support.

1.4.3 Documentation

Documentation includes on-line documentation, as well as TLD/JavaDoc information.

1.4.4 Release Cycle

The build schedule is posted on the Project Woodstock java.net web site at:

https://woodstock.dev.java.net/ProjectRoadmap.htm

1.4.5 Technical Support

1.4.6 Training

1.5 Related Projects

1.5.1 Dependencies on Other Sun Projects
• Java Server Faces 1.2
• Project Dynamic Faces

1.5.2 Dependencies on Non-Sun Projects

• dojo
• JSON
• prototype

1.5.3 Sun Projects Depending on this Project

• Visual Web portion of NetBeans 6.0
• Project Glassfish

1.5.4 Projects Rendered Obsolete by this Project

1.5.5 Related Active Projects

1.5.6 Suggested Projects to Enhance this Program

There are several:

• Continue to evolve the Sun theme
• Continue to add additional Ajax enabled components
• Continue to Ajax enable several of the existing components

1.6 Competitive Analysis

All web user interface component libraries can be compared at this web site:

http://www.jsfmatrix.net/

2 Technical Description

2.1 Architecture

Project Woodstock 4.1 continues to offer components based upon the architecture described in LSARC/2006/468.

2.2 Interfaces

2.2.1 Exported Interfaces

2.2.1.1 Exported Component Interfaces


Interface Name	Proposed Stability Classification	Specified in What Document?	Former Stability Classification or Other Comments
JSF URI	Committed	http://www.sun.com/webui/webuijsf	External reference to the TLD document, which maps to the webui-jsf.tld file in the webui.jar
Facelets taglib	Committed	woodstock.taglib.xml	Facelets taglib support in the webui.jar
Theme name	Committed	suntheme	Used to disambiguate name spaces for themed resources in each major release
JSP Tags	Committed	TLD documentation	webuijsf:tag_name
Tag Attributes	Committed	TLD documentation	Attributes table in each tag's tld document
JSP Java Tag Handler Classes	Uncommitted	Auto generated tag classes (should never be referenced directly by applications)	com.sun.webui.jsf.component.component_nameTag
JSF Java Component Classes	Committed	javadocs	com.sun.webui.jsf.component.component_name
Theme Java Classes	Committed	javadocs	com.sun.webui.theme.*
JSF Java Renderer Classes	Private		com.sun.webui.jsf.renderkit.*
Javascript methods	Committed	TLD documentation	Client Side Javascript Functions section
Javascript events	Committed	TLD documentation	Client Side javascript Events section
Javascript object properties	Committed	TLD documentation	setProps method definition in Client Side Javascript Functions section
HTML templates	Uncommitted	Included as resource strings in the themes jar.	com/sun/webui/jsf/theme_name/css com/sun/webui/jsf/theme_name/templates
faces-config  parameters	Committed	faces-config.xml	com.sun.webui.jsf.component_ame com.sun.webui.jsf.ajax.component_name com.sun.webui.jsf.designtime.component_name com.sun.webui.jsf.widget.component_name
Help JSP pages	Uncommitted	Help JSP files	JSP files for popup Help component
Theme Resource Keys	Committed	javadocs	com.sun.webui.jsf.theme.ThemeImages ocm.sun.webui.jsf.theme.ThemeJavascript com.sun.webui.jsf.theme.ThemeStyles com.sun.webui.jsf.theme.ThemeTemplates

2.2.1.2 New Components Interfaces

This table identifies for new components in this release.

Interface Name	Proposed Stability Classification	Specified in What Document?	Former Stability Classification or Other Comments
Accordion	Committed	Functional specs	Accordian Functional Spec
Editable Field	Committed	Functional specs	EditableField Functional Spec
Dynamic Validation	Committed	TLD documentation	See autoValidate attribute and Example 3 in TextField tag
Popup Menu	Committed	Functional specs	PopupMenu Functional Spec
Bubble Help	Committed	Functional specs	BubbleHelp Functional Spec
Enhanced Table	Committed	Functional specs	Ajac Table Functional Spec
Login	Committed	Functional specs	Login Functonal Spec

2.2.1.3 Obsoleted Exported Interfaces

2.2.2 Imported Interfaces




Interface Name	Proposed Stability Classification	Specified in What Document?	Former Stability Classification or Other Comments
Java Server Faces 1.2	Standard	JSR 252
JavaServer Pages 2.1	Standard	JSR 245
Java Servlet 2.5	Standard	JSR 154
JSF DynaFaces	Unstable	JSF Extensions	com.sun.faces.extensions.avatar.* com.sun.faces.extensions.common.*
dojo Javascript	External	dojo Toolkit, version 0.4	dojo I/O functions, dojo event functions, dojo widget functions
Prototype	External	Prototype JavaScript Framework	Utility classes for client side renderers
JSON	External	JSON in Java	Utility classes for formatting JSON objects
Java SE 5	Standard		Java SE 5

 2.2.3 Detailed lists of obsoleted javascript interfaces

• 2.2.3.1 Button
• webui.suntheme.button.isSecondary()
• webui.suntheme.button.setSecondary(secondary)
• webui.suntheme.button.isPrimary()
• webui.suntheme.button.setPrimary(primary)
• webui.suntheme.button.isMini()
• webui.suntheme.button.setMini(mini)
• webui.suntheme.button.getDisabled()
• webui.suntheme.button.setDisabled(disabled)
• webui.suntheme.button.getVisible()
• webui.suntheme.button.setVisible(show)
• webui.suntheme.button.getText()
• webui.suntheme.button.setText(text)
• webui.suntheme.button.click()

• 2.2.3.2 CheckBox

  • webui.suntheme.checkbox.setChecked(elementId, checked)

  • webui.suntheme.checkbox.setDisabled(elementId, disabled)

  • webui.suntheme.checkbox.setGroupDisabled(elementId, disabled)

• 2.2.3.3 DropDown:

  • webui.suntheme.dropDown.getSelectElement(elementId)

  • webui.suntheme.dropDown.getSelectedValue(elementId)

  • webui.suntheme.dropDown.getSelectedLabel(elementId)

  • webui.suntheme.dropDown.setDisabled(elementId, disabled)

  • webui.suntheme.dropDown.changed(elementId)

  • webui.suntheme.jumpDropDown.changed(elementId)
    
  • 
    
• 2.2.3.4 Field:
  

  • webui.suntheme.field.getInputElement(elementId)

  • webui.suntheme.field.getValue(elementId)

  • webui.suntheme.field.setValue(elementId, newValue)

  • webui.suntheme.field.getStyle(elementId)

  • webui.suntheme.field.setStyle(elementId, newStyle)

  • webui.suntheme.field.setDisabled(elementId, disabled)

  • 2.2.3.5 Hyperlink:

  • webui.suntheme.hyperlink.submit(hyperlink, formId, params)

  • webui.suntheme.hyperlink.getImgElement(elementId)

  • 2.2.3.6 Listbox:

    • webui.suntheme.listbox.getSelectElement(elementId)

    • webui.suntheme.listbox.getSelectedValue(elementId)

    • webui.suntheme.listbox.getSelectedLabel(elementId)

    • webui.suntheme.listbox.setDisabled(elementId, disabled)

    • webui.suntheme.listbox.changed(elementId)

  • 2.2.3.7 RadioButton:

    • webui.suntheme.rbcb.setChecked(elementId, checked)

    • webui.suntheme.rbcb.setDisabled(elementId, disabled, type, enabledStyle, disabledStyle)

    • webui.suntheme.rbcb.setGroupDisabled(elementId, controlName, disabled, type, enabledStyle, disabledStyle)

    • webui.suntheme.radiobutton.setChecked(elementId, checked)

    • webui.suntheme.radiobutton.setDisabled(elementId, disabled)

    • webui.suntheme.radiobutton.setGroupDisabled(elementId, disabled)

2.3 User Interface

The components continue to adhere to the SWAED User Interface guidelines.  A user interface specification is provided for each new component (and is referenced in each component Functional Specification document).


2.4 Compatibility and Interoperability

2.4.1 Standards Conformance

Not applicable

2.4.2 Operating System and Platform Compatibility

The components are platform architecture independent (Java based).  Web containers must support Java EE 5 and the minimum specifications for supported containers are identified in the imported interface table above, 2.2.

The client browsers and operating systems that are supported by the Woodstock components are in the following table.

Note:  The Woodstock component set will no longer support the Internet Explorer 5.x browser releases.

2.4.3 Interoperability with Sun Projects/Products

The components are included in the visual web portion of NetBeans 6.0.

The components are also used by the admin GUI of Glassfish v2

2.4.4 Interoperability with External Products

Not applicable.

2.4.5 Coexistence with Similar Functionality

The Woodstock component set can be used in web applications with other JSF-based components.

2.4.6 Support for Multiple Concurrent Instances

Not applicable.

2.4.7 Compatibility with Earlier and Future Releases

Project Woodstock 4.1 is compatible with version 4.0


The Woodstock component set uses the Theme Name as a unique identifier in forming the various name spaces on the web application page.   This supports mixing Woodstock components from different major releases on the page.

2.5 Performance and Scalability

2.5.1 Performance Goals

No significant performance degradation is expected.

Performance gains are expected for those components designed to use the new dynamic infrastructure, as it will be possible to retrieve data and re-render components without doing full page submits (and full page re-renderings).

2.5.2 Performance Measurement

2.5.3 Scalability Limits and Potential Bottlenecks

2.5.4 Static System Behavior

Current size of the jar files:
 

webui-jsf-dt.jar	2.3M
webui-jsf-portletSetup.jar	37K
webui-jsf-portletSetupDoc.jar	16K
webui-jsf-suntheme.jar	850K
webui-jsf.jar	4.7M

 

2.5.5 Dynamic System Behavior

No change from version 4.0.


2.6 Failure and Recovery

2.6.1 Resource Exhaustion

Not applicable.  Components are Java objects.  The web server environment supports specific scoping capabilities which affect how long an object will be maintained, including a request scope (component objects are extant during the request) and a session scope (component objects are extant during the login session with the browser).   Once a component object goes "out of scope", standard Java object heap management is used to recover resources.

2.6.2 Software Failures

Not applicable.  Components will continue to write log messages for internally detected failures. 

2.6.3 Network Failures

Not applicable.  Network connections and failures are handled by the web server.


2.6.4 Data Integrity

Not applicable.

2.6.5 State and Checkpointing

Not applicable.

2.6.6 Fault Detection

Not applicable

2.6.7 Fault Recovery (or Cleanup after Failure)

The asynchronous, page-oriented nature of web applications allow for error recovery.  For example, the user can be redirected to error pages which describe recovery procedures.  In many cases, the user can simply retry the page.


2.7 Security

Not applicable.  Security is provided by the web server and browser. 



2.8 Software Engineering and Usability

2.8.1 Namespace Management

Woodstock components use unique Java package namespaces to manage their Java classes.

Woodstock components use a unique Javascript prefix and JS object scoping to manage their object and method name spaces in the browser page.

Woodstock components define mapped CSS style selectors and page resources (such as images, icons, etc.) using key names.  The key names are stable interfaces; the actual style selectors and resource paths are unstable and can be changed.  Styles and resources are scoped to a single page in the browsers.  Styles and resources are provided through the Theme mechanism, and each component set has its own implementation of the Theme resources.


2.8.2 Dependencies on non-Standard System Interfaces

Not applicable.

2.8.3 Year 2000 Compliance

Not applicable.

2.8.4 Internationalization (I18N)

The Woodstock components support level 4 I18N.  All themed resources are localizable.


2.8.5 64-bit Issues

Not applicable.

2.8.6 Porting to other Platforms

Not applicable.


2.8.7 Accessibility

The Woodstock components are Section 508 compliant.

3 Release Information

3.1 Product Packaging

No change from 4.0


3.1.1 Package Overview

No change from 4.0

3.1.2 (Default) Installation Locations

3.1.2.1 Theme configuration files

3.1.3 Effect on External Environment

Not applicable.


3.2 Installation

3.2.1 Installation procedure

3.2.2 Effects on System Files

Not applicable.


3.2.3 Boot-Time Requirements

Not applicable.


3.2.4 Licensing

Not applicable.


3.2.5 Upgrade

No change from version 4.0


3.2.6 Software Removal

Not applicable.


3.3 System Administration

Not applicable.