SimpleStore Developers Guide

Return-Path: Delivered-To: apmail-jakarta-commons-dev-archive@apache.org Received: (qmail 88057 invoked from network); 1 Apr 2002 10:19:45 -0000 Received: from unknown (HELO nagoya.betaversion.org) (192.18.49.131) by daedalus.apache.org with SMTP; 1 Apr 2002 10:19:45 -0000 Received: (qmail 28456 invoked by uid 97); 1 Apr 2002 10:19:55 -0000 Delivered-To: qmlist-jakarta-archive-commons-dev@jakarta.apache.org Received: (qmail 28435 invoked by uid 97); 1 Apr 2002 10:19:54 -0000 Mailing-List: contact commons-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Jakarta Commons Developers List" Reply-To: "Jakarta Commons Developers List" Delivered-To: mailing list commons-dev@jakarta.apache.org Received: (qmail 28424 invoked by uid 97); 1 Apr 2002 10:19:54 -0000 Date: 1 Apr 2002 10:19:39 -0000 Message-ID: <20020401101939.39055.qmail@icarus.apache.org> From: baliuka@apache.org To: jakarta-commons-sandbox-cvs@apache.org Subject: cvs commit: jakarta-commons-sandbox/simplestore/docs developers-guide.html users-guide.html X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N baliuka 02/04/01 02:19:39 Modified: simplestore/docs users-guide.html Added: simplestore/docs developers-guide.html Log: Added developers guide Revision Changes Path 1.5 +39 -12 jakarta-commons-sandbox/simplestore/docs/users-guide.html Index: users-guide.html =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/simplestore/docs/users-guide.html,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- users-guide.html 31 Mar 2002 22:13:50 -0000 1.4 +++ users-guide.html 1 Apr 2002 10:19:39 -0000 1.5 @@ -10,9 +10,31 @@ - + +

SimpleStore Users Guide

What is SimpleStore ?

About this Guide
What is SimpleStore ?
What can SimpleStore do for me ?
PersitenceManagerFactory
PersitenceManager
Transaction
Identity
State
Cache
Validation
Security
Developers Guide
API

About this Guide

+ The SimpleStore User Guide is intended to help bean providers get acquainted with Simplestore. +
+ Thanks for choosing Simplestore! + +

What is SimpleStore ?

SimpleStore is customizable persistence framework. It defines interfaces for Transparent Persistence and provides reference implementation. @@ -26,7 +48,7 @@ It is useful if you will decide to make your objects Distributed. See Apache's AltRMI for more information on Transparent Distribution implementation.

What can SimpleStore do for me ?

You can use it to implement persistency aspect in your web application, or object model, you can use it as service for your server like @@ -35,7 +57,7 @@ SimpleStore is Open Source and you can use it in commercial projects, see Apache license for details.

PersitenceManagerFactory

This interface is used to implement well known Factory design pattern it used to setup singleton PersitenceManager instanse.PersitenceManager is the most specific @@ -53,7 +75,7 @@ this example setups PersitenceManager to use RDMS as storage.

PersitenceManager

PersitenceManager is factory for your beans and transactions, Transaction is the last interface you need to know from SimpleStore if you not going to extend SimpleStore. @@ -135,7 +157,7 @@ </storage>

Transaction

SimpleStore supports only atomic persistence operations, All operations must be in transaction context:

  @@ -147,7 +169,7 @@
          transaction.commit();// or transaction.rollback();

Identity

All persistent objects have OID, it is recomended to use Serializable Object for OID, reference implementaion uses java.lang.Long and default (Random) generator. @@ -164,7 +186,7 @@ SimpleStore overrides int hashCode() and boolean equals(Object obj) methods in class Object.

State

It is to methods in PersistenceManager for persitent object state. boolean isNew(Object p) returns true if object is returned from @@ -175,13 +197,13 @@ java.lang.IllegalStateException if deleted object is accessed inside or outside transaction.

Cashe

Cache

Cache is transparent for SimpleStore user. It used for optimizations and reachability management, but it is "invisible" in code. It is recomended to use default implementation.

Validation

Metadada is used to define validation rules. Validator is custom object see javadoc for more information on @@ -189,11 +211,16 @@ and sample NotNull validator implementation. Persistent object implementation throws ValidationException if registread validator returns false for managed property value.

Security

Custom interceptors used for security checks. SimpleStore doe's not define any specific Permissions and doe's no security checks. -Read more about customizations in Developers Guide. +Read more about customizations see Developers Guide .

+ 1.1 jakarta-commons-sandbox/simplestore/docs/developers-guide.html Index: developers-guide.html =================================================================== SimpleStore Developers Guide