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 2013/03/28 09:37:02 UTC
svn commit: r1461979 - in /isis/site/trunk/content: ./
components/objectstores/jdo/ components/security/ldap/
components/security/sql/ components/viewers/html/
components/viewers/restfulobjects/
components/viewers/restfulobjects/images/ core/services/ ...
Author: danhaywood
Date: Thu Mar 28 08:37:02 2013
New Revision: 1461979
URL: http://svn.apache.org/r1461979
Log:
isis site - pages on our various services
Added:
isis/site/trunk/content/components/viewers/restfulobjects/event-serializer-rospec.md
isis/site/trunk/content/components/viewers/restfulobjects/images/
isis/site/trunk/content/components/viewers/restfulobjects/images/action-invocation-published-to-stderr.png
- copied unchanged from r1461973, isis/site/trunk/content/core/services/images/action-invocation-published-to-stderr.png
isis/site/trunk/content/components/viewers/restfulobjects/images/changed-object-published-to-stderr.png
- copied unchanged from r1461973, isis/site/trunk/content/core/services/images/changed-object-published-to-stderr.png
Removed:
isis/site/trunk/content/core/services/images/action-invocation-published-to-stderr.png
isis/site/trunk/content/core/services/images/changed-object-published-to-stderr.png
Modified:
isis/site/trunk/content/components/objectstores/jdo/about.md
isis/site/trunk/content/components/security/ldap/about.md
isis/site/trunk/content/components/security/sql/about.md
isis/site/trunk/content/components/viewers/html/about.md
isis/site/trunk/content/components/viewers/restfulobjects/about.md
isis/site/trunk/content/core/services/publishing-service.md
isis/site/trunk/content/documentation.md
Modified: isis/site/trunk/content/components/objectstores/jdo/about.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/objectstores/jdo/about.md?rev=1461979&r1=1461978&r2=1461979&view=diff
==============================================================================
--- isis/site/trunk/content/components/objectstores/jdo/about.md (original)
+++ isis/site/trunk/content/components/objectstores/jdo/about.md Thu Mar 28 08:37:02 2013
@@ -10,7 +10,7 @@ The JDO objectstore enables the persiste
- [Enabling Logging](enabling-logging.html)
- [Deploying on the Google App Engine](deploying-on-the-google-app-engine.html)
-### JDO Services:
+### Applib Service Implementations:
- [Eagerly Registering Entities](eagerly-registering-entities.html) [1.1.0-SNAPSHOT]
- [Publishing Service on JDO](publishing-service-jdo.html) [1.1.0-SNAPSHOT]
Modified: isis/site/trunk/content/components/security/ldap/about.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/security/ldap/about.md?rev=1461979&r1=1461978&r2=1461979&view=diff
==============================================================================
--- isis/site/trunk/content/components/security/ldap/about.md (original)
+++ isis/site/trunk/content/components/security/ldap/about.md Thu Mar 28 08:37:02 2013
@@ -1,5 +1,9 @@
Title: LDAP Security
+{note
+This component is no longer under active development. We recommend you use the [Shiro](../shiro/about.html) security instead.
+}
+
Security implementations provide authentication and authorization services. They do not providing services such as auditing, encryption, non-repudiation or confidentiality.
The ldap implementation provides integration with an LDAP provider.
Modified: isis/site/trunk/content/components/security/sql/about.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/security/sql/about.md?rev=1461979&r1=1461978&r2=1461979&view=diff
==============================================================================
--- isis/site/trunk/content/components/security/sql/about.md (original)
+++ isis/site/trunk/content/components/security/sql/about.md Thu Mar 28 08:37:02 2013
@@ -1,5 +1,9 @@
Title: SQL Security
+{note
+This component is no longer under active development. We recommend you use the [Shiro](../shiro/about.html) security instead.
+}
+
Security implementations provide authentication and authorization services. They do not providing services such as auditing, encryption, non-repudiation or confidentiality.
The sql implementation provides basic integration with a SQL database.
Modified: isis/site/trunk/content/components/viewers/html/about.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/html/about.md?rev=1461979&r1=1461978&r2=1461979&view=diff
==============================================================================
--- isis/site/trunk/content/components/viewers/html/about.md (original)
+++ isis/site/trunk/content/components/viewers/html/about.md Thu Mar 28 08:37:02 2013
@@ -1,5 +1,9 @@
Title: HTML Viewer
+{note
+This component is no longer under active development. We recommend you use either the [Wicket](../wicket/about.html) viewer or the [Scimpi](../scimpi/about.html) viewer instead.
+}
+
The HTML viewer provides a simple webapp interface for interacting with an Isis domain model.
It renders each domain object or collection of domain objects as a web page, with hyperlinks used to navigate between objects. In addition, object actions can also be invoked, with hyperlinks bringing up a page for action parameters if required.
Modified: isis/site/trunk/content/components/viewers/restfulobjects/about.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/restfulobjects/about.md?rev=1461979&r1=1461978&r2=1461979&view=diff
==============================================================================
--- isis/site/trunk/content/components/viewers/restfulobjects/about.md (original)
+++ isis/site/trunk/content/components/viewers/restfulobjects/about.md Thu Mar 28 08:37:02 2013
@@ -6,6 +6,12 @@ Each domain object (or part of object) i
The viewer is an implementation of the [Restful Objects](http://restfulobjects.org) specification, intended to allow other server-side frameworks to be implemented to support the same protocol. It currently implements **v0.56** of the spec.
+### Applib Service Implementations
+
+- [Event Serializer per RO Spec](event-serializer-rospec.html) [1.1.0-SNAPSHOT]
+
+
+
### Releases
- See [release notes](release-notes/about.html).
Added: isis/site/trunk/content/components/viewers/restfulobjects/event-serializer-rospec.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/restfulobjects/event-serializer-rospec.md?rev=1461979&view=auto
==============================================================================
--- isis/site/trunk/content/components/viewers/restfulobjects/event-serializer-rospec.md (added)
+++ isis/site/trunk/content/components/viewers/restfulobjects/event-serializer-rospec.md Thu Mar 28 08:37:02 2013
@@ -0,0 +1,40 @@
+Title: Event Serializer for the RO Spec [1.2.0-SNAPSHOT]
+
+The [Publishing Service](../../../core/services/publishing-service.html) enables Isis to publish action invocations and also changes of domain objects to third party systems.
+
+One of the APIs defined by this service is the `EventSerializer`, such that the event can be rendered into different formats. The Restful Objects viewer provides an implementation of this API, serializing the the provided `EventPayload` into the form specified by the [Restful Objects spec](http://restfulobjects.org). The serializer itself is part of the `org.apache.isis.viewer:isis-viewer-restfulobjects-rendering` module.
+
+For example, this is the JSON generated on an action invocation:
+
+ 
+
+while this is the object change JSON:
+
+ 
+
+
+If you configure the default `PublishingService` (as described [here](../../../core/services/publishing-service.html)) along with the `RestfulObjectsSpecEventSerializer`, then you should see JSON being written to your console.
+
+
+### Registering and Configuring the Serializer
+
+To register the serializer with Isis, add the following to `isis.properties`:
+
+<pre>
+isis.services=<i>...other services...</i>,\
+ org.apache.isis.viewer.restfulobjects.rendering.eventserializer.RestfulObjectsSpecEventSerializer
+</pre>
+
+In addition, the `baseUrl` to use in hyperlinks must be specified, also in `isis.properties`; for example:
+
+<pre>
+isis.viewer.restfulobjects.RestfulObjectsSpecEventSerializer.baseUrl=https://myapp.mycompany.com:8080/restful/.
+</pre>
+
+If no `baseUrl` is specified, then the default URL is `http://localhost:8080/restful/`.
+
+{note
+Because the `baseUrl` will be different in production vs development, you will probably want to [configure Isis](configuration-files.html) to pick up its configuration file
+from an external directory.
+}
+
Modified: isis/site/trunk/content/core/services/publishing-service.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/core/services/publishing-service.md?rev=1461979&r1=1461978&r2=1461979&view=diff
==============================================================================
--- isis/site/trunk/content/core/services/publishing-service.md (original)
+++ isis/site/trunk/content/core/services/publishing-service.md Thu Mar 28 08:37:02 2013
@@ -13,7 +13,7 @@ Publishing requires at minimum two thing
* an implementation of the `org.apache.isis.applib.services.publish.PublishingService` interface must be registered as a domain services
- This is done in the usual way, under the `isis.properties` config file
+ This is done in the usual way, registering the service in the `isis.properties` config file
Over and above this, the service does provide considerable flexibility for fine-tuning the serialized form and the contents (payload) of the event.
@@ -41,6 +41,8 @@ Similarly, to indicate that any changes
Either or both of these annotations can be used.
+> At the time of writing, only the [JDO Objectstore](../../components/objectstores/jdo/about.html) supports the publishing of objects. (Published actions are supported by all object stores).
+
As described further down in this article, it is possible to fine-tune the payload. However, simply using the above annotations will suffice in many cases.
### Configuring the Publishing Service
@@ -133,40 +135,9 @@ As can be seen, the above implementation
The default `PublishingService` (or indeed any implementation) can be configured to run with a different `EventSerializer` by configuring the serializer implementation in the `isis.properties` file. One alternative serializer is described next.
+An alternative implementation of the `PublishingService` is provided by the [JDO Objectstore](../../components/objectstores/jdo/publishing-service-jdo.html). This implementation persists the events to a table.
-### Restful Objects (JSON) Serializer
-
-An alternative serializer is provided by the `isis-viewer-restfulobjects-rendering` module. This converts the provided `EventPayload` into the form specified by the [Restful Objects spec](http://restfulobjects.org).
-
-To configure this serializer, add the following to `isis.properties`:
-
-<pre>
-isis.services=<i>...other services...</i>,\
- org.apache.isis.viewer.restfulobjects.rendering.eventserializer.RestfulObjectsSpecEventSerializer
-</pre>
-
-In addition, the `baseUrl` to use in hyperlinks must be specified, also in `isis.properties`; for example:
-
-<pre>
-isis.viewer.restfulobjects.RestfulObjectsSpecEventSerializer.baseUrl=https://myapp.mycompany.com:8080/restful/.
-</pre>
-
-If no `baseUrl` is specified, then the default URL is `http://localhost:8080/restful/`.
-
-{note
-Because the `baseUrl` will be different in production vs development, you will probably want to [configure Isis](configuration-files.html) to pick up its configuration file
-from an external directory.
-}
-
-If - as described in the previous sections - you configure the default `PublishingService` with the `RestfulObjectsSpecEventSerializer`, then you should see JSON being written to your console.
-
-For example, this is the JSON generated on an action invocation:
-
- 
-
-while this is the object change JSON:
-
- 
+An alternative implementation of the `EventSerializer` is provided by the [Restful Objects viewer](../../components/viewers/restfulobjects/event-serializer-rospec.html). This implementation serializes the payload using the conventions of the [Restful Objects spec](http://restfulobjects.org).
### Fine-tuning the payload
Modified: isis/site/trunk/content/documentation.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/documentation.md?rev=1461979&r1=1461978&r2=1461979&view=diff
==============================================================================
--- isis/site/trunk/content/documentation.md (original)
+++ isis/site/trunk/content/documentation.md Thu Mar 28 08:37:02 2013
@@ -131,13 +131,11 @@ Guidance for committers is at the bottom
- [About](components/viewers/restfulobjects/about.html)
-### JUnit [0.2.0-incubating](components/viewers/junit/release-notes/about.html)
-- [About](components/viewers/junit/about.html)
+##### Applib Service Implementations
-### BDD (Concordion) [0.2.0-incubating](components/viewers/bdd/release-notes/about.html)
+- [Event Serializer per RO Spec](components/viewers/restfulobjects/event-serializer-rospec.html) [1.1.0-SNAPSHOT]
-- [About](components/viewers/bdd/about.html)
}
@@ -151,9 +149,14 @@ Guidance for committers is at the bottom
- [About](components/viewers/dnd/about.html)
-### HTML [0.2.0-incubating](components/viewers/html/release-notes/about.html)
+### JUnit [0.2.0-incubating](components/viewers/junit/release-notes/about.html)
+
+- [About](components/viewers/junit/about.html)
+
+### BDD (Concordion) [0.2.0-incubating](components/viewers/bdd/release-notes/about.html)
+
+- [About](components/viewers/bdd/about.html)
-- [About](components/viewers/html/about.html)
}
@@ -179,7 +182,7 @@ Guidance for committers is at the bottom
- [Enabling Logging](components/objectstores/jdo/enabling-logging.html)
- [Deploying on the Google App Engine](components/objectstores/jdo/deploying-on-the-google-app-engine.html)
-### JDO Services
+##### Applib Service Implementations
- [Eagerly Registering Entity Types](components/objectstores/jdo/eagerly-registering-entities.html) [1.1.0-SNAPSHOT]
- [Publishing Service on JDO](components/objectstores/jdo/publishing-service-jdo.html) [1.1.0-SNAPSHOT]
@@ -237,13 +240,6 @@ Guidance for committers is at the bottom
{span-one-third
-### LDAP [0.2.0-incubating](components/security/ldap/release-notes/about.html)
-
-- [About](components/security/ldap/about.html)
-
-### SQL [0.2.0-incubating](components/security/sql/release-notes/about.html)
-
-- [About](components/security/sql/about.html)
}
@@ -348,6 +344,20 @@ Guidance for committers is at the bottom
}
+{span-one-third
+
+### Mothballed Components
+
+These are no longer under active development
+
+- [HTML Viewer](components/viewers/html/about.html) (use Wicket)
+
+- [LDAP Security](components/security/ldap/about.html) (use Shiro)
+
+- [SQL Security](components/security/sql/about.html) (use Shiro)
+
+}
+
}
}