OpenAjax Hub Project

This index-file describes the layout of the OpenAjax Hub Project.

This open source project contains the reference implementation of the OpenAjax Hub Specification, along with various related utilities and test cases. The specification of the OpenAjax Hub is developed by the OpenAjax Alliance. See http://www.openajax.org/member/wiki/OpenAjax_Hub_Specification.

Directories

The following directories are included in the package:

• src/ - The *.js (JavaScript) source files that implement the Hub.
• release/ - Holds the files which developers can use within their applications or toolkits.
• testsrc/ - The test files that verify that the files in src/ and release work correctly.
• conformancetests/ - Holds conformance test cases for software that makes use of the Hub to see if they satisfy various OpenAjax Conformance requirements.

For developers who download and initialize JSUnit on their systems:

• jsunit/ - This is where JSUnit needs to be installed. Do not add this directory to our SVN project. JSUnit has a different IPR policy than OpenAjax and we don't want any potential confusion about the IPR policy for the work done in this project. Developers need to download JSUnit separately from http://www.jsunit.net.

Hub source (src/)

The src/ directory contains the original JavaScript source code. Right now there is only one file in this directory.

• src/OpenAjax.js : This release of the Hub is small enough to fit into a single JavaScript file. Future versions might consists of multiple files.

Compiled Hub library (release/)

The release/ directory contains the release version of the OpenAjax Hub project. This is the version that outside developers should use to have their Ajax runtime libraries or Ajax applications take advantage of the OpenAjax Hub.

• release/OpenAjax.js : Theoretically, will hold compiled OpenAjax Hub library. At the moment, this file is identical to the one in the src/ directory. In the future, things might get more complicated, such as installing a compacted version (e.g., spaces and comments removed) in the release/ directory.

Automated regression testing of the reference implementation (testsrc/)

Regression tests for the Hub's source code are stored in testsrc/. There are multiple clusters of files focused on individual feature areas. For example, for the publish/subscribe feature, the following files exist:

• testsrc/_TestPubSub_jsunit_release.html : Very small HTML file that includes release/OpenAjax.js and then loads testsrc/_TestPubSub.js, which has all of the testing logic. This file is used during Ant-driven automated testing.
• testsrc/_TestPubSub_jsunit_src.html : Very small HTML file that includes all of the individual *.js files from src/ and then loads testsrc/_TestPubSub.js, which has all of the testing logic. This file is used for manual unit testing by developers as they are writing new code or changing existing code.
• testsrc/_TestPubSub.js : JavaScript file that has the various unit tests for the publish/subscribe features.

Conformance tests (conformancetests/)

Holds conformance test cases for software that makes use of the Hub to see if they satisfy various OpenAjax Conformance requirements.

At this point, there is only one subdirectory:

• conformancetests/interopfest-2007-03 : Holds the test case that was used for OpenAjax Alliance's first InteropFest, which happened in conjunction with the March 2007 face-to-face meeting. This test is now obsolete and incompatible with the current Hub specification. See the notes if you wish to run the conformance test with older releases of the Hub implementation.

Other files

The following file is key to the Ant-driven automated testing process:

• testsrc/TestSuite.html : The setup for the Ant-driven automated testing process points to this file, which then points to the individual unit test files (e.g., testsrc/_TestPublishSubscribe_release.html.