Do It The jAPS Way
Copyright © 2010 Tzente s.r.l.
Legal Notice
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the Appendix entitled "GNU Free Documentation License".
2010-03-24
| Revision History | ||
|---|---|---|
| Revision 1.2 | 2010-03-18 | MEM |
|
Revision for the release 2.0.10 of the jAPS 2.0 framework | ||
| Revision 1.1 | 2009-03-12 | RQ |
|
English and docbook adoption This revision will be finished when the document Pattern Integrazione Servizi will be correctly translated and referenced | ||
| Revision 1.0 | 2009-02-09 | RQ |
First public release | ||
Abstract
Provides best practices for implementation of jAPS Plugin.
Table of Contents
Table of Contents
This document provides best practices for implementation of jAPS Plug-in using jAPS Standard Coding Pattern.
In order to take the maximum advantage of the present document, it is necessary to have basic knowledge about: the Java platform, the Eclipse IDE, the Apache Tomcat servlet engine, the PosgreSQL DBMS.
Additional informations may be obtained through the official mailing-lists:
<japs-platform@googlegroups.com>, "japs-platform" Google Group, the jAPS 2.0 official Mailing List
It is also possible to refer to the documentation found in the: jAPS 2.0 Project - Developer Website
This document provides best practices for the development of a jAPS Plugin using jAPS Standard Coding Pattern. To support the development and release of a jAPS Plugin are available the following documents:
"jAPS 2.0 - Guidelines and Coding Standards": describes the encoding standard used in jAPS 2.0 project and provides source code guidelines.
"jAPS 2.0 - Creation and Integration Services Pattern": provides a description of jAPS architectural model and best practices to develop a new application service.
"jAPS 2.0 - Plugin Pattern": provides a complete description of jAPS Plugin architecture and best pratices to develop a new Plugin based on jAPS 2.0.
"jAPS 2.0 - Template Plugin Summary": provides specific information for each Plugin released.
"jAPS 2.0 - Template Plugin Documentation": provides best practices to write the documentation for a jAPS Plugin.
Each jAPS Plugin has been released in a package composed of 3 elements:
Readme : this short document explains the functionality of the jAPS Plugin and the version it is compatible with.
Src jAPS-Plugin folder: it contains all the components needed to integrate the jAPS Plugin in a project based on jAPS 2.0. The components must be developed according to the best practices as described in the documents "jAPS 2.0 - Creation and Integration Services Pattern" and "jAPS 2.0 - Plugin Pattern."
Documentation folder: documentation of each jAPS Plugin. The main document, written using the "jAPS 2.0 - Plugin Template documentation", contains the technical and functionality requirements of the jAPS Plugin as detailed in the "jAPS 2.0 - Plugin Pattern" document.
