EasyBeans Developer's guide

Florent BENOIT

EasyBeans
ObjectWeb consortium

This work is licensed under the Creative Commons Attribution-ShareAlike License. To view a copy of this license,visit http://creativecommons.org/licenses/by-sa/2.0/deed.en or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA.

$Id: developerguide.xml 216 2006-03-16 19:01:07Z benoitf $

Abstract

The EasyBeans developer guide is intended for developers wanting to work with the source distribution of EasyBeans. People wanted to contribute to EasyBeans should read this documentation.


Table of Contents

1. Building EasyBeans from source.
1.1. Requirements
1.1.1. JDK
1.1.2. ANT
1.1.3. TestNG
1.1.4. Clover
1.2. Optional requirements
1.2.1. Eclipse
1.2.2. Eclipse plugins
1.2.2.1. Checkstyle plugin
1.2.2.2. AnyEdit plugin
1.2.2.3. Asm plugin
1.2.2.4. TestNG plugin
1.3. Compiling EasyBeans
1.4. EasyBeans ant targets
1.4.1. JavaDoc
1.4.2. Binaries (.jar) output
1.4.3. Binaries (.rar) output
1.4.4. Binary distribution (default target)
2. Getting EasyBeans from SVN repository
3. Running EasyBeans server.
3.1. Requirements
3.2. Running
4. Using the examples
4.1. Compiling the examples
4.1.1. Requirements
4.1.2. Compile
4.2. Running examples
4.2.1. Stateless session bean
4.2.1.1. Description
4.2.1.2. Run the server
4.2.1.3. Deploying the bean
4.2.1.4. Run the client
4.2.2. Stateful session bean
4.2.2.1. Description
4.2.2.2. Run the server
4.2.2.3. Deploying the bean
4.2.2.4. Run the client
4.2.3. Entity bean
4.2.3.1. Description
4.2.3.2. Run the server
4.2.3.3. Deploying the bean
4.2.3.4. Run the client
5. EasyBeans Code Convention
5.1. Files Organization
5.1.1. Header
5.1.2. Imports
5.1.3. Class and Interface Declarations
5.2. Indentation / WhiteSpace
5.2.1. Indentation
5.2.2. WhiteSpace
5.3. JavaDoc comments
5.4. Statements
5.4.1. If/else
5.4.2. Try/catch
5.4.3. Inline Conditionals
5.4.4. Naming conventions
5.4.4.1. Static final attributes
5.4.4.2. Constants
5.4.4.3. No magic number, use constants
5.4.4.4. Attribute name
6. Contributing to EasyBeans
6.1. Mailing-lists
6.2. Ideas for contributing