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 2012/12/17 19:35:12 UTC
svn commit: r1423086 - in /isis/site/trunk/content: core/deployment-type.md
documentation.md
Author: danhaywood
Date: Mon Dec 17 18:35:11 2012
New Revision: 1423086
URL: http://svn.apache.org/viewvc?rev=1423086&view=rev
Log:
isis site - page on deploymentType defaults
Added:
isis/site/trunk/content/core/deployment-type.md
Modified:
isis/site/trunk/content/documentation.md
Added: isis/site/trunk/content/core/deployment-type.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/core/deployment-type.md?rev=1423086&view=auto
==============================================================================
--- isis/site/trunk/content/core/deployment-type.md (added)
+++ isis/site/trunk/content/core/deployment-type.md Mon Dec 17 18:35:11 2012
@@ -0,0 +1,131 @@
+Title: Deployment Types and Component Defaults
+
+One important configuration setting is the `deploymentType`, which, in turn, specifies the `deploymentCategory`. If a component implementation is not specified explicitly, then the default is based on the deployment category (see the [InstallerLookupDefault](https://raw.github.com/apache/isis/master/core/runtime/src/main/java/org/apache/isis/core/runtime/installers/InstallerLookupDefault.java) class). Certain other features are based on the category also.
+
+<table>
+<tr>
+<th>Deployment category</th>
+<th>Deployment types</th>
+<th>Authentication<br/>(if not specified)</th>
+<th>Authorization<br/>(if not specified)</th>
+<th>Object store<br/>(if not specified)</th>
+<th>Profile store<br/>(if not specified)</th>
+<th>@Exploration actions</th>
+<th>@Prototype actions</th>
+</tr>
+<tr>
+ <td>EXPLORING</td>
+ <td>SERVER_EXPLORATION<br/>
+EXPLORATION<br/>
+UTILITY</td>
+ <td><a href="bypass-security.html">Bypass</a></td>
+ <td><a href="bypass-security.html">Bypass</a></td>
+ <td><a href="inmemory-objectstore.html">In-memory</a></td>
+ <td><a href="inmemory-profilestore.html">In-memory</a></td>
+ <td>Visible</td>
+ <td>Not visible</td>
+ </tr>
+<tr>
+ <td>PROTOTYPING</td>
+ <td>SERVER_PROTOTYPE<br/>
+PROTOTYPE</td>
+ <td><a href="../component/security/file/about.html">File-based</a></td>
+ <td><a href="bypass-security.html">Bypass</a></td>
+ <td><a href="inmemory-objectstore.html">In-memory</a></td>
+ <td><a href="inmemory-profilestore.html">In-memory</a></td>
+ <td>Not visible</td>
+ <td>Visible</td>
+</tr>
+<tr>
+ <td>PRODUCTION</td>
+ <td>SERVER<br/>
+UNIT_TESTING<br/>
+SINGLE_USER</td>
+ <td><a href="../component/security/file/about.html">File-based</a></td>
+ <td><a href="../component/security/file/about.html">File-based</a></td>
+ <td><a href="../component/objectstore/xml/about.html">XML</a></td>
+ <td><a href="../component/profilestore/xml/about.html">XML</a></td>
+ <td>Not visible</td>
+ <td>Not visible</td>
+</tr>
+</table>
+
+## Specifying the `deploymentType` explicitly
+
+### Scimpi, HTML, Restful Objects
+
+For the [scimpi](../component/viewer/scimpi/about.html), [html](../component/viewer/html/about.html) and [restfulobjects](../component/viewer/restfulobjects/about.html) viewers, the `deploymentType` is specified in the `<web.xml>` file:
+
+<pre>
+<context-param>
+ <param-name>deploymentType</param-name>
+ <param-value>SERVER</param-value>
+</context-param>
+</pre>
+
+
+If running these viewers using the [WebServer](https://raw.github.com/apache/isis/master/core/webserver/src/main/java/org/apache/isis/core/webserver/WebServer.java), then the `deploymentType` can be overridden at the command line:
+
+<pre>
+-t server_prototype
+</pre>
+
+or using the long form:
+
+<pre>
+--type server_exploration
+</pre>
+
+Only `server_*`-style `deploymentType`s should be specified (it has a bearing on the way that Isis does its session management).
+
+The default if not specified is `SERVER`.
+
+### Wicket
+
+For the [wicket](../component/viewer/wicket/about.html) viewer, the Isis `deploymentType` is inferred from [Apache Wicket](http://wicket.apache.org)'s own [deployment mode](https://cwiki.apache.org/WICKET/faqs.html#FAQs-Deployment):
+
+* Wicket's `DEVELOPMENT` mode corresponds to Isis' `PROTOTYPING` mode
+* Wicket's `DEPLOYMENT` mode corresponds to Isis' `PRODUCTION` mode
+
+The Wicket mode is set in the usual way for a Wicket application:
+
+<pre>
+<init-param>
+ <param-name>configuration</param-name>
+ <param-value>deployment</param-value>
+</init-param>
+</pre>
+
+### DnD
+
+For the [dnd](../component/viewer/dnd/about.html) viewer, the `deploymentType` is specified at the command-line, for example:
+
+<pre>
+-t prototype
+</pre>
+
+or using the long form:
+
+<pre>
+--type exploration
+</pre>
+
+The default if not specified is `PROTOTYPE`.
+
+
+## Specifying components explicitly
+
+To specify the various components explicitly, add an entry to `isis.properties` config file (in the `WEB-INF` directory for the web viewers, or the `config` directory for the DnD viewer).
+
+For example:
+
+<pre>
+isis.authentication=ldap
+isis.authorization=file
+isis.persistence=datanucleus
+isis.profilestore=in-memory # the default anyway
+</pre>
+
+The available values are registered in [installer-registry.properties](https://raw.github.com/apache/isis/master/core/runtime/src/main/resources/org/apache/isis/core/runtime/installer-registry.properties); alternatively the fully qualified class name can be specified.
+
+In either case the appropriate component must of course be added as a dependency to the `pom.xml` file.
Modified: isis/site/trunk/content/documentation.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/documentation.md?rev=1423086&r1=1423085&r2=1423086&view=diff
==============================================================================
--- isis/site/trunk/content/documentation.md (original)
+++ isis/site/trunk/content/documentation.md Mon Dec 17 18:35:11 2012
@@ -74,6 +74,7 @@ Title: Documentation
### Applib & Runtime
+- [Deployment Types](core/deployment-type.html)
- [Applib](core/applib.html)
- [Core Metamodel](core/metamodel.html) [stub]
- [Core Runtime](core/runtime.html) [stub]