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/01/07 13:17:43 UTC

svn commit: r1429766 - in /isis/site/trunk/content: components/objectstores/sql/ components/security/shiro/resources/ contributors/ contributors/resources/

Author: danhaywood
Date: Mon Jan  7 12:17:42 2013
New Revision: 1429766

URL: http://svn.apache.org/viewvc?rev=1429766&view=rev
Log:
minor fixes, also ISIS-223

Added:
    isis/site/trunk/content/components/objectstores/sql/configuring-the-sql-os-objectstore-with-the-quickstart-archetype.md
    isis/site/trunk/content/components/security/shiro/resources/
    isis/site/trunk/content/contributors/resources/eclipse-preferences-white-space-1.png   (with props)
    isis/site/trunk/content/contributors/resources/eclipse-preferences-white-space-2.png   (with props)
Modified:
    isis/site/trunk/content/components/objectstores/sql/about.md
    isis/site/trunk/content/contributors/about.md
    isis/site/trunk/content/contributors/development-environment.md
    isis/site/trunk/content/contributors/recreating-an-archetype.md

Modified: isis/site/trunk/content/components/objectstores/sql/about.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/objectstores/sql/about.md?rev=1429766&r1=1429765&r2=1429766&view=diff
==============================================================================
--- isis/site/trunk/content/components/objectstores/sql/about.md (original)
+++ isis/site/trunk/content/components/objectstores/sql/about.md Mon Jan  7 12:17:42 2013
@@ -2,6 +2,10 @@ Title: SQL object store
 
 The SQL object store module provides the ability to persist domain objects into an RDBMS. It has no external dependencies, using simply JDBC.
 
+### Archetypes
+
+You can adapt the [quickstart archetype](../../../getting-started/quickstart-archetype.html) to run with the SQL OS by following [these instructions](configuring-the-sql-os-objectstore-with-the-quickstart-archetype.html).
+
 ### Releases
 
 - See [release notes](release-notes/about.html).

