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 2014/10/14 07:38:32 UTC

svn commit: r1631626 - in /isis/site/trunk/content: ./ components/objectstores/jdo/non-ui/ components/objectstores/jdo/services/

Author: danhaywood
Date: Tue Oct 14 05:38:32 2014
New Revision: 1631626

URL: http://svn.apache.org/r1631626
Log:
isis addon modules

Modified:
    isis/site/trunk/content/components/objectstores/jdo/non-ui/background-command-execution-jdo.md
    isis/site/trunk/content/components/objectstores/jdo/services/background-command-service-jdo.md
    isis/site/trunk/content/components/objectstores/jdo/services/event-bus-service-jdo.md
    isis/site/trunk/content/components/objectstores/jdo/services/exception-recognizers-jdo.md
    isis/site/trunk/content/components/objectstores/jdo/services/publishing-service-jdo.md
    isis/site/trunk/content/components/objectstores/jdo/services/settings-services-jdo.md
    isis/site/trunk/content/documentation.md

Modified: isis/site/trunk/content/components/objectstores/jdo/non-ui/background-command-execution-jdo.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/objectstores/jdo/non-ui/background-command-execution-jdo.md?rev=1631626&r1=1631625&r2=1631626&view=diff
==============================================================================
--- isis/site/trunk/content/components/objectstores/jdo/non-ui/background-command-execution-jdo.md (original)
+++ isis/site/trunk/content/components/objectstores/jdo/non-ui/background-command-execution-jdo.md Tue Oct 14 05:38:32 2014
@@ -1,8 +1,14 @@
 Title: BackgroundCommandExecution (JDO implementation)
 
