You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by bu...@apache.org on 2014/03/17 14:10:14 UTC
svn commit: r901974 - in /websites/staging/isis/trunk: cgi-bin/ content/
content/reference/deployment-type.html
content/reference/recognized-annotations/Exploration.html
content/reference/recognized-annotations/Prototype.html
Author: buildbot
Date: Mon Mar 17 13:10:13 2014
New Revision: 901974
Log:
Staging update by buildbot for isis
Modified:
websites/staging/isis/trunk/cgi-bin/ (props changed)
websites/staging/isis/trunk/content/ (props changed)
websites/staging/isis/trunk/content/reference/deployment-type.html
websites/staging/isis/trunk/content/reference/recognized-annotations/Exploration.html
websites/staging/isis/trunk/content/reference/recognized-annotations/Prototype.html
Propchange: websites/staging/isis/trunk/cgi-bin/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Mar 17 13:10:13 2014
@@ -1 +1 @@
-1578324
+1578351
Propchange: websites/staging/isis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Mar 17 13:10:13 2014
@@ -1 +1 @@
-1578324
+1578351
Modified: websites/staging/isis/trunk/content/reference/deployment-type.html
==============================================================================
--- websites/staging/isis/trunk/content/reference/deployment-type.html (original)
+++ websites/staging/isis/trunk/content/reference/deployment-type.html Mon Mar 17 13:10:13 2014
@@ -322,114 +322,187 @@
</h1>
</div>
-<p>One important configuration setting is the <code>deploymentType</code>, which, in turn, specifies the <code>deploymentCategory</code>. If a component implementation is not specified explicitly, then the default is based on the deployment category (see the <a href="https://raw.github.com/apache/isis/master/core/runtime/src/main/java/org/apache/isis/core/runtime/installers/InstallerLookupDefault.java">InstallerLookupDefault</a> class). Certain other features are based on the category also.</p>
+<p>The <code>deploymentType</code> configuration setting is used to specify whether Isis is running in development mode or production mode (similar to Apache Wicket's concept of the application's <a href="http://ci.apache.org/projects/wicket/apidocs/6.0.x/org/apache/wicket/Application.html#getConfigurationType()">configuration type</a>.</p>
+
+<p>The most thing aspect of configuration that varies by <code>deploymentType</code> is whether actions annotated with <a href="./recognized-annotations/Exploration.html">@Exploration</a> and <a href="./recognized-annotations/Prototype.html">@Prototype</a> are visible. It is also used to determine the default component to use (for security and objectstore) if not explicitly specified.</p>
+
+<blockquote>
+ <p>The <code>deploymentType</code> design is perhaps overly complex; we hope to simplify in the future.</p>
+</blockquote>
+
+<h2>Deployment Types and Deployment Categories</h2>
+
+<p>There is a standard list of <code>deploymentType</code>s, though components can extend this list if required (and note, the <a href="../components/viewers/wicket/about.html">Wicket viewer</a> is one such component that does so).</p>
+
+<p>Each <code>deploymentType</code> list has a corresponding <code>deploymentCategory</code>, and it is this that determines whether <code>@Exploration</code> and <code>@Prototype</code> actions are visible.</p>
+
+<p>The standard list of deploymentTypes and their categories are:</p>
<table class="table table-striped table-bordered table-condensed">
<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>Deployment category</th>
<th>@Exploration actions</th>
<th>@Prototype actions</th>
</tr>
<tr>
+ <td>EXPLORATION</td>
<td>EXPLORING</td>
- <td>SERVER_EXPLORATION<br/>
-EXPLORATION<br/>
-UTILITY</td>
- <td><a href="../core/bypass-security.html">Bypass</a></td>
- <td><a href="../core/bypass-security.html">Bypass</a></td>
- <td><a href="../core/inmemory-objectstore.html">In-memory</a></td>
- <td><a href="../core/inmemory-profilestore.html">In-memory</a></td>
<td>Visible</td>
<td>Not visible</td>
- </tr>
+</tr>
+<tr>
+ <td>SERVER_EXPLORATION</td>
+ <td>EXPLORING</td>
+ <td>Visible</td>
+ <td>Not visible</td>
+</tr>
+<tr>
+ <td>UTILITY</td>
+ <td>EXPLORING</td>
+ <td>Visible</td>
+ <td>Not visible</td>
+</tr>
<tr>
+ <td>PROTOTYPE</td>
+ <td>PROTOTYPING</td>
+ <td>Not visible</td>
+ <td>Visible</td>
+</tr>
+<tr>
+ <td>SERVER_PROTOTYPE</td>
<td>PROTOTYPING</td>
- <td>SERVER_PROTOTYPE<br/>
-PROTOTYPE</td>
- <td><a href="../components/security/file/about.html">File-based</a></td>
- <td><a href="../core/bypass-security.html">Bypass</a></td>
- <td><a href="../core/inmemory-objectstore.html">In-memory</a></td>
- <td><a href="../core/inmemory-profilestore.html">In-memory</a></td>
<td>Not visible</td>
<td>Visible</td>
</tr>
<tr>
+ <td>SERVER<br/>
+UNIT_TESTING<br/>
+SINGLE_USER</td>
<td>PRODUCTION</td>
+ <td>Not visible</td>
+ <td>Not visible</td>
+</tr>
+<tr>
<td>SERVER<br/>
UNIT_TESTING<br/>
SINGLE_USER</td>
- <td><a href="../components/security/file/about.html">File-based</a></td>
- <td><a href="../components/security/file/about.html">File-based</a></td>
- <td><a href="../components/objectstores/xml/about.html">XML</a></td>
- <td><a href="../components/profilestores/xml/about.html">XML</a></td>
+ <td>PRODUCTION</td>
+ <td>Not visible</td>
+ <td>Not visible</td>
+</tr>
+<tr>
+ <td>SERVER<br/>
+UNIT_TESTING<br/>
+SINGLE_USER</td>
+ <td>PRODUCTION</td>
<td>Not visible</td>
<td>Not visible</td>
</tr>
</table>
-<h2>Specifying the deploymentType explicitly</h2>
+<h2>Specifying the Deployment Type in the <code>web.xml</code> file</h2>
-<h3>Scimpi, HTML, Restful Objects</h3>
+<blockquote>
+ <p>If running these viewers using the <a href="https://raw.github.com/apache/isis/master/core/webserver/src/main/java/org/apache/isis/core/webserver/WebServer.java">WebServer</a>, then the <code>deploymentType</code> is forced to SERVER_PROTOTYPE; the value in the <code>web.xml</code> file is ignored. Thus these settings only take force when deploying into a regular webapp server, eg Tomcat.</p>
+</blockquote>
-<p>For the <a href="../components/viewers/scimpi/about.html">scimpi</a> and <a href="../components/viewers/restfulobjects/about.html">restfulobjects</a> viewers, the <code>deploymentType</code> is specified in the <code><web.xml></code> file:</p>
+<h4>Wicket</h4>
-<pre>
-<context-param>
- <param-name>deploymentType</param-name>
- <param-value>SERVER</param-value>
-</context-param>
-</pre>
+<p>For the <a href="../components/viewers/wicket/about.html">wicket</a> viewer, the Isis <code>deploymentType</code> is inferred from <a href="http://wicket.apache.org">Apache Wicket</a>'s own <a href="http://ci.apache.org/projects/wicket/apidocs/6.x/org/apache/wicket/Application.html#getConfigurationType()">deployment mode</a>:</p>
-<p>If running these viewers using the <a href="https://raw.github.com/apache/isis/master/core/webserver/src/main/java/org/apache/isis/core/webserver/WebServer.java">WebServer</a>, then the <code>deploymentType</code> can be overridden at the command line:</p>
+<ul>
+<li>Wicket's <code>DEVELOPMENT</code> mode corresponds to Isis' <code>PROTOTYPING</code> mode</li>
+<li>Wicket's <code>DEPLOYMENT</code> mode corresponds to Isis' <code>PRODUCTION</code> mode</li>
+</ul>
-<pre><code>-t server_prototype
+<p>The Wicket configuration type is set in the usual way for a Wicket application, for example:</p>
+
+<pre><code><context-param>
+ <param-name>configuration</param-name>
+ <param-value>deployment</param-name>
+</context-param>
</code></pre>
-<p>or using the long form:</p>
+<p>(Alternative ways of specifying the Wicket configuration type can be found <a href="http://www.mysticcoders.com/blog/development-and-deployment-mode-how-to-configure-it/">in this blog post</a>).</p>
-<pre><code>--type server_exploration
-</code></pre>
+<p>Note that if the Wicket configuration type is set to deployment, then any Wicket tags will automatically be stripped. The presence of Wicket tags can occasionally trip up some browsers (we have noticed that Internet Explorer is particularly susceptible) and some Javascript components. The Wicket viewer therefore also allows the stripping of Wicket tags to be forced (even in prototype mode) using a configuration setting described <a href="../components/viewers/wicket/stripped-wicket-tags.html">here</a>.</p>
-<p>Only <code>server_*</code>-style <code>deploymentType</code>s should be specified (it has a bearing on the way that Isis does its session management).</p>
+<h4>Restful Objects viewer</h4>
-<p>The default if not specified is <code>SERVER</code>.</p>
+<p>First thing to note is that, if <a href="../components/viewers/restfulobjects/about.html">Restful Objects</a> viewer is deployed alongside the <a href="../components/viewers/wicket/about.html">Wicket</a> viewer, then the Wicket viewer's configuration takes precedence. See the section above for details.</p>
-<h3>Wicket</h3>
+<p>However, if the Restful Objects viewer is deployed by itself, then the <code>deploymentType</code> is specified in the <code><web.xml></code> file:</p>
-<p>For the <a href="../components/viewers/wicket/about.html">wicket</a> viewer, the Isis <code>deploymentType</code> is inferred from <a href="http://wicket.apache.org">Apache Wicket</a>'s own <a href="http://ci.apache.org/projects/wicket/apidocs/6.x/org/apache/wicket/Application.html#getConfigurationType()">deployment mode</a>:</p>
+<pre><code><context-param>
+ <param-name>deploymentType</param-name>
+ <param-value>SERVER</param-name>
+</context-param>
+</code></pre>
-<ul>
-<li>Wicket's <code>DEVELOPMENT</code> mode corresponds to Isis' <code>PROTOTYPING</code> mode</li>
-<li>Wicket's <code>DEPLOYMENT</code> mode corresponds to Isis' <code>PRODUCTION</code> mode</li>
-</ul>
+<h4>Scimpi viewer (not released)</h4>
-<p>The Wicket mode is set in the usual way for a Wicket application:</p>
+<p>The <a href="../components/viewers/scimpi/about.html">Scimpi</a> is configured the same way as the <a href="../components/viewers/restfulobjects/about.html">Restful Objects</a> viewer, see above.</p>
-<pre>
-<init-param>
- <param-name>configuration</param-name>
- <param-value>deployment</param-value>
-</init-param>
-</pre>
+<h2>Running a web viewer using <code>WebServer</code></h2>
-<h3>DnD</h3>
+<p>If running these viewers using the <a href="https://raw.github.com/apache/isis/master/core/webserver/src/main/java/org/apache/isis/core/webserver/WebServer.java">WebServer</a>, then the <code>deploymentType</code> defaults to prototype; see below for more details.</p>
-<p>For the <a href="../components/viewers/dnd/about.html">dnd</a> viewer, the <code>deploymentType</code> is specified at the command-line, for example:</p>
+<p>It is possible to explicitly specify the deployment mode at the command line:</p>
-<pre><code>-t prototype
+<pre><code>-t server_prototype
</code></pre>
<p>or using the long form:</p>
-<pre><code>--type exploration
+<pre><code>--type server_exploration
</code></pre>
-<p>The default if not specified is <code>PROTOTYPE</code>.</p>
+<p>Only <code>server_*</code>-style <code>deploymentType</code>s should be specified (it has a bearing on the way that Isis does its session management).</p>
+
+<h2>Component Defaults</h2>
+
+<p>If a component implementation is not specified explicitly, then the default is based on the deployment category (see the <a href="https://raw.github.com/apache/isis/master/core/runtime/src/main/java/org/apache/isis/core/runtime/installers/InstallerLookupDefault.java">InstallerLookupDefault</a> class).</p>
+
+<table class="table table-striped table-bordered table-condensed">
+<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>
+</tr>
+<tr>
+ <td>EXPLORING</td>
+ <td>SERVER_EXPLORATION<br/>
+EXPLORATION<br/>
+UTILITY</td>
+ <td><a href="../core/bypass-security.html">Bypass</a></td>
+ <td><a href="../core/bypass-security.html">Bypass</a></td>
+ <td><a href="../core/inmemory-objectstore.html">In-memory</a></td>
+ <td><a href="../core/inmemory-profilestore.html">In-memory</a></td>
+ </tr>
+<tr>
+ <td>PROTOTYPING</td>
+ <td>SERVER_PROTOTYPE<br/>
+PROTOTYPE</td>
+ <td><a href="../components/security/file/about.html">File-based</a></td>
+ <td><a href="../core/bypass-security.html">Bypass</a></td>
+ <td><a href="../core/inmemory-objectstore.html">In-memory</a></td>
+ <td><a href="../core/inmemory-profilestore.html">In-memory</a></td>
+</tr>
+<tr>
+ <td>PRODUCTION</td>
+ <td>SERVER<br/>
+UNIT_TESTING<br/>
+SINGLE_USER</td>
+ <td><a href="../components/security/file/about.html">File-based</a></td>
+ <td><a href="../components/security/file/about.html">File-based</a></td>
+ <td><a href="../components/objectstores/xml/about.html">XML</a></td>
+ <td><a href="../components/profilestores/xml/about.html">XML</a></td>
+</tr>
+</table>
Modified: websites/staging/isis/trunk/content/reference/recognized-annotations/Exploration.html
==============================================================================
--- websites/staging/isis/trunk/content/reference/recognized-annotations/Exploration.html (original)
+++ websites/staging/isis/trunk/content/reference/recognized-annotations/Exploration.html Mon Mar 17 13:10:13 2014
@@ -332,8 +332,7 @@
<p>The <code>@Exploration</code> annotation marks an action method as available in
exploration mode only, and therefore not intended for use in the
-production system. An exploration action may or may not also be a debug
-action (annotated with <code>@Debug</code><!--, see ?-->).</p>
+production system. </p>
<p>For example:</p>
@@ -345,7 +344,9 @@ action (annotated with <code>@Debug</cod
}
</code></pre>
-<p>See also the <!-...@Prototype--> annotation<!--, ?-->.</p>
+<h4>See also</h4>
+
+<p>See also the <a href="./prototype.html">@Prototype</a> annotation.</p>
Modified: websites/staging/isis/trunk/content/reference/recognized-annotations/Prototype.html
==============================================================================
--- websites/staging/isis/trunk/content/reference/recognized-annotations/Prototype.html (original)
+++ websites/staging/isis/trunk/content/reference/recognized-annotations/Prototype.html Mon Mar 17 13:10:13 2014
@@ -332,8 +332,7 @@
<p>The <code>@Prototype</code> annotation marks an action method as available in
prototype mode only, and therefore not intended for use in the
-production system. A prototype action may or may not also be a debug
-action (annotated with <code>@Debug</code> <!--, see ?)-->.</p>
+production system.</p>
<p>For example:</p>
@@ -345,7 +344,9 @@ action (annotated with <code>@Debug</cod
}
</code></pre>
-<p>See also the @Exploration annotation <!--, ?-->.</p>
+<h4>See also</h4>
+
+<p>See also the <a href="./exploration.html">@Exploration</a> annotation.</p>