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 2016/05/27 09:34:20 UTC
[11/11] isis-site git commit: ISIS-1410: docs of various fixes for
reduced app startup times
ISIS-1410: docs of various fixes for reduced app startup times
Project: http://git-wip-us.apache.org/repos/asf/isis-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis-site/commit/6ed9bb09
Tree: http://git-wip-us.apache.org/repos/asf/isis-site/tree/6ed9bb09
Diff: http://git-wip-us.apache.org/repos/asf/isis-site/diff/6ed9bb09
Branch: refs/heads/asf-site
Commit: 6ed9bb094e4437d70a8f13048e8cc897f237d5c4
Parents: c0266bf
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Fri May 27 09:25:12 2016 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Fri May 27 09:25:12 2016 +0100
----------------------------------------------------------------------
content/guides/rgcfg.html | 113 +-
content/guides/rgcfg.pdf | 7952 +++++++++++++++++++----------------
content/guides/rgcms.html | 7 +-
content/guides/rgcms.pdf | 2869 ++++++-------
content/guides/rgsvc.html | 2 +-
content/guides/rgsvc.pdf | 3222 +++++++-------
content/guides/ugbtb.html | 19 +-
content/guides/ugbtb.pdf | 3239 +++++++-------
content/guides/ugtst.html | 25 +-
content/guides/ugtst.pdf | 3962 +++++++++--------
content/migration-notes.html | 76 +
content/schema/ixn/ixn-1.0.xsd | 6 -
content/schema/ixn/ixn.xsd | 6 -
content/support.html | 2 +-
14 files changed, 11180 insertions(+), 10320 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis-site/blob/6ed9bb09/content/guides/rgcfg.html
----------------------------------------------------------------------
diff --git a/content/guides/rgcfg.html b/content/guides/rgcfg.html
index 5cb2264..decd2f9 100644
--- a/content/guides/rgcfg.html
+++ b/content/guides/rgcfg.html
@@ -1258,6 +1258,21 @@ for Apache Isis and contribute back to the project)</p>
<tr>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
<p><code>isis.services.</code><br>
+<code>applicationFeatures.init</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>lazy</code>, <code>eager</code><br>
+(<code>lazy</code>)</p></td>
+<td class="tableblock halign-left valign-top"><div><div class="paragraph">
+<p>(<code>1.13.0-SNAPSHOT</code>) Whether the application features repository (which surfaces the framework’s metamodel) should be initialized lazily or eagerly. <br></p>
+</div>
+<div class="paragraph">
+<p>+
+Lazily initialization can speed up bootstrapping, useful while developing and running tests. The default prior to <code>1.13.0</code> was eager initialization.</p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><div><div class="paragraph">
+<p><code>isis.services.</code><br>
<code>audit.objects</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>all</code>, <code>none</code><br>
@@ -1303,17 +1318,6 @@ for Apache Isis and contribute back to the project)</p>
<tr>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
<p><code>isis.services.</code><br>
-<code>container.disableAutoFlush</code></p>
-</div></div></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code>,<code>false</code><br>
-(<code>false</code>)</p></td>
-<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p>Whether the <code>DomainObjectContainer</code> should automatically flush pending changes prior to querying (via <code>allMatches()</code>, <code>firstMatch()</code> and so on).</p>
-</div></div></td>
-</tr>
-<tr>
-<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p><code>isis.services.</code><br>
<code>ContentNegotiation-</code><br>
<code>ServiceXRoDomainType</code><br>
.<code>prettyPrint</code></p>
@@ -1451,6 +1455,36 @@ FQCN (<code><em>guava</em></code>)</p></td>
<tr>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
<p><code>isis.services.</code><br>
+<code>injector.injectPrefix</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code>,<code>false</code> <br>
+(<code>false</code>)</p></td>
+<td class="tableblock halign-left valign-top"><div><div class="paragraph">
+<p>(<code>1.13.0-SNAPSHOT</code>) Whether the framework should support <code>inject…​()</code> as a prefix for injecting domain services into other domain objects.</p>
+</div>
+<div class="paragraph">
+<p>+
+By default this is disabled. The default prior to <code>1.13.0</code> was enabled. If the setting is left as disabled then this may reduce application start-up times.</p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><div><div class="paragraph">
+<p><code>isis.services.</code><br>
+<code>injector.setPrefix</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code>,<code>false</code> <br>
+(<code>true</code>)</p></td>
+<td class="tableblock halign-left valign-top"><div><div class="paragraph">
+<p>(<code>1.13.0-SNAPSHOT</code>) Whether the framework should support <code>set…​()</code> as a prefix for injecting domain services into other domain objects.</p>
+</div>
+<div class="paragraph">
+<p>+
+By default this is enabled (no change in <code>1.13.0</code>). If the setting is changed to disabled then this may reduce application start-up times.</p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><div><div class="paragraph">
+<p><code>isis.services.</code><br>
<code>publish.objects</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>all</code>, <code>none</code><br>
@@ -1602,6 +1636,9 @@ FQCN (<code><em>guava</em></code>)</p></td>
</div>
<div class="paragraph">
<p>See <a href="ugbtb.html#_ugbtb_programming-model_finetuning">finetuning the programming model</a> for more details.</p>
+</div>
+<div class="paragraph">
+<p><code>1.13.0-SNAPSHOT</code> - this property is now ignored. To customize the programming model, use <code>facets.exclude</code> and <code>facets.include</code>.</p>
</div></div></td>
</tr>
<tr>
@@ -1620,6 +1657,29 @@ FQCN (<code><em>guava</em></code>)</p></td>
<tr>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
<p><code>isis.reflector.facets.</code><br>
+<code>ignoreDeprecated</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code>,<code>false</code><br>
+(<code>false</code>)</p></td>
+<td class="tableblock halign-left valign-top"><div><div class="paragraph">
+<p>(<code>1.13.0-SNAPSHOT</code>) whether deprecated facets should be ignored or honoured. <br></p>
+</div>
+<div class="paragraph">
+<p>+
+By default all deprecated facets are honoured; they remain part of the metamodel. If instead this property is set to
+<code>true</code> then the facets are simply not loaded into the metamodel and their semantics will be excluded. <br></p>
+</div>
+<div class="paragraph">
+<p>+
+In most cases this should reduce the start-up times for the application. However, be aware that this could also
+substantially alter the semantics of your application. To be safe, we recommend that you first run your application
+using <code>isis.reflector.validator.allowDeprecated</code> set to <code>false</code>; if any deprecated annotations etc. are in use, then
+the app will fail-fast and refuse to start.</p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><div><div class="paragraph">
+<p><code>isis.reflector.facets.</code><br>
<code>include</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>FQCN</code>,<code>FQCN2</code>,…​</p></td>
@@ -1661,7 +1721,11 @@ See <a href="ugbtb.html#_ugbtb_programming-model_finetuning">finetuning the prog
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code>,<code>false</code><br>
(<code>true</code>)</p></td>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
-<p>Whether deprecated annotations or naming conventions are tolerated or not. If not, then a metamodel validation error will be triggered, meaning the app won’t boot (fail-fast).</p>
+<p>Whether deprecated annotations or naming conventions are tolerated or not. If not, then a metamodel validation error will be triggered, meaning the app won’t boot (fail-fast).<br></p>
+</div>
+<div class="paragraph">
+<p>+
+See also <code>isis.reflector.facets.ignoreDeprecated</code> (<code>1.13.0-SNAPSHOT</code>).</p>
</div></div></td>
</tr>
<tr>
@@ -1697,9 +1761,8 @@ See <a href="ugbtb.html#_ugbtb_programming-model_finetuning">finetuning the prog
</tr>
</tbody>
</table>
-</div>
-<div class="sect2">
-<h3 id="_rgcfg_configuring-core_filterVisibility">5.6. Filtering visibility</h3>
+<div class="sect3">
+<h4 id="_rgcfg_configuring-core_filterVisibility">5.5.1. Filtering visibility</h4>
<div class="paragraph">
<p>The framework provides the <code>isis.reflector.facet.filterVisibility</code> configuration property that influences whether a returned object is visible to the end-user:</p>
</div>
@@ -1780,8 +1843,8 @@ some cases.</p>
</table>
</div>
</div>
-<div class="sect2">
-<h3 id="_rgcfg_configuring-core_isis-objects-editing">5.7. <code>objects.editing</code></h3>
+<div class="sect3">
+<h4 id="_rgcfg_configuring-core_isis-objects-editing">5.5.2. <code>objects.editing</code></h4>
<div class="paragraph">
<p>This configuration property in effect allows editing to be disabled globally for an application:</p>
</div>
@@ -1794,8 +1857,8 @@ some cases.</p>
<p>We recommend enabling this feature; it will help drive out the underlying business operations (processes and procedures) that require objects to change; these can then be captured as business actions.</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_rgcfg_configuring-core_isis-viewers-propertyLayout-labelPosition">5.8. <code>propertyLayout.labelPosition</code></h3>
+<div class="sect3">
+<h4 id="_rgcfg_configuring-core_isis-viewers-propertyLayout-labelPosition">5.5.3. <code>propertyLayout.labelPosition</code></h4>
<div class="paragraph">
<p>If you want a consistent look-n-feel throughout the app, eg all property labels to the top, then it’d be rather
frustrating to have to annotate every property.</p>
@@ -1822,6 +1885,7 @@ frustrating to have to annotate every property.</p>
</div>
</div>
</div>
+</div>
<div class="sect1">
<h2 id="_rgcfg_configuring-datanucleus">6. Configuring DataNucleus</h2>
<div class="sectionbody">
@@ -2221,10 +2285,13 @@ isis.persistor.datanucleus.impl.javax.jdo.option.ConnectionPassword=</code></pre
<li><a href="#_rgcfg_configuring-core_lifecycle-events">5.2. Lifecycle Events</a></li>
<li><a href="#_rgcfg_configuring-core_ui-events">5.3. UI Events</a></li>
<li><a href="#_rgcfg_configuring-core_services">5.4. Services</a></li>
-<li><a href="#_rgcfg_configuring-core_other">5.5. Other Config Properties</a></li>
-<li><a href="#_rgcfg_configuring-core_filterVisibility">5.6. Filtering visibility</a></li>
-<li><a href="#_rgcfg_configuring-core_isis-objects-editing">5.7. <code>objects.editing</code></a></li>
-<li><a href="#_rgcfg_configuring-core_isis-viewers-propertyLayout-labelPosition">5.8. <code>propertyLayout.labelPosition</code></a></li>
+<li><a href="#_rgcfg_configuring-core_other">5.5. Other Config Properties</a>
+<ul class="sectlevel3">
+<li><a href="#_rgcfg_configuring-core_filterVisibility">5.5.1. Filtering visibility</a></li>
+<li><a href="#_rgcfg_configuring-core_isis-objects-editing">5.5.2. <code>objects.editing</code></a></li>
+<li><a href="#_rgcfg_configuring-core_isis-viewers-propertyLayout-labelPosition">5.5.3. <code>propertyLayout.labelPosition</code></a></li>
+</ul>
+</li>
</ul>
</li>
<li><a href="#_rgcfg_configuring-datanucleus">6. Configuring DataNucleus</a>