-The `BackgroundCommandExecutionFromBackgroundCommandServiceJdo` is a concrete subclass of [BackgroundCommandExecution](../../../../reference/non-ui/background-command-execution.html).  The intended use is for the class to be instantiated regularly (eg every 10 seconds) by a scheduler such as [Quartz](http://quartz.org)) to poll for `Command`s to be executed, and then execute them.  As you might imagine, this implementation queries for `Command`s persisted by the JDO implementations of [CommandService](../services/command-service-jdo.html) and [BackgroundCommandService](../services/background-command-service-jdo.html), using the `BackgroundCommandServiceJdoRepository`.
+{note
+In 1.6.0 this implementation was released as part of *org.apache.isis.core:isis-module-command-jdo:1.6.0* and was also released as an [Isis addon](http://github.com/isisaddons/isis-module-command) module.  **In 1.7.0+ only the [Isis addon](http://github.com/isisaddons/isis-module-command) implementation is released.**
+}
 
-The diagram below shows how the inheritance hierarchy for this class:
+The `BackgroundCommandExecutionFromBackgroundCommandServiceJdo` is a concrete subclass of [BackgroundCommandExecution](../../../../reference/non-ui/background-command-execution.html).  The intended use is for the class to be instantiated regularly (eg every 10 seconds) by a scheduler such as [Quartz](http://quartz.org)) to poll for `Command`s to be executed, and then execute them. 
+
+As you might imagine, this implementation queries for `Command`s persisted by the JDO implementations of [CommandService](../services/command-service-jdo.html) and [BackgroundCommandService](../services/background-command-service-jdo.html), using the `BackgroundCommandServiceJdoRepository`.
+
+The diagram below shows the inheritance hierarchy for this class:
 
 ![](http://yuml.me/363b335f)
 

Modified: isis/site/trunk/content/components/objectstores/jdo/services/background-command-service-jdo.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/objectstores/jdo/services/background-command-service-jdo.md?rev=1631626&r1=1631625&r2=1631626&view=diff
==============================================================================
--- isis/site/trunk/content/components/objectstores/jdo/services/background-command-service-jdo.md (original)
+++ isis/site/trunk/content/components/objectstores/jdo/services/background-command-service-jdo.md Tue Oct 14 05:38:32 2014
@@ -1,5 +1,9 @@
 Title: BackgroundCommandServiceJdo
 
+{note
+In 1.6.0 this implementation was released as part of *org.apache.isis.core:isis-module-command-jdo:1.6.0* and was also released as an [Isis addon](http://github.com/isisaddons/isis-module-command) module.  **In 1.7.0+ only the [Isis addon](http://github.com/isisaddons/isis-module-command) implementation is released.**
+}
+
 The JDO objectstore provides an implementation of the applib [BackgroundCommandService](../../../../reference/services/background-service.html) that persists the command data into a `CommandJdo` entity.  This is mapped to an `IsisCommand` table.
 
 There are two further services that can be used:

Modified: isis/site/trunk/content/components/objectstores/jdo/services/event-bus-service-jdo.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/objectstores/jdo/services/event-bus-service-jdo.md?rev=1631626&r1=1631625&r2=1631626&view=diff
==============================================================================
--- isis/site/trunk/content/components/objectstores/jdo/services/event-bus-service-jdo.md (original)
+++ isis/site/trunk/content/components/objectstores/jdo/services/event-bus-service-jdo.md Tue Oct 14 05:38:32 2014
@@ -1,11 +1,16 @@
 Title: Event Bus Service for JDO
 
+## 1.6.0+
+
+This service implementation is the default and is automatically registered using `@DomainService`.  No further configuration is necessary.
+
+## 1.5.0 and previous
+
 To use the [EventBusService](../../../../reference/services/event-bus-service.html) with the JDO Object Store, the JDO-specific implementation should be registered.
 
 The JDO implementation does not provide any additional functionality, but is aware of the lifecycle of domain entities and so ensures that objects are not interacted with while they are being rehydrated by the object store.
 
-
-## Register the Service
+#### Register the Service
 
 Register this service like any other service, in `isis.properties`:
 

Modified: isis/site/trunk/content/components/objectstores/jdo/services/exception-recognizers-jdo.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/objectstores/jdo/services/exception-recognizers-jdo.md?rev=1631626&r1=1631625&r2=1631626&view=diff
==============================================================================
--- isis/site/trunk/content/components/objectstores/jdo/services/exception-recognizers-jdo.md (original)
+++ isis/site/trunk/content/components/objectstores/jdo/services/exception-recognizers-jdo.md Tue Oct 14 05:38:32 2014
@@ -2,13 +2,22 @@ Title: Exception Recognizers
 
 The JDO objectstore provides a number of implementations of the applib [ExceptionRecognizer](../../../../reference/services/exception-recognizers.html) API that will recognize SQL constraint exceptions and convert them into user-friendly error messages.  The `ExceptionRecognizerCompositeForJdoObjectStore` wraps these up into a single implementation.
 
+## Register the Service
 
-### Register the Service
-
-Register like any other service in `isis.properties`:
+These service must be registered in `isis.properties`:
 
     isis.services=...,\
                   org.apache.isis.objectstore.jdo.applib.service.exceprecog.ExceptionRecognizerCompositeForJdoObjectStore,\
                   ...
 
-Alternatively, create your own implementations, for example based upon the vagaries of the JDBC driver in use.  More than one implementation of `ExceptionRecognizer` can be registered; all we be checked if an exception is thrown.
+(In many cases this will be the only service registered in `isis.properties`).
+
+## Checking for additional exceptions.
+
+If you want to recognize and handle additional exceptions (for example to capture error messages specific to the JDBC driver you might be using), then the recommended approach is to:
+* create a fine-grained implementation of `ExceptionRecognizer` for the particular error message (there are some convenience implementations of the interface that you can subclass from if required)
+* register your implementation in `isis.properties`.  More than one implementation of `ExceptionRecognizer` can be registered; all we be checked if an exception is thrown.
+
+Alternatively, if you prefer to register just a single `ExceptionRecognizer` service class, you could create a composite implementation that bundles up your fine-grained implementation; see the above `ExceptionRecognizerCompositeForJdoObjectStore` for inspiration.
+
+

Modified: isis/site/trunk/content/components/objectstores/jdo/services/publishing-service-jdo.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/objectstores/jdo/services/publishing-service-jdo.md?rev=1631626&r1=1631625&r2=1631626&view=diff
==============================================================================
--- isis/site/trunk/content/components/objectstores/jdo/services/publishing-service-jdo.md (original)
+++ isis/site/trunk/content/components/objectstores/jdo/services/publishing-service-jdo.md Tue Oct 14 05:38:32 2014
@@ -1,5 +1,9 @@
 Title: Publishing Service using JDO
 
+{note
+In 1.6.0 this implementation was released as part of *org.apache.isis.core:isis-module-publishing-jdo:1.6.0* and was also released as an [Isis addon](http://github.com/isisaddons/isis-module-publishing) module.  **In 1.7.0+ only the [Isis addon](http://github.com/isisaddons/isis-module-publishing) implementation is released.**
+}
+
 The JDO objectstore provides a simple implementation of the applib [PublishingService](../../../../reference/services/publishing-service.html) that simply persists the event data into a `PublishedEvent` entity.
 
 Along with the event data, the `PublishedEvent` also includes a status property with two values: `QUEUED` and `PROCESSED`.  The service also acts as a repository to search for all unprocessed events.

Modified: isis/site/trunk/content/components/objectstores/jdo/services/settings-services-jdo.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/objectstores/jdo/services/settings-services-jdo.md?rev=1631626&r1=1631625&r2=1631626&view=diff
==============================================================================
--- isis/site/trunk/content/components/objectstores/jdo/services/settings-services-jdo.md (original)
+++ isis/site/trunk/content/components/objectstores/jdo/services/settings-services-jdo.md Tue Oct 14 05:38:32 2014
@@ -1,5 +1,9 @@
 Title: Settings Services using JDO
 
+{note
+In 1.6.0 this implementation was released as part of *org.apache.isis.core:isis-module-settings-jdo:1.6.0* and was also released as an [Isis addon](http://github.com/isisaddons/isis-module-settings) module.  **In 1.7.0+ only the [Isis addon](http://github.com/isisaddons/isis-module-settings) implementation is released.**
+}
+
 The JDO objectstore provides simple implementations of the two applib [Settings Services](../../../../reference/services/settings-services.html).
 
 ## Application Settings

Modified: isis/site/trunk/content/documentation.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/documentation.md?rev=1631626&r1=1631625&r2=1631626&view=diff
==============================================================================
--- isis/site/trunk/content/documentation.md (original)
+++ isis/site/trunk/content/documentation.md Tue Oct 14 05:38:32 2014
@@ -340,7 +340,7 @@ Profiling, extended auditing.
 Background/async execution
 
 * [API](./reference/services/background-command-service.html)
-* [Implementation](components/objectstores/jdo/services/background-command-service-jdo.html)
+* [Isis addons implementation](components/objectstores/jdo/services/command-service-jdo.html) 
 * [Background Execution](./reference/non-ui/background-command-execution.html) ([Impl](components/objectstores/jdo/non-ui/background-command-execution-jdo.html))
 
 }