Added: isis/site/trunk/content/components/objectstores/sql/configuring-the-sql-os-objectstore-with-the-quickstart-archetype.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/objectstores/sql/configuring-the-sql-os-objectstore-with-the-quickstart-archetype.md?rev=1429766&view=auto
==============================================================================
--- isis/site/trunk/content/components/objectstores/sql/configuring-the-sql-os-objectstore-with-the-quickstart-archetype.md (added)
+++ isis/site/trunk/content/components/objectstores/sql/configuring-the-sql-os-objectstore-with-the-quickstart-archetype.md Mon Jan  7 12:17:42 2013
@@ -0,0 +1,68 @@
+Title: Updating the Quickstart Archetype to run with the SQL object store
+
+These notes provided by Jason Richardson (see [ISIS-223](https://issues.apache.org/jira/browse/ISIS-223)); many thanks.
+
+### Preamble
+
+The following details what POM entries and isis.properties need to be updated to use the SQL Objectstore from the [quick start archetype](../../../getting-started/quickstart-archetype.html).
+
+I did this using the ISIS quickstart version: `0.2.0-incubating`. 
+
+* This is a PostgreSQL example
+
+* In order to use the SQL ObjectStore the following things need to be done once the user has created their new ISIS Application.
+
+* postgresql url base example for (`isis.persistor.sql.jdbc.connection`):  `jdbc:postgresql://host:port/database`
+
+
+### Update the pom files
+
+Add the following entry in your `projectname-objstore-dflt` POM file
+
+		<dependency>
+			<groupId>org.apache.isis.runtimes.dflt.objectstores</groupId>
+			<artifactId>sql-impl</artifactId>
+		</dependency>
+
+Add the maven dependencies for your Database Drivers entry in your `projectname-objstore-dflt` POM file
+
+		<dependency>
+			<groupId>postgresql</groupId>
+			<artifactId>postgresql</artifactId>
+			<version>9.0-801.jdbc3</version>
+		</dependency>
+
+
+### Update `isis.properties`
+
+In the projectname-webapp project in the `isis.properties` file change the `isis.persistor` property
+
+<pre>
+isis.persistor=sql
+</pre>
+
+
+### Configure DB URLs
+
+In the `projectname-webapp` project add the following properties (suitable for your Database Platform):
+
+* You will need to change the connection entry and driver entry to be specific for your database platform drivers and database server location and port.
+
+* if you want ISIS to create your DB tables you will need to use an ID/Password that has table creation rights.
+
+<pre>
+isis.persistor.sql.jdbc.driver=org.postgresql.Driver
+isis.persistor.sql.jdbc.connection=jdbc:postgresql://127.0.0.1:5432/assignments 
+isis.persistor.sql.jdbc.user=postgres
+isis.persistor.sql.jdbc.password=TheDatabasePassword
+
+# PostgreSQL ISIS specific data type overides
+isis.persistor.sql.datatypes.timestamp=TIMESTAMP
+isis.persistor.sql.datatypes.datetime=TIMESTAMP
+isis.persistor.sql.datatypes.double=DOUBLE PRECISION
+</pre>
+
+
+### Build
+
+Do a maven clean and install on your main project and run it.  You should see new table(s) created in your database.

Modified: isis/site/trunk/content/contributors/about.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/about.md?rev=1429766&r1=1429765&r2=1429766&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/about.md (original)
+++ isis/site/trunk/content/contributors/about.md Mon Jan  7 12:17:42 2013
@@ -5,8 +5,6 @@ Title: Contributors
 - [Contributing](contributing.html)
 - [Development Environment](development-environment.html)
 - [Building Isis](building-isis.html)
-- [Recreating an archetype](recreating-an-archetype.html)
-- [Updating the applib docs](updating-the-applib-docs.html)
 - [Git Policy](git-policy.html)
 - [Git Cookbook](git-cookbook.html)
 - [Versioning Policy](versioning-policy.html)
@@ -14,6 +12,8 @@ Title: Contributors
 ###  Committers
 
 - [Updating the CMS site](updating-the-cms-site.html)
+- [Updating the applib docs](updating-the-applib-docs.html)
+- [Recreating an archetype](recreating-an-archetype.html)
 - [Snapshot process](snapshot-process.html)
 - [Release process](release-process.html)
 - [Release branch and tag names](release-branch-and-tag-names.html)

Modified: isis/site/trunk/content/contributors/development-environment.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/development-environment.md?rev=1429766&r1=1429765&r2=1429766&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/development-environment.md (original)
+++ isis/site/trunk/content/contributors/development-environment.md Mon Jan  7 12:17:42 2013
@@ -160,6 +160,18 @@ In addition:
 -->
 
 
+### Whitespace
+
+It's a good idea to configure Eclipse's editors so that they highlight any accidental use of tabs instead of spaces, using:
+
+* `Windows > Preferences > General > Editor > Text Editors`
+* and then fine-tune the `whitespace characters`:
+
+<img src="resources/eclipse-preferences-white-space-1.png" width="500px"></img>
+
+
+<img src="resources/eclipse-preferences-white-space-2.png" width="400px"></img>
+
 ## What's Next
 
 Now you've set up your development environment the next thing to do is to [build Isis](building-isis.html).

Modified: isis/site/trunk/content/contributors/recreating-an-archetype.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/recreating-an-archetype.md?rev=1429766&r1=1429765&r2=1429766&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/recreating-an-archetype.md (original)
+++ isis/site/trunk/content/contributors/recreating-an-archetype.md Mon Jan  7 12:17:42 2013
@@ -15,6 +15,12 @@ Make sure that the app's `pom.xml`:
 - has the correct `-SNAPSHOT` version
 - references *released* versions of Isis core and the other components
 
+Check for and fix any missing license header notices:
+<pre>
+mvn org.apache.rat:apache-rat-plugin:check -D rat.numUnapprovedLicenses=50 -o
+for a in `find . -name rat.txt -print`; do grep '!???' $a; done
+</pre>
+
 Finally, double check that the app is running satisfactorily.  
 
 ### Create the archetype

Added: isis/site/trunk/content/contributors/resources/eclipse-preferences-white-space-1.png
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/resources/eclipse-preferences-white-space-1.png?rev=1429766&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/contributors/resources/eclipse-preferences-white-space-1.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: isis/site/trunk/content/contributors/resources/eclipse-preferences-white-space-2.png
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/resources/eclipse-preferences-white-space-2.png?rev=1429766&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/contributors/resources/eclipse-preferences-white-space-2.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream