OpenSubsystems

Business Components for Java Applications

Documentation

Last modified

$Author: bastafidli $
$Date: 2006/09/02 05:12:13 $
$Revision: 1.35 $
$RCSfile: documentation.html,v $

User Guide

Configuration - there is usually no "one size fits all" solution. OpenSubsystems design and implementation therefore pays lots of attention to allow customization of its behavior to fit user's or developer's needs. Here you find detailed information how to configure individual aspects of OpenSubsystems.

Database Setup - this document will help you to get started with each database management systems supported by OpenSubsystems. It will walk you through obtaining, installing and configuring the database so that OpenSubsystems can access it and use it as its persistence store.

J2EE Application Server Setup - this document will help you to get started with each J2EE application server supported by OpenSubsystems. It will walk you through obtaining, installing and configuring the application server so that it can be used to run OpenSubsystems components and applications. It also describes how OpenSubsystems can integrate with and utilize transaction manager and connection pools provided by the J2EE application server to access your databases.

Tutorial - Open Chronicle is a real world blogging application with basic functionality similar to websites such as Blogger, WordPress, LiveJournal and MySpace. Its purpose is to demonstrate how to use individual subsystems available as part of OpenSubsystems project when developing Java applications. It is an excellent learning resource for those who want to master the available subsystems or maybe just want to quickly lookup how to use some particular feature.

White Papers

Architecture - explanation of design principles behind the code, the data flow walkthrough, basic mechanisms and rules to be aware of.

Standards and Processes

Coding Conventions - recommendations how to write new OpenSubsystems code so that it complies with our Checkstyle settings and it is easily readable by others familiar with existing code.

Contributing - ownership, copyright and process of contributing enhancements and new work to OpenSubsystems project.

Development

Development Environment - brief guide with instructions how to install and setup Java, Eclipse IDE and other tools to use with OpenSubsystems.

Connecting to CVS - walkthrough describing how to connect from Eclipse to CVS, create project and download all the code for OpenSubsystems.

External Libraries - overview of how OpenSubsystems organizes external libraries and how to properly manage them in Eclipse.

Configuring Eclipse - the easiest way how to configure your Eclipse development environment to jump start your development of OpenSubsystems.

Configuring Checkstyle - by correctly configuring Checkstyle Eclipse plug-in you will make sure that your code is compliant with coding conventions set for development of OpenSubsystems.

Build Process - OpenSubsystems allows easy development from a single source tree, but each subsystem is built and packaged separately using Ant build scripts. This article explains the logic behind the build process and how to use it.

Building Web Application - many subsystems provide web user interface to access the business functionality. The build process allows to detect, build and package the webui automatically in few easy steps.

Quality Assurance

Testing Web Application - The combination of Eclipse and Jetty Launcher allows you to conveniently run and test your web application directly from your Eclipse development environment.

Validating Web User Interface - To ensure maximal compatibility and usability developers should validate their web user interface to verify that it follows all applicable standards.

Debugging Remote Application - Configuring Eclipse to debug remote java applications allows you to debug your OpenSubsystems application running in separate JVM or deployed inside of J2EE application server directly from your Eclipse development environment.