[isis] 05/11: ISIS-1811: adds TODOs in .docs, relating to the changes of web.xml (now programmatic)

[da...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

danhaywood pushed a commit to branch v2
in repository https://gitbox.apache.org/repos/asf/isis.git

commit 95bd70d92ea59708952c14fc13de5be5fc712d85
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Fri Jan 4 11:37:40 2019 +0000

    ISIS-1811: adds TODOs in .docs, relating to the changes of web.xml (now programmatic)
---
 .../guides/rgcfg/_rgcfg_specifying-components.adoc |  2 ++
 .../_rgcms_classes_AppManifest-bootstrapping.adoc  | 22 ----------------------
 ...c_application-layer-spi_HealthCheckService.adoc |  2 ++
 ...gbtb_deployment_externalized-configuration.adoc |  2 ++
 .../main/asciidoc/guides/ugbtb/_ugbtb_web-xml.adoc |  2 ++
 .../_ugsec_configuring-isis-to-use-shiro.adoc      |  3 +++
 .../guides/ugsec/_ugsec_usage-by-isis-viewers.adoc | 10 +++++++++-
 .../asciidoc/guides/ugvro/_ugvro_health-check.adoc |  2 ++
 8 files changed, 22 insertions(+), 23 deletions(-)

diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_specifying-components.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_specifying-components.adoc
index 6e36004..00e1f0b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_specifying-components.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_specifying-components.adoc
@@ -5,6 +5,8 @@
 :_imagesdir: images/
 
 
+TODO: v2: this is out of date; the way in which components are found is being reworked in v2.0.
+
 
 Bootstrapping an Apache Isis application involves identifying both:
 
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc
index bb98769..96a93a3 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc
@@ -321,25 +321,3 @@ public abstract class DomainAppIntegTestAbstract extends IntegrationTestAbstract
 
 
 
-[[__rgcms_classes_AppManifest-bootstrapping_subsidiary-goals]]
-== Subsidiary Goals
-
-There are a number of subsidiary goals of the `AppManifest` class (though not all of these are fully implemented):
-
-* Allow different integration tests to run with different manifests.
-
-** Normally the running application is shared (on a thread-local) between integration tests.
-What the framework could perhaps do is to be intelligent enough to keep track of the manifest in use for each integration test and tear down the shared state if the "next" test uses a different manifest
-
-* Provide a programmatic way to contribute elements of `web.xml`.
-
-* Provide a programmatic way to configure Shiro security.
-
-* Anticipate the module changes forthcoming in Java 9.
-
-** Eventually we see that the `AppManifest` class acting as an "aggregator", with the list of modules will become Java 9 modules each advertising the types that they export.
-** It might even be possible for ``AppManifest``s to be switched on and off dynamically (eg if Java9 is compatible with OSGi, being one of the design goals).
-
-
-
-
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi_HealthCheckService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi_HealthCheckService.adoc
index de215cb..f269dac 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi_HealthCheckService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi_HealthCheckService.adoc
@@ -35,6 +35,8 @@ Any custom implementations should be annotated using `@DomainService(nature = Na
 
 The `/restful/health` path must be specified as a "passThru" so that no authentication challenge is issued.
 
+TODO: v2: this may have changed because we now use `WebModule_Xxx` instead of `web.xml`, ie set this stuff up programmatically.
+
 [source,xml]
 .web.xml
 ----
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_deployment_externalized-configuration.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_deployment_externalized-configuration.adoc
index 52fd13b..4990d10 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_deployment_externalized-configuration.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_deployment_externalized-configuration.adoc
@@ -49,6 +49,8 @@ To tell Apache Isis to load configuration from an external directory, specify th
 
 If the external configuration directory is fixed for all environments (systest, UAT, prod etc), then you can specify within the `web.xml` itself:
 
+TODO: v2: this has almost certainly changed, because the configuration is picked up earlier; this probably no longer works.
+
 [source,xml]
 ----
 <context-param>
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_web-xml.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_web-xml.adoc
index 7ba3244..c6d43cb 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_web-xml.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb/_ugbtb_web-xml.adoc
@@ -5,6 +5,8 @@
 :_imagesdir: images/
 
 
+TODO: v2: a lot of this has changed, because we now use `WebModule_Xxx` instead of `web.xml`, ie set this stuff up programmatically.
+
 
 Apache Isis provides two different viewers, the xref:../ugvw/ugvw.adoc#[Wicket viewer] and the xref:../ugvro/ugvro.adoc#[RestfulObjects viewer].
 You can deploy both of these concurrently, or deploy just the Wicket viewer, or deploy just the Restful Objects viewer.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_configuring-isis-to-use-shiro.adoc b/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_configuring-isis-to-use-shiro.adoc
index be41430..0288543 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_configuring-isis-to-use-shiro.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_configuring-isis-to-use-shiro.adoc
@@ -62,6 +62,9 @@ Setting it to `true` may cause a race condition resulting in exceptions being lo
 
 == Bootstrapping Shiro
 
+TODO: v2: this configuration is no longer required in `web.xml`, instead is configured programmatically by the framework (`WebModule_Shiro`).
+
+
 The Shiro environment (in essence, thread-locals holding the security credentials) needs to be bootstrapped using the following settings in the `WEB-INF/web.xml` file:
 
 [source,xml]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_usage-by-isis-viewers.adoc b/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_usage-by-isis-viewers.adoc
index 41d23b9..426daa3 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_usage-by-isis-viewers.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugsec/_ugsec_usage-by-isis-viewers.adoc
@@ -68,7 +68,8 @@ If you are using an LDAP realm and want to enable user-self registration then yo
 
 == Restful Objects Viewer
 
-Unlike the Wicket viewer, the xref:../ugvro/ugvro.adoc#[Restful Objects viewer] does *not* provide any sort of login page; rather it provides a pluggable authentication strategy, delegated to by the `IsisSessionFilter` filter defined in `web.xml`.  The authentication strategy is responsible for ensuring that a session is available for the REST resource.
+Unlike the Wicket viewer, the xref:../ugvro/ugvro.adoc#[Restful Objects viewer] does *not* provide any sort of login page; rather it provides a pluggable authentication strategy, delegated to by the `IsisSessionFilter` filter (set up by the framework's web bootstrapping).
+The authentication strategy is responsible for ensuring that a session is available for the REST resource.
 
 The API of `AuthenticationSessionStrategy` is simply:
 
@@ -102,6 +103,8 @@ As you can see, none of these should be considered production-quality.
 
 The strategy is configured in `web.xml`; for example:
 
+TODO: v2: this has changed, I think, because we now use `WebModule_Xxx` instead of `web.xml`, ie set this stuff up programmatically.
+
 [source,xml]
 ----
 <filter>
@@ -128,8 +131,11 @@ The strategy is configured in `web.xml`; for example:
 <3> which paths are allowed to be accessed directly, without a session.  The `/restful/swagger` path provides access to the SwaggerResource that dynamically generates swagger schema definition files from the Apache Isis metamodel.
 
 
+
 The above filter must then be chained before the servlet that actually handles the REST requests:
 
+TODO: v2: this has changed, I think, because we now use `WebModule_Xxx` instead of `web.xml`, ie set this stuff up programmatically.
+
 [source,xml]
 ----
 <filter-mapping>
@@ -186,6 +192,8 @@ public class CustomRestfulObjectsApplication extends RestfulObjectsApplication {
 
 * Register your application class in `web.xml` instead of the default: +
 +
+TODO: v2: this may have changed, because we now use `WebModule_Xxx` instead of `web.xml`, ie set this stuff up programmatically.
++
 [source,xml]
 ----
 <context-param>
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_health-check.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_health-check.adoc
index f28896b..3eeff75 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_health-check.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_health-check.adoc
@@ -51,6 +51,8 @@ Moreover (unless the `HealthCheckService` implementation uses the `WrapperFactor
 
 The `/restful/health` path must be specified as a "passThru" in `web.xml` so that no authentication challenge is issued.
 
+TODO: v2: this has changed, because we now use `WebModule_Xxx` instead of `web.xml`, ie set this stuff up programmatically.
+
 [source,xml]
 .web.xml
 ----