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 2019/01/06 17:22:56 UTC
[29/51] [partial] isis-site git commit: ISIS-1899: updates site for
1.17.0
http://git-wip-us.apache.org/repos/asf/isis-site/blob/1685fcc5/content/guides/ugbtb/ugbtb.html
----------------------------------------------------------------------
diff --git a/content/guides/ugbtb/ugbtb.html b/content/guides/ugbtb/ugbtb.html
index aac087c..0303d9f 100644
--- a/content/guides/ugbtb/ugbtb.html
+++ b/content/guides/ugbtb/ugbtb.html
@@ -244,7 +244,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
</form>
</div>
- <p class="nav navbar-text navbar-right small">v1.16.2</p>
+ <p class="nav navbar-text navbar-right small">v1.17.0</p>
</div>
</div>
</nav>
@@ -455,7 +455,7 @@ table.CodeRay td.code>pre{padding:0}
<p>The mode meanwhile determines the behaviour of the service. More on this below.</p>
</div>
<div class="sect3">
- <h4 id="__code_translationservicepo_code">2.2.1. <code>TranslationServicePo</code></h4>
+ <h4 id="_code_translationservicepo_code">2.2.1. <code>TranslationServicePo</code></h4>
<div class="paragraph">
<p>Isis provides a default implementation of <code>TranslationService</code>, namely <code>TranslationServicePo</code>.</p>
</div>
@@ -488,7 +488,7 @@ table.CodeRay td.code>pre{padding:0}
<p>However, for an application to be fully internationalized, any validation messages (from either <code>disableXxx()</code> or <code>validateXxx()</code> supporting methods) and also possibly an object’s title (from the <code>title()</code> method) will also require translation. Moreover, these messages must be captured in the <code>.pot</code> file such that they can be translated.</p>
</div>
<div class="sect3">
- <h4 id="__code_translatablestring_code">2.3.1. <code>TranslatableString</code></h4>
+ <h4 id="_code_translatablestring_code">2.3.1. <code>TranslatableString</code></h4>
<div class="paragraph">
<p>The first part of the puzzle is tackled by an extension to Apache Isis' programming model. Whereas previously the <code>disableXxx()</code> / <code>validateXxx()</code> / <code>title()</code> methods could only return a <code>java.lang.String</code>, they may now optionally return a <code>TranslatableString</code> (defined in Isis applib) instead.</p>
</div>
@@ -608,7 +608,7 @@ msgstr "Ich heisse {firstName} {lastName}."</code></pre>
</div>
</div>
<div class="sect3">
- <h4 id="__code_translatableexception_code">2.3.2. <code>TranslatableException</code></h4>
+ <h4 id="_code_translatableexception_code">2.3.2. <code>TranslatableException</code></h4>
<div class="paragraph">
<p>Another mechanism by which messages can be rendered to the user are as the result of exception messages thrown and recognized by an <a href="../rgsvc/rgsvc.html#_rgsvc_presentation-layer-spi_ExceptionRecognizer"><code>ExceptionRecognizer</code></a>.</p>
</div>
@@ -1104,7 +1104,7 @@ log4j.additivity.org.apache.isis.core.runtime.services.i18n.po.PotWriter=false</
<p>The <code>TranslationServicePo</code> has a number of supporting/related services.</p>
</div>
<div class="sect3">
- <h4 id="__code_localeprovider_code">2.8.1. <code>LocaleProvider</code></h4>
+ <h4 id="_code_localeprovider_code">2.8.1. <code>LocaleProvider</code></h4>
<div class="paragraph">
<p>The <code>LocaleProvider</code> API is used by the <code>TranslationServicePo</code> implementation to obtain the locale of the "current user".</p>
</div>
@@ -1126,13 +1126,13 @@ log4j.additivity.org.apache.isis.core.runtime.services.i18n.po.PotWriter=false</
</div>
</div>
<div class="sect3">
- <h4 id="__code_translationsresolver_code">2.8.2. <code>TranslationsResolver</code></h4>
+ <h4 id="_code_translationsresolver_code">2.8.2. <code>TranslationsResolver</code></h4>
<div class="paragraph">
<p>The <code>TranslationResolver</code> is used by the <code>TranslationService</code> implementation to lookup translations for a specified locale. It is this service that reads from the <code>WEB-INF/</code> (or externalized directory).</p>
</div>
</div>
<div class="sect3">
- <h4 id="__code_translationservicepomenu_code">2.8.3. <code>TranslationServicePoMenu</code></h4>
+ <h4 id="_code_translationservicepomenu_code">2.8.3. <code>TranslationServicePoMenu</code></h4>
<div class="paragraph">
<p>The <code>TranslationServicePoMenu</code> provides a couple of menu actions in the UI (prototype mode only) that interacts with the underlying <code>TranslationServicePo</code>:</p>
</div>
@@ -1176,7 +1176,7 @@ log4j.additivity.org.apache.isis.core.runtime.services.i18n.po.PotWriter=false</
</div>
<div class="sectionbody">
<div class="paragraph">
- <p>This section tackles the topic of enabling access to an Isis application directly, or at least, not through either the <a href="../ugvw/ugvw.html">Wicket</a> or <a href="../ugvro/ugvro.html">Restful</a> viewers.</p>
+ <p>This section tackles the topic of enabling access to an Apache Isis application directly, or at least, not through either the <a href="../ugvw/ugvw.html">Wicket</a> or <a href="../ugvro/ugvro.html">Restful</a> viewers.</p>
</div>
<div class="paragraph">
<p>There are several main use-cases:</p>
@@ -1185,7 +1185,7 @@ log4j.additivity.org.apache.isis.core.runtime.services.i18n.po.PotWriter=false</
<ul>
<li> <p>enabling background execution, eg of a thread managed by Quartz scheduler and running within the webapp</p> </li>
<li> <p>integration from other systems, eg for a subscriber on a pub/sub mechanism such as Camel, pushing changes through an Apache Isis domain model.</p> </li>
- <li> <p>leveraging an Isis application within a batch process</p> </li>
+ <li> <p>leveraging an Apache Isis application within a batch process</p> </li>
</ul>
</div>
<div class="paragraph">
@@ -1316,7 +1316,7 @@ log4j.additivity.org.apache.isis.core.runtime.services.i18n.po.PotWriter=false</
<p>The <code>BackgroundCommandExecutionFromBackgroundCommandServiceJdo</code> is a concrete subclass of <code>BackgroundCommandExecution</code> (see the <a href="../rgsvc/rgsvc.html#_rgsvc_application-layer-api_BackgroundService"><code>BackgroundCommandService</code></a>), the intended use being for the class to be instantiated regularly (eg every 10 seconds) by a scheduler such as <a href="http://quartz-scheduler.org">Quartz</a>) to poll for <code>Command</code>s to be executed, and then execute them.</p>
</div>
<div class="paragraph">
- <p>This implementation queries for <code>Command</code>s persisted by the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s command module’s implementations of <a href="../rgsvc/rgsvc.html#_rgsvc_application-layer-spi_CommandService"><code>CommandService</code></a> and <a href="../rgsvc/rgsvc.html#_rgsvc_application-layer-spi_BackgroundCommandService"><code>BackgroundCommandService</code></a> using the <code>BackgroundCommandServiceJdoRepository</code>.</p>
+ <p>This implementation queries for <code>Command</code>s persisted by the (non-ASF) <a href="http://platform.incode.org" target="_blank" rel="noopener">Incode Platform</a>'s command module’s implementations of <a href="../rgsvc/rgsvc.html#_rgsvc_application-layer-spi_CommandService"><code>CommandService</code></a> and <a href="../rgsvc/rgsvc.html#_rgsvc_application-layer-spi_BackgroundCommandService"><code>BackgroundCommandService</code></a> using the <code>BackgroundCommandServiceJdoRepository</code>.</p>
</div>
<div class="paragraph">
<p>The diagram below (<a href="http://yuml.me/edit/25343da1">yuml.me/25343da1</a>) shows the inheritance hierarchy for this class:</p>
@@ -2213,10 +2213,10 @@ serviceRegistry.injectServicesInto(viewModel);</code></pre>
</ul>
</div>
<div class="paragraph">
- <p>Of the various modules provided by the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>, the security module has the most features. One significant feature is the ability to associate users and objects with a "tenancy".</p>
+ <p>Of the various modules provided by the (non-ASF) <a href="http://platform.incode.org" target="_blank" rel="noopener">Incode Platform</a>, the security module has the most features. One significant feature is the ability to associate users and objects with a "tenancy".</p>
</div>
<div class="paragraph">
- <p>For more details, see the <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s security module README.</p>
+ <p>For more details, see the <a href="http://platform.incode.org" target="_blank" rel="noopener">Incode Platform</a>'s security module README.</p>
</div>
</div>
<div class="sect2">
@@ -2585,7 +2585,7 @@ serviceRegistry.injectServicesInto(viewModel);</code></pre>
<p>There are several ways to go about implementing a validator.</p>
</div>
<div class="sect4">
- <h5 id="__code_metamodelvalidator_code"><code>MetaModelValidator</code></h5>
+ <h5 id="_code_metamodelvalidator_code"><code>MetaModelValidator</code></h5>
<div class="paragraph">
<p>Any custom validator must implement Apache Isis' internal <code>MetaModelValidator</code> interface, so the simplest option is just to implement <code>MetaModelValidator</code> directly:</p>
</div>
@@ -2614,7 +2614,7 @@ serviceRegistry.injectServicesInto(viewModel);</code></pre>
</div>
</div>
<div class="sect4">
- <h5 id="__code_visitor_code"><code>Visitor</code></h5>
+ <h5 id="_code_visitor_code"><code>Visitor</code></h5>
<div class="paragraph">
<p>More often than not, you’ll want to visit every element in the metamodel, and so for this you can instead subclass from <code>MetaModelValidatorVisiting.Visitor</code>:</p>
</div>
@@ -2665,7 +2665,7 @@ serviceRegistry.injectServicesInto(viewModel);</code></pre>
</div>
</div>
<div class="sect4">
- <h5 id="__code_summarizingvisitor_code"><code>SummarizingVisitor</code></h5>
+ <h5 id="_code_summarizingvisitor_code"><code>SummarizingVisitor</code></h5>
<div class="paragraph">
<p>As a slight refinement, you can also subclass from <code>MetaModelValidatorVisiting.SummarizingVisitor</code>:</p>
</div>
@@ -3397,7 +3397,7 @@ serviceRegistry.injectServicesInto(viewModel);</code></pre>
<div class="sect3">
<h4 id="_spring_config">6.1.4. Spring Config</h4>
<div class="paragraph">
- <p>Although Apache Isis does not use Spring, it’s possible that your app may use other components that do use Spring. For example, the (non-ASF) <a href="http://platform.incode.org" target="_blank">Incode Platform</a>'s publishmq module uses ActiveMQ and Camel to support publishing; both of these leverage Spring.</p>
+ <p>Although Apache Isis does not use Spring, it’s possible that your app may use other components that do use Spring. For example, the (non-ASF) <a href="http://platform.incode.org" target="_blank" rel="noopener">Incode Platform</a>'s publishmq module uses ActiveMQ and Camel to support publishing; both of these leverage Spring.</p>
</div>
<div class="paragraph">
<p>There are several ways to externalized Spring config, but the mechanism described here is similar in nature to those that we use for externalizing Apache Isis' and Shiro’s configuration. In your <code>web.xml</code>, you will probably load the Spring application context using code such as:</p>
@@ -4030,7 +4030,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
<p>Servlet context listeners are used to perform initialization on application startup. Both Shiro (if configured as the security mechanism) and RestEasy (for the Restful Objects viewer) require their own context listener. In addition, if the Wicket viewer is <em>not</em> being used, then additional Apache Isis-specific listener is required for bootstrapping of the Apache Isis framework itself.</p>
</div>
<div class="sect3">
- <h4 id="__code_environmentloaderlistener_code_shiro">7.1.1. <code>EnvironmentLoaderListener</code> (Shiro)</h4>
+ <h4 id="_code_environmentloaderlistener_code_shiro">7.1.1. <code>EnvironmentLoaderListener</code> (Shiro)</h4>
<div class="paragraph">
<p>Bootstrap listener to startup and shutdown the web application’s Shiro <code>WebEnvironment</code> at startup and shutdown respectively.</p>
</div>
@@ -4046,7 +4046,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
</div>
</div>
<div class="sect3">
- <h4 id="__code_isiswebappbootstrapper_code">7.1.2. <code>IsisWebAppBootstrapper</code></h4>
+ <h4 id="_code_isiswebappbootstrapper_code">7.1.2. <code>IsisWebAppBootstrapper</code></h4>
<div class="paragraph">
<p>The <code>IsisWebAppBootstrapper</code> servlet context listener bootstraps the shared (global) metadata for the Apache Isis framework. This listener is not required (indeed must not be configured) if the Wicket viewer is in use.</p>
</div>
@@ -4077,7 +4077,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
</div>
</div>
<div class="sect3">
- <h4 id="__code_resteasybootstrap_code_resteasy">7.1.3. <code>ResteasyBootstrap</code> (RestEasy)</h4>
+ <h4 id="_code_resteasybootstrap_code_resteasy">7.1.3. <code>ResteasyBootstrap</code> (RestEasy)</h4>
<div class="paragraph">
<p>The <code>ResteasyBootstrap</code> servlet context listener initializes the RestEasy runtime, specifying that classes (namely, those specified in Isis' <code>RestfulObjectsApplication</code>) to be exposed as REST resources. It is required if the Restful Objects viewer is to be deployed.</p>
</div>
@@ -4128,7 +4128,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
<p>Servlets process HTTP requests and return corresponding responses.</p>
</div>
<div class="sect3">
- <h4 id="__code_httpservletdispatcher_code_resteasy">7.2.1. <code>HttpServletDispatcher</code> (RestEasy)</h4>
+ <h4 id="_code_httpservletdispatcher_code_resteasy">7.2.1. <code>HttpServletDispatcher</code> (RestEasy)</h4>
<div class="paragraph">
<p>This servlet is provided by the RestEasy framework, and does the dispatching to the resources defined by Apache Isis' <code>RestfulObjectsApplication</code> (see above).</p>
</div>
@@ -4156,7 +4156,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
</div>
</div>
<div class="sect3">
- <h4 id="__code_resourceservlet_code">7.2.2. <code>ResourceServlet</code></h4>
+ <h4 id="_code_resourceservlet_code">7.2.2. <code>ResourceServlet</code></h4>
<div class="paragraph">
<p>The <code>ResourceServlet</code> loads and services static content either from the filesystem or from the classpath, each with an appropriate mime type.</p>
</div>
@@ -4225,7 +4225,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
<p>The order in which filters appear in <code>web.xml</code> matters: first to last they define a pipeline. This is shown in the above diagrams, and the subsections also list the in the same order that they should appear in your <code>web.xml</code>.</p>
</div>
<div class="sect3">
- <h4 id="__code_shirofilter_code_shiro">7.3.1. <code>ShiroFilter</code> (Shiro)</h4>
+ <h4 id="_code_shirofilter_code_shiro">7.3.1. <code>ShiroFilter</code> (Shiro)</h4>
<div class="paragraph">
<p>Shiro filter that sets up a Shiro security manager for the request, obtained from the Shiro <code>WebEnvironment</code> set up by the Shiro <code>EnvironmentLoaderListener</code> (discussed above).</p>
</div>
@@ -4253,7 +4253,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
</div>
</div>
<div class="sect3">
- <h4 id="__code_isislogonexceptionfilter_code">7.3.2. <code>IsisLogOnExceptionFilter</code></h4>
+ <h4 id="_code_isislogonexceptionfilter_code">7.3.2. <code>IsisLogOnExceptionFilter</code></h4>
<div class="paragraph">
<p>The <code>IsisLogOnExceptionFilter</code> filter simply logs the URL of any request that causes an exception to be thrown, then re-propagates the exception. The use case is simply to ensure that all exceptions are logged (against the <code>IsisLogOnExceptionFilter</code> slf4j appender).</p>
</div>
@@ -4285,7 +4285,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
</div>
</div>
<div class="sect3">
- <h4 id="__code_resourcecachingfilter_code">7.3.3. <code>ResourceCachingFilter</code></h4>
+ <h4 id="_code_resourcecachingfilter_code">7.3.3. <code>ResourceCachingFilter</code></h4>
<div class="paragraph">
<p>The <code>ResourceCachingFilter</code> adds HTTP cache headers to specified resources, based on their pattern.</p>
</div>
@@ -4359,7 +4359,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
</div>
</div>
<div class="sect3">
- <h4 id="__code_wicketfilter_code">7.3.4. <code>WicketFilter</code></h4>
+ <h4 id="_code_wicketfilter_code">7.3.4. <code>WicketFilter</code></h4>
<div class="paragraph">
<p>The <code>WicketFilter</code> is responsible for initiating the handling of Wicket requests.</p>
</div>
@@ -4372,21 +4372,14 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
<span class="tag"><filter-name></span>WicketFilter<span class="tag"></filter-name></span>
<span class="tag"><filter-class></span>org.apache.wicket.protocol.http.WicketFilter<span class="tag"></filter-class></span>
<span class="tag"><init-param></span>
- <span class="tag"><param-name></span>applicationClassName<span class="tag"></param-name></span> <i class="conum" data-value="1"></i><b>(1)</b>
- <span class="tag"><param-value></span>domainapp.webapp.SimpleApplication<span class="tag"></param-value></span>
+ <span class="tag"><param-name></span>applicationClassName<span class="tag"></param-name></span>
+ <span class="tag"><param-value></span>org.apache.isis.viewer.wicket.viewer.IsisWicketApplication<span class="tag"></param-value></span>
<span class="tag"></init-param></span>
<span class="tag"></filter></span></code></pre>
</div>
</div>
- <div class="colist arabic">
- <table>
- <tbody>
- <tr>
- <td><i class="conum" data-value="1"></i><b>1</b></td>
- <td>specify the application (subclass of <code>IsisWicketApplication</code>) to use</td>
- </tr>
- </tbody>
- </table>
+ <div class="paragraph">
+ <p>This is generally boilerplate. It is possible to specify a subclass of <code>IsisWicketApplication</code> (and in earlier versions of the framework this was generally required), but there now exist sufficient configuration properties that subclassing is generally not required.</p>
</div>
<div class="paragraph">
<p>Its mapping is:</p>
@@ -4422,7 +4415,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
</div>
</div>
<div class="sect3">
- <h4 id="__code_isissessionfilter_code">7.3.5. <code>IsisSessionFilter</code></h4>
+ <h4 id="_code_isissessionfilter_code">7.3.5. <code>IsisSessionFilter</code></h4>
<div class="paragraph">
<p>The <code>IsisSessionFilter</code> is responsible for the (persistence) session management; in effect a wrapper around DataNucleus' <code>PersistenceManager</code> object. It is only required for the Restful Objects viewer.</p>
</div>
@@ -4443,7 +4436,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
<span class="tag"></init-param></span>
<span class="tag"><init-param></span>
<span class="tag"><param-name></span>passThru<span class="tag"></param-name></span> <i class="conum" data-value="3"></i><b>(3)</b>
- <span class="tag"><param-value></span>/restful/swagger<span class="tag"></param-value></span>
+ <span class="tag"><param-value></span>/restful/swagger,/restful/health<span class="tag"></param-value></span>
<span class="tag"></init-param></span>
<span class="comment"><!-- <init-param> <param-name>restricted</param-name> <i class="conum" data-value="4"></i><b>(4)</b> <param-value>...</param-value> </init-param> <init-param> <param-name>redirectToOnException</param-name> <i class="conum" data-value="5"></i><b>(5)</b> <param-value>...</param-value> </init-param> --></span>
<span class="tag"></filter></span></code></pre>
@@ -4462,11 +4455,11 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
</tr>
<tr>
<td><i class="conum" data-value="3"></i><b>3</b></td>
- <td>specify which URIs to ignore and simply passthru. Originally introduced to allow the <code>SwaggerSpec</code> resource (which does not require a session) to be invoked.</td>
+ <td>specify which URIs to ignore and simply pass through. Originally introduced to allow the <code>SwaggerSpec</code> resource (which does not require a session) to be invoked.</td>
</tr>
<tr>
<td><i class="conum" data-value="4"></i><b>4</b></td>
- <td>List of paths that are allowed through even if not authenticated. The servlets mapped to these paths are expected to be able to deal with there being no session. Typically they will be logon pages. See below for further details.</td>
+ <td>A comma separated list of paths that are allowed through even if not authenticated. The servlets mapped to these paths are expected to be able to deal with there being no session. Typically they will be logon pages, or for health checks (as per <a href="../rgsvc/rgsvc.html#_rgsvc_application-layer-spi_HealthCheckService"><code>HealthCheckService</code></a> SPI. See below for further details.</td>
</tr>
<tr>
<td><i class="conum" data-value="5"></i><b>5</b></td>
@@ -4503,7 +4496,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
</div>
</div>
<div class="sect3">
- <h4 id="__code_isistransactionfilterforrestfulobjects_code">7.3.6. <code>IsisTransactionFilterForRestfulObjects</code></h4>
+ <h4 id="_code_isistransactionfilterforrestfulobjects_code">7.3.6. <code>IsisTransactionFilterForRestfulObjects</code></h4>
<div class="paragraph">
<p>The <code>IsisTransactionFilterForRestfulObjects</code> filter simply ensures that a transaction is in progress for all calls routed to the <a href="../ugvro/ugvro.html">RestfulObjects viewer</a>.</p>
</div>
@@ -4537,7 +4530,7 @@ export ISIS_OPTS="isis.appManifest=domainapp.app.DomainAppAppManifestWithFixture
<p>However Apache Isis is bootstrapped (using the <code>IsisWicketApplication</code> or using <code>IsisWebAppBootstrapper</code>), it will read a number of configuration files, such as <code>isis.properties</code>.</p>
</div>
<div class="paragraph">
- <p>By default these are read from <code>WEB-INF</code> directory. This can be overriden using the <code>isis.config.dir</code> context parameter:</p>
+ <p>By default these are read from <code>WEB-INF</code> directory. This can be overridden using the <code>isis.config.dir</code> context parameter:</p>
</div>
<div class="listingblock">
<div class="content">