You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2011/03/04 00:36:06 UTC

svn commit: r1076888 - in /incubator/isis/trunk: core/src/site/apt/ runtimes/dflt/bytecode/src/site/apt/ runtimes/dflt/objectstores/src/site/apt/ runtimes/dflt/remoting/src/site/apt/ runtimes/dflt/src/site/apt/ runtimes/embedded/src/site/apt/ src/site/

Author: danhaywood
Date: Thu Mar  3 23:36:06 2011
New Revision: 1076888

URL: http://svn.apache.org/viewvc?rev=1076888&view=rev
Log:
some updates for the site following restructuring

Modified:
    incubator/isis/trunk/core/src/site/apt/index.apt
    incubator/isis/trunk/runtimes/dflt/bytecode/src/site/apt/index.apt
    incubator/isis/trunk/runtimes/dflt/objectstores/src/site/apt/index.apt
    incubator/isis/trunk/runtimes/dflt/remoting/src/site/apt/index.apt
    incubator/isis/trunk/runtimes/dflt/src/site/apt/index.apt
    incubator/isis/trunk/runtimes/embedded/src/site/apt/index.apt
    incubator/isis/trunk/src/site/site.xml

Modified: incubator/isis/trunk/core/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/core/src/site/apt/index.apt?rev=1076888&r1=1076887&r2=1076888&view=diff
==============================================================================
--- incubator/isis/trunk/core/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/core/src/site/apt/index.apt Thu Mar  3 23:36:06 2011
@@ -31,26 +31,16 @@ Core Framework
 
   * reusable {{{./progmodel/index.html}programming model}} elements
 
-  * {{{./runtime/index.html}runtime}} instance management and persistence
-
-  * reusable components for {{{./webapp/index.html}webapp}}-based viewers
-  
-  * {{{./webserver/index.html}bootstrapping}} support for webapp-based viewers
-
   []
   
-  Across these modules a number of APIs are defined, each of which have 
-  {{{../defaults/index.html}default}} and 
-  {{{../alternatives/index.html}alternative}} implementations:  
+  Across these modules a number of APIs are defined:  
   
-  * persistence (object store API) ({{{../defaults/objectstore/index.html}default}} and {{{../alternatives/objectstore/index.html}alternatives}})  
+  * persistence / entity lifecycle management ({{{../runtimes/index.html}runtimes}} API)  
 
-  * user preferences (profile store API) ({{{../defaults/profilestore/index.html}default}} and {{{../alternatives/profilestore/index.html}alternatives}})
+  * user preferences ({{{../profilestores/index.html}profile store}} API)
   
-  * bytecode enhancement ({{{../defaults/bytecode/index.html}default}} and {{{../alternatives/bytecode/index.html}alternatives}})
-   
-  * security (authentication and authorization) ({{{../defaults/security/index.html}default}} and {{{../alternatives/security/index.html}alternatives}})
+  * authentication and authorization {{{../security/index.html}security}} API)
    
-  * programming model definition ({{{../defaults/progmodel/index.html}default}} and {{{../alternatives/progmodel/index.html}alternatives}})
+  * programming model definitions ({{{../progmodel/index.html}progmodel}} API)
 
   []
\ No newline at end of file

Modified: incubator/isis/trunk/runtimes/dflt/bytecode/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/runtimes/dflt/bytecode/src/site/apt/index.apt?rev=1076888&r1=1076887&r2=1076888&view=diff
==============================================================================
--- incubator/isis/trunk/runtimes/dflt/bytecode/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/runtimes/dflt/bytecode/src/site/apt/index.apt Thu Mar  3 23:36:06 2011
@@ -17,11 +17,16 @@
 
 
 
-Alternative Bytecode Implementations
+Bytecode Implementations
  
  This module is the parent for a
- number of alternative implementations for the bytecode enhancement API
- as defined in the {{{../../core/index.html}core}} framework:
+ number of implementations for the bytecode enhancement API
+ as defined within the {{{../../dflt/index.html}default runtime}}:
+
+ * {{{./dflt/index.html}Javassist}}
+
+   The <dflt> (default) bytecode module provides an implementation of the bytecode
+   enhancement API using {{{http://cglib.sourceforge.net//}CGLib}}.
 
  * {{{./javassist/index.html}Javassist}}
 

Modified: incubator/isis/trunk/runtimes/dflt/objectstores/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/runtimes/dflt/objectstores/src/site/apt/index.apt?rev=1076888&r1=1076887&r2=1076888&view=diff
==============================================================================
--- incubator/isis/trunk/runtimes/dflt/objectstores/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/runtimes/dflt/objectstores/src/site/apt/index.apt Thu Mar  3 23:36:06 2011
@@ -19,20 +19,30 @@
 
 ObjectStore Implementations
  
- The <objectstores> module is the parent of the various objectstore implementations:
+ The <objectstores> module is the parent for implementations of the 
+ {{{../index.html}default runtime}}'s object store API:
+
+ * {{{./dflt/index.html}XML object store}}
+ 
+   The <dflt> (default) object store persists objects only within memory.
+   It is suitable for prototyping or testing purposes only.
 
  * {{{./xml/index.html}XML object store}}
  
-   The <xml> object store provides a simple way to persist domain objects to file storage. The format of this file is a proprietary XML schema.
+   The <xml> object store provides a simple way to persist domain objects to 
+   file storage. The format of this file is a proprietary XML schema.
 
  * {{{./sql/index.html}SQL object store}}
  
-  The <sql> object store module provides the ability to persist domain objects into an RDBMS. It has no explicit external dependencies, using simply JDBC. 
+  The <sql> object store module provides the ability to persist domain objects 
+  into an RDBMS. It has no explicit external dependencies, using simply JDBC. 
 
-  You will have to add appropriate drivers to support connecting to the database server of your choosing.
+  You will have to add appropriate drivers to support connecting to the 
+  database server of your choosing.
  
  * {{{./nosql/index.html}NoSQL object store}}
 
-  The <nosql> object store module ...
+  The <nosql> object store module enables objects to be persisted in JSON
+  format. 
 
  []

Modified: incubator/isis/trunk/runtimes/dflt/remoting/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/runtimes/dflt/remoting/src/site/apt/index.apt?rev=1076888&r1=1076887&r2=1076888&view=diff
==============================================================================
--- incubator/isis/trunk/runtimes/dflt/remoting/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/runtimes/dflt/remoting/src/site/apt/index.apt Thu Mar  3 23:36:06 2011
@@ -19,17 +19,18 @@
 
 Remoting
  
-   The <remoting> module is the parent of a set of submodules that collectively provide a remoting
-   infrastructure for client/server deployments.
+   The <remoting> module is the parent of a set of submodules that 
+   collectively provide a remoting infrastructure for client/server 
+   deployments using the {{{../index.html}default runtime}}.
  
-   Although categorized as an {{{../alternatives/index.html}alternative}} implementation, it 
-   is slightly different to the others in that it has no corresponding module under
-   {{{../defaults/index.html}defaults}}.  Instead, it provides alternative implementations of 
-   several internal APIs that are defined within the {{{../core/index.html}core}} (specifically,
-   <<<ObjectPersistor>>> and <<<Viewer>>>).  It provides implementations of these APIs in order to 
-   allow two instances of the application to interact across the nework in client/server mode.
+   Remoting works by providing implementations of the <<<ObjectPersistor>>> and 
+   <<<Viewer>>> APIs.  The <<<ObjectPersistor>>> implementation is used by the
+   client (abstracting the persistence to a client/server invocation), while
+   the <<<Viewer>>> is used by the server (abstracting away the originator of
+   the request).
    
-   These implementations also define their own APIs, one being the transport protocol, the other a 
-   marshalling mechanism for network interactions.  The <remoting> component both defines these APIs
+   The remoting implementations also define their own APIs, one being the 
+   transport protocol, the other a marshalling mechanism for network 
+   interactions.  The <remoting> component both defines these APIs
    and provides several implementations.
  
\ No newline at end of file

Modified: incubator/isis/trunk/runtimes/dflt/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/runtimes/dflt/src/site/apt/index.apt?rev=1076888&r1=1076887&r2=1076888&view=diff
==============================================================================
--- incubator/isis/trunk/runtimes/dflt/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/runtimes/dflt/src/site/apt/index.apt Thu Mar  3 23:36:06 2011
@@ -19,10 +19,20 @@
 
 Default Runtime
  
-  The <dflt> runtime module is a parent for the various modules that
-  make up the default runtime implementation.
+  The default runtime module comprises a set of modules that provide
+  for persistence and entity lifecycle management.  They also provide support 
+  for remoting (by an abstraction over the persistence mechanism) and 
+  incorporate a bytecode enhancement API to enable transparent lazy 
+  loading/unit of work tracking.
+  
+  The modules that make up the default runtime are:
+  
+  * {{{runtime.html}runtime}} module, providing the core functionality
+  
+  * {{{webapp.html}webapp}} module, providing the ability to bootstrap the
+    default runtime within a web application
 
-  []
+  * {{{webserver.html}webserver}} module, providing the ability to run
+    Isis webapps under a webserver instance (Jetty)
 
-  This implementation was originally inherited from the Naked Objects 
-  Framework.
+  []

Modified: incubator/isis/trunk/runtimes/embedded/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/runtimes/embedded/src/site/apt/index.apt?rev=1076888&r1=1076887&r2=1076888&view=diff
==============================================================================
--- incubator/isis/trunk/runtimes/embedded/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/runtimes/embedded/src/site/apt/index.apt Thu Mar  3 23:36:06 2011
@@ -17,7 +17,7 @@
 
 
 
-Embedded Deployment
+Embedded Runtime
  
  The <embedded> deployment module provides the ability to embed the Isis metamodel without depending on
  the runtime.

Modified: incubator/isis/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/src/site/site.xml?rev=1076888&r1=1076887&r2=1076888&view=diff
==============================================================================
--- incubator/isis/trunk/src/site/site.xml (original)
+++ incubator/isis/trunk/src/site/site.xml Thu Mar  3 23:36:06 2011
@@ -62,42 +62,32 @@
 		<menu name="Isis Modules" inherit="bottom" href="core/index.html">
 			<item name="Application Library" href="applib/index.html" />
 			<item name="Core Framework" href="core/index.html"/>
-			<item name="Defaults" href="defaults/index.html">
-				<item name="Object Store" href="defaults/objectstore/index.html">
-                </item>
-				<item name="Profile Store" href="defaults/profilestore/index.html">
-                </item>
-				<item name="Programming Model" href="defaults/progmodel/index.html">
-                </item>
-				<item name="Bytecode Provider" href="defaults/bytecode/index.html">
-                </item>
-				<item name="Security" href="defaults/security/index.html">
-                </item>
+            <item name="Viewers" href="viewer/index.html">
+                <item name="DnD" href="viewer/dnd/index.html" />
+                <item name="HTML" href="viewer/html/index.html" />
+                <item name="Scimpi" href="viewer/scimpi/index.html" />
+                <item name="Wicket" href="viewer/wicket/index.html" />
+                <item name="Restful" href="viewer/restful/index.html" />
+                <item name="BDD (Concordion)" href="viewer/bdd/index.html" />
+                <item name="JUnit" href="viewer/junit/index.html" />
             </item>
-			<item name="Alternatives" href="alternatives/index.html">
-				<item name="Object Stores" href="alternatives/objectstore/index.html">
-                </item>
-				<item name="Profile Stores" href="alternatives/profilestore/index.html">
+			<item name="Runtimes" href="runtimes/index.html">
+				<item name="Default" href="runtimes/dflt/index.html">
+                    <item name="Bytecode Providers" href="runtimes/dflt/bytecode/index.html">
+                    </item>
+                    <item name="Object Stores" href="runtimes/dflt/objectstores/index.html">
+                    </item>
+                    <item name="Remoting" href="runtimes/dflt/remoting/index.html">
+                    </item>
                 </item>
-				<item name="Programming Models" href="alternatives/progmodel/index.html">
-                </item>
-				<item name="Bytecode Providers" href="alternatives/bytecode/index.html">
-                </item>
-				<item name="Security" href="alternatives/security/index.html">
-                </item>
-				<item name="Remoting" href="alternatives/remoting/index.html">
-                </item>
-				<item name="Embedded" href="alternatives/embedded/index.html">
+                <item name="Embedded" href="runtimes/embedded/index.html">
                 </item>
             </item>
-			<item name="Viewers" href="viewer/index.html">
-				<item name="DnD" href="viewer/dnd/index.html" />
-                <item name="HTML" href="viewer/html/index.html" />
-				<item name="Scimpi" href="viewer/scimpi/index.html" />
-				<item name="Wicket" href="viewer/wicket/index.html" />
-				<item name="Restful" href="viewer/restful/index.html" />
-				<item name="BDD (Concordion)" href="viewer/bdd/index.html" />
-				<item name="JUnit" href="viewer/junit/index.html" />
+			<item name="Profile Stores" href="profilestores/index.html">
+            </item>
+			<item name="Programming Model" href="progmodels/index.html">
+            </item>
+			<item name="Security" href="security/index.html">
             </item>
 		</menu>