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 2018/01/04 12:35:13 UTC
[isis] 01/03: ISIS-1465: removes '1.16.0-SNAPSHOT' qualifiers from
docs (since these now are published to versions/SNAPSHOT) so safe to
already be the "next version".
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 2504f3dab08eb0f58013348c0017a32f9905cc11
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Jan 3 17:32:17 2018 +0000
ISIS-1465: removes '1.16.0-SNAPSHOT' qualifiers from docs (since these now are published to versions/SNAPSHOT) so safe to already be the "next version".
---
.../guides/rgcfg/_rgcfg_configuring-core.adoc | 11 +-
.../_rgcms_classes_AppManifest-bootstrapping.adoc | 8 +-
.../_rgcms_classes_AppManifest2-bootstrapping.adoc | 4 +-
.../guides/rgcms/_rgcms_classes_layout.adoc | 8 +-
.../guides/rgcms/_rgcms_classes_menubars.adoc | 2 +-
.../guides/rgcms/_rgcms_classes_mixins_Object.adoc | 2 +-
.../_rgcms_classes_utility_ObjectContracts.adoc | 4 +-
.../guides/rgsvc/_rgsvc_application-layer-api.adoc | 2 +-
...vc_application-layer-api_BackgroundService.adoc | 2 +-
...svc_application-layer-api_DtoMappingHelper.adoc | 2 +-
...c_application-layer-api_TransactionService.adoc | 4 +-
...vc_bootstrapping-spi_ClassDiscoveryService.adoc | 2 +-
.../_rgsvc_integration-api_BookmarkService.adoc | 2 +-
.../_rgsvc_metadata-api_MetamodelService.adoc | 6 +-
.../rgsvc/_rgsvc_metadata-api_ServiceRegistry.adoc | 2 +-
...vc_persistence-layer-api_RepositoryService.adoc | 4 +-
...gsvc_persistence-layer-spi_AuditingService.adoc | 2 +-
.../rgsvc/_rgsvc_presentation-layer-api.adoc | 4 +-
...c_presentation-layer-api_BookmarkUiService.adoc | 2 +-
...esentation-layer-spi_MenuBarsLoaderService.adoc | 2 +-
...svc_presentation-layer-spi_MenuBarsService.adoc | 2 +-
..._presentation-layer-spi_UserProfileService.adoc | 2 +-
.../ugfun/_ugfun_building-blocks_modules.adoc | 5 +-
..._ugfun_getting-started_simpleapp-archetype.adoc | 5 +-
.../guides/ugodn/_ugodn_configuring_bulk-load.adoc | 2 +-
.../ugodn/_ugodn_configuring_properties.adoc | 4 +-
..._ugtst_bdd-spec-support_writing-a-bdd-spec.adoc | 8 +-
.../_ugtst_fixture-scripts_api-and-usage.adoc | 4 +-
...gtst_fixture-scripts_ticking-clock-fixture.adoc | 2 +-
.../_ugtst_integ-test-support_abstract-class.adoc | 8 +-
.../_ugtst_integ-test-support_bootstrapping.adoc | 217 +--------------------
.../guides/ugvro/_ugvro_layout-resources.adoc | 4 +-
.../guides/ugvw/_ugvw_menubars-layout.adoc | 2 +-
.../ugvw/_ugvw_menubars-layout_file-based.adoc | 4 +-
34 files changed, 60 insertions(+), 284 deletions(-)
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_configuring-core.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_configuring-core.adoc
index f3357c3..e950bf9 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_configuring-core.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_configuring-core.adoc
@@ -675,7 +675,7 @@ Only intended for "emergency use" as a workaround while pending fix/patch to Apa
`action`
|`true`,`false` +
(`false`)
-|(`1.16.0-SNAPSHOT`) Whether action methods need to be explicitly annotated using `@Action`.
+|Whether action methods need to be explicitly annotated using `@Action`.
The default is that any non-`@Programmatic` methods that are not otherwise recognised as properties, collections or supporting methods, are assumed to be actions.
Setting this property reverses this policy, effectively requiring that all actions need to be annotated with `@Action`.
@@ -777,7 +777,7 @@ Further discussion xref:rgcfg.adoc#__rgcfg_configuring-core_isis-viewers-propert
`collectionLayout.defaultView`
|`hidden`, `table` +
(`hidden`)
-|(`1.16.0-SNAPSHOT`) Default for the default view for all (parented) collections if not explicitly specified using xref:../rgant/rgant.adoc#_rgant-CollectionLayout_defaultView[`@CollectionLayout#defaultView()`]
+|Default for the default view for all (parented) collections if not explicitly specified using xref:../rgant/rgant.adoc#_rgant-CollectionLayout_defaultView[`@CollectionLayout#defaultView()`]
Further discussion xref:rgcfg.adoc#__rgcfg_configuring-core_isis-viewers-collectionLayout-defaultView[below].
|===
@@ -871,11 +871,10 @@ At the time of writing, this means labels are to the left for all datatypes exce
[[__rgcfg_configuring-core_isis-viewers-collectionLayout-defaultView]]
-=== `collectionLayout.defaultView` (`1.16.0-SNAPSHOT`)
+=== `collectionLayout.defaultView`
-Prior to `1.16.0-SNAPSHOT`, the framework renders (parented) collections as "hidden", ie collapsed.
+By default the framework renders (parented) collections as "hidden", ie collapsed.
This can be overridden on a case-by-case basis using the xref:../rgant/rgant.adoc#_rgant-CollectionLayout_defaultView[`@CollectionLayout#defaultView()`] or the corresponding `<collectionLayout defaultView="...">` element in the `Xxx.layout.xml` layout file.
-The framework provices only one other view, "table".
If the majority of collections should be displayed as "table" form, then it is more convenient to specify the default view globally.
This can be done using a configuration property in `isis.properties`:
@@ -884,5 +883,3 @@ This can be done using a configuration property in `isis.properties`:
----
isis.viewers.collectionLayout.defaultView=table
----
-
-If this configuration property is not present then Apache Isis will render according to its historical default, namely "hidden".
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 48fa4df..c7d7298 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
@@ -11,12 +11,8 @@ This section describes how to implement the `AppManifest` interface to bootstrap
[TIP]
====
-As of `1.15.0`, the framework-provided `AppManifestAbstract` and `AppManifestAbstract.Builder` make it easy to write ``AppManifest`` that can be used both to bootstrap the application "proper", and to be tweaked for use within integration tests.
-====
-
-[TIP]
-====
-As of `1.16.0-SNAPSHOT`, the framework-provided `AppManifestAbstract2` and `AppManifestAbstract2.Builder` makes it even easier to write an `AppManifest`, this time using an implementation of a xref:rgcms.adoc#_rgcms_classes_Module[`Module`].
+The framework-provided `AppManifestAbstract2` and `AppManifestAbstract2.Builder` makes it easy to write an `AppManifest`, defined by a set of xref:rgcms.adoc#_rgcms_classes_Module[`Module`] implementations.
+The app manifest can then be used both to bootstrap the application "proper", or for integration tests.
====
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest2-bootstrapping.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest2-bootstrapping.adoc
index 14ec7dc..56521c5 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest2-bootstrapping.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest2-bootstrapping.adoc
@@ -1,11 +1,11 @@
[[_rgcms_classes_AppManifest2-bootstrapping]]
-= `AppManifest2` (and `Module`) (`1.16.0-SNAPSHOT`)
+= `AppManifest2` (and `Module`)
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
-(As of `1.16.0-SNAPSHOT`), the bootstrapping of an Apache Isis application has been modularized using the `Module` interface, with `AppManifest2` an extension of the original xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[`AppManifest`] interface, defined in terms of `Module` also.
+The bootstrapping of an Apache Isis application has been modularized using the `Module` interface, with `AppManifest2` (an extension of the original xref:rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[`AppManifest`] interface) defined in terms of ``Module``s also.
A `Module` represents a collection of entities and domain services that provide a set of coherent functionality under a single package (and subpackages underneath), with the module class itself residing at the top-level package.
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc
index f2e45c2..6eb8ba9 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc
@@ -21,9 +21,9 @@ The component classes, meanwhile, are broadly equivalent to the "layout" annotat
All of the classes in this package are JAXB-annotated, meaning that they can be serialized to/from XML (the `component` classes in the `http://isis.apache.org/applib/layout/component` XSD namespace, the bootstrap 3 grid classes in the `http://isis.apache.org/applib/layout/grid/bootstrap3` XSD namespace).
This ability to serialize to/from XML is used by the xref:../rgsvc/rgsvc.adoc#_rgsvc_presentation-layer-spi_GridLoaderService[`GridLoaderService`], the default implementation of which reads the grid layout for a domain class from a `.layout.xml` file on the classpath.
-It also allows the grid to be exposed through the REST API provided by the xref:../ugvro/ugvro.adoc#[Restful Objects viewer], as either XML or (as of `1.16.0-SNAPSHOT`) JSON.
+It also allows the grid to be exposed through the REST API provided by the xref:../ugvro/ugvro.adoc#[Restful Objects viewer], as either XML or JSON.
-(Also as of `1.16.0-SNAPSHOT`), the various components (properties, collections, actions and domain object) also allow a link to be associated with each.
+The various components (properties, collections, actions and domain object) also allow a link to be associated with each.
These links are populated by the framework automatically when exposing the object layout grid through the REST API, pointing back to the standard Restful Objects resources.
This design greatly assists in the implementation of generic REST clients.
@@ -112,7 +112,7 @@ The XSD for these classes is available at link:http://isis.apache.org/applib/lay
[[__rgcms_classes_layout_link]]
-== Link (`1.16.0-SNAPSHOT`)
+== Link
The link classes reside in the `org.apache.isis.applib.layout.links` package, and consist of just the `Link` class:
@@ -126,7 +126,7 @@ public class Link {
...
}
----
-<1> an "rel" (as defined by section 2.7.1.2 of the RO spec v1.0), identifying the nature of the link.
+<1> a "rel" (as defined by section 2.7.1.2 of the RO spec v1.0), identifying the nature of the link.
<2> the HTTP method to access the link.
This is always "GET".
<3> The (absolute) URL to access the Restful Objects resource.
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_menubars.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_menubars.adoc
index 83ba17c..c262723 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_menubars.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_menubars.adoc
@@ -1,5 +1,5 @@
[[_rgcms_classes_menubars]]
-= MenuBars Layout (`1.16.0-SNAPSHOT`)
+= MenuBars Layout
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Object.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Object.adoc
index c64d7bc..1609d73 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Object.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Object.adoc
@@ -113,7 +113,7 @@ This mixin calls xref:../rgsvc/rgsvc.adoc#_rgsvc_metadata-api_LayoutService[`Lay
[[__rgcms_classes_mixins_Object_openRestApi]]
-== `openRestApi()` (`1.16.0-SNAPSHOT`)
+== `openRestApi()`
The `Object_openRestApi` mixin provides an action to navigate to the URL of the xref:../ugvro/ugvro.adoc#[Restful Objects resource] corresponding to the domain object.
It has the following signature:
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_utility_ObjectContracts.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_utility_ObjectContracts.adoc
index a5d70d8..68695e0 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_utility_ObjectContracts.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_utility_ObjectContracts.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-The `ObjectContracts` test (and, as of `1.16.0-SNAPSHOT`, its replacement `ObjectContracts2`) provides a series of methods to make it easy for your domain objects to:
+The `ObjectContracts2` utility class provides a series of methods to make it easy for your domain objects to:
* implement `Comparable` (eg so can be stored in ``java.util.SortedSet``s)
* implement `toString()`
@@ -35,7 +35,7 @@ public class ToDoItem implements Comparable<ToDoItem> {
[WARNING]
====
-Note that `ObjectContracts` makes heavy use of Java Reflection. While it's great to get going quickly in prototyping, we recommend you use your IDE to code generate implementations of these methods for production code.
+Note that `ObjectContracts2` makes heavy use of Java Reflection. While it's great to get going quickly in prototyping, we recommend you use your IDE to code generate implementations of these methods for production code.
Moreover (and perhaps even more importantly) `ObjectContracts` implementation can cause DataNucleus to recursively rehydrate a larger number of associated entities (More detail below).
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api.adoc
index 40c2f4c..7d13989 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api.adoc
@@ -65,7 +65,7 @@ The xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_InteractionContext[`In
|`DtoMappingHelper` +
``o.a.i.core`` +
``isis-core-applib``
-|(`1.16.0-SNAPSHOT`) API is also a concrete class.
+|API is also a concrete class.
|xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_InteractionContext[`o.a.i.applib.` +
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_BackgroundService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_BackgroundService.adoc
index 0ac659a..8a5fb8d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_BackgroundService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_BackgroundService.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-The `BackgroundService2` domain service, and also the companion
+The `BackgroundService2` domain service (and its various supertypes), and also the companion
xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-spi_BackgroundCommandService[`BackgroundCommandService2`] SPI service, enable commands
to be persisted such that they may be invoked in the background.
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_DtoMappingHelper.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_DtoMappingHelper.adoc
index 6aea684..a52b7b3 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_DtoMappingHelper.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_DtoMappingHelper.adoc
@@ -1,5 +1,5 @@
[[_rgsvc_application-layer-api_DtoMappingHelper]]
-= `DtoMappingHelper` (`1.16.0-SNAPSHOT`)
+= `DtoMappingHelper`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_TransactionService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_TransactionService.adoc
index 2211a45..0320657 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_TransactionService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_TransactionService.adoc
@@ -1,11 +1,11 @@
[[_rgsvc_application-layer-api_TransactionService]]
-= `TransactionService3` (`1.16.0-SNAPSHOT`)
+= `TransactionService3`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
-The `TransactionService3` (`1.16.0-SNAPSHOT`) provides a small number of methods to allow domain objects to influence user transactions.
+The `TransactionService3` (and its various supertypes) allows domain objects to influence user transactions.
[NOTE]
====
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_bootstrapping-spi_ClassDiscoveryService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_bootstrapping-spi_ClassDiscoveryService.adoc
index 350f3b7..860c85e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_bootstrapping-spi_ClassDiscoveryService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_bootstrapping-spi_ClassDiscoveryService.adoc
@@ -6,7 +6,7 @@
-The `ClassDiscoveryService2` service is used to automatically discover subclasses of any given type on the classpath.
+The `ClassDiscoveryService2` service (and its various supertypes) is used to automatically discover subclasses of any given type on the classpath.
The primary use case is to support "convention-over-configuration" designs that work with a minimum of configuration.
This service is used by the xref:../rgcms/rgcms.adoc#_rgcms_classes_super_FixtureScripts[`FixtureScripts`] service to automatically locate any xref:../rgcms/rgcms.adoc#_rgcms_classes_super_FixtureScript[`FixtureScript`] implementations.
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_integration-api_BookmarkService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_integration-api_BookmarkService.adoc
index 9ace2f2..f8ca522 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_integration-api_BookmarkService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_integration-api_BookmarkService.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-The `BookmarkService2` API provides the ability to obtain a serializable ``o.a.i.applib.bookmarks.Bookmark`` for any (persisted) domain object, and to lookup domain objects given a ``Bookmark``. This can then in turn be converted to and from a string.
+The `BookmarkService2` domain service (and its various supertypes) provides the ability to obtain a serializable ``o.a.i.applib.bookmarks.Bookmark`` for any (persisted) domain object, and to lookup domain objects given a ``Bookmark``. This can then in turn be converted to and from a string.
For example, a `Customer` object with:
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api_MetamodelService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api_MetamodelService.adoc
index f799da4..a7b7813 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api_MetamodelService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api_MetamodelService.adoc
@@ -1,12 +1,12 @@
[[_rgsvc_metadata-api_MetamodelService]]
-= `MetaModelService`
+= `MetaModelService4`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
-The `MetaModelService` service (and its various subtypes) provides access to a number of aspects of Apache Isis' internal metamodel.
+The `MetaModelService4` service (and its various supertypes) provides access to a number of aspects of Apache Isis' internal metamodel.
@@ -50,7 +50,7 @@ public interface MetaModelService4 {
<4> returns a list of representations of each of member of each domain class.
<5> what sort of object a domain type is (or bookmark) represents
<6> whether to throw an exception or return `Sort.UNKNOWN` if the object type is not recognized. (The overloads with no `Mode` parameter default to strict mode).
-<7> (As of `1.16.0-SNAPSHOT`), returns the `AppManifest` used to bootstrap the application.
+<7> returns the `AppManifest` used to bootstrap the application.
If an `AppManifest2` was used (from a `Module`), then this is also returned (else just `null`).
== Implementation
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api_ServiceRegistry.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api_ServiceRegistry.adoc
index 90507cb..c8bc229 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api_ServiceRegistry.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api_ServiceRegistry.adoc
@@ -5,7 +5,7 @@
:_imagesdir: images/
-The `ServiceRegistry2` service collects together methods for injecting or looking up domain services (either provided by the framework or application-specific) currently known to the runtime.
+The `ServiceRegistry2` domain service (and its various supertypes)collects together methods for injecting or looking up domain services (either provided by the framework or application-specific) currently known to the runtime.
[NOTE]
====
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api_RepositoryService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api_RepositoryService.adoc
index bfc3fc4..4cbfb69 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api_RepositoryService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api_RepositoryService.adoc
@@ -71,9 +71,9 @@ If no instance is found then `null `will be returned, while if there is more tha
Generally this method is preferred for looking up an object by its (primary or alternate) key.
<11> As the previous, but with client-side filtering using a `Predicate`.
Only really intended for prototyping.
-<12> (Deprecated as of `1.16.0-SNAPSHOT`) Returns the first instance that matches the supplied query. If no instance is found then `null `will be returned.
+<12> (Deprecated) returns the first instance that matches the supplied query. If no instance is found then `null `will be returned.
No exception is thrown if more than one matches, so this is less strict that `uniqueMatch(...)`.
-<13> (Deprecated as of `1.16.0-SNAPSHOT`) As the previous, but with client-side filtering using a `Predicate`.
+<13> (Deprecated) As the previous, but with client-side filtering using a `Predicate`.
Only really intended for prototyping.
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi_AuditingService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi_AuditingService.adoc
index 9f908f6..9b04d69 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi_AuditingService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi_AuditingService.adoc
@@ -7,7 +7,7 @@
-The `AuditingService3` auditing service provides a simple mechanism to capture changes to data.
+The `AuditingService3` auditing service (and its various supertypes)provides a simple mechanism to capture changes to data.
It is called for each property that has changed on any domain object, as a set of pre- and post-values.
[NOTE]
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-api.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-api.adoc
index bdaaecb..7cdcfbc 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-api.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-api.adoc
@@ -35,11 +35,11 @@ It also lists their corresponding implementation.
|xref:../rgsvc/rgsvc.adoc#_rgsvc_presentation-layer-api_BookmarkUiService[`o.a.i.applib.` +
`services.bookmarkui` +
`BookmarkUiService`]
-|Manage bookmarks and breadcrumbs in the UIO.
+|Manage bookmarks and breadcrumbs in the (Wicket) UI.
|`BookmarkUiServiceWicket` +
``o.a.i.core`` +
``isis-core-viewer-wicket-impl``
-|(`1.16.0-SNAPSHOT`) Implementation only usable within the xref:../ugvw/ugvw.adoc#[Wicket viewer].
+|(Implementation only usable within the xref:../ugvw/ugvw.adoc#[Wicket viewer].
|xref:../rgsvc/rgsvc.adoc#_rgsvc_presentation-api_DeepLinkService[`o.a.i.applib` +
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-api_BookmarkUiService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-api_BookmarkUiService.adoc
index 84494ba..764621e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-api_BookmarkUiService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-api_BookmarkUiService.adoc
@@ -1,5 +1,5 @@
[[_rgsvc_presentation-api_BookmarkUiService]]
-= `BookmarkUiService` (`1.16.0-SNAPSHOT`)
+= `BookmarkUiService`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_MenuBarsLoaderService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_MenuBarsLoaderService.adoc
index cc0cac4..fb17d62 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_MenuBarsLoaderService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_MenuBarsLoaderService.adoc
@@ -1,5 +1,5 @@
[[_rgsvc_presentation-layer-spi_MenuBarsLoaderService]]
-= `MenuBarsLoaderService` (`1.16.0-SNAPSHOT`)
+= `MenuBarsLoaderService`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_MenuBarsService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_MenuBarsService.adoc
index b13ebd5..d311a81 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_MenuBarsService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_MenuBarsService.adoc
@@ -1,5 +1,5 @@
[[_rgsvc_presentation-layer-spi_MenuBarsService]]
-= `MenuBarsService` (`1.16.0-SNAPSHOT`)
+= `MenuBarsService`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_UserProfileService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_UserProfileService.adoc
index b361cd6..5c32a3a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_UserProfileService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_UserProfileService.adoc
@@ -33,7 +33,7 @@ In the future this API may be expanded; one obvious possibility is to return a p
== Implementation
-(As of `1.16.0-SNAPSHOT`) the framework provides a default implementation of this service, `o.a.i.core.runtime.services.UserProfileServiceDefault`.
+The framework provides a default implementation of this service, `o.a.i.core.runtime.services.UserProfileServiceDefault`.
This simply returns the user's name as the user's profile name.
An example implementation can also be found in the (non-ASF)
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_modules.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_modules.adoc
index a8f5db8..c67f6f4 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_modules.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_modules.adoc
@@ -17,9 +17,10 @@ The framework then performs classpath scanning across all such packages to locat
In the same way that the Java module act as a namespace for domain objects, it's good practice to map domain entities to their own (database) schemas.
-In previous versions a module class did not need to implement any specific interface; all the framework used was the package of the provided class.
-As of `1.16.0-SNAPSHOT` however, the xref:../rgcms/rgcms.adoc#_rgcms_classes_Module[`Module`] interface allows a module to specify its direct dependencies; from these all transitive dependencies are calculated.
+The module class does not _need_ to implement any specific interface; in this case the framework uses the module class simply to obtain a package to scan for entities and domain services.
+However, it's recommended to implement the xref:../rgcms/rgcms.adoc#_rgcms_classes_Module[`Module`] interface because this allows the module to specify its direct dependencies; from these all transitive dependencies are calculated.
This should match the compile-time dependencies declared within Maven.
+
The `Module` interface also allows a module to declare any configuration properties that should be contributed, as well as fixture scripts for reference data, and to tear down (for integration testing).
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_simpleapp-archetype.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_simpleapp-archetype.adoc
index d797771..8ff4165 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_simpleapp-archetype.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_simpleapp-archetype.adoc
@@ -5,9 +5,6 @@
:_imagesdir: images/
-NOTE: this document has been updated for `1.16.0-SNAPSHOT`.
-
-
The quickest way to get started building an application "for real" is to run the `simpleapp` archetype.
Like the xref:ugfun.adoc#_ugfun_getting-started_helloworld-archetype[helloworld archetype], this too will generate a very simple one-class domain model (an entity called `SimpleObject` with a couple of properties).
@@ -35,7 +32,7 @@ To build the app from the latest stable release, then run the following command:
mvn archetype:generate \
-D archetypeGroupId=org.apache.isis.archetype \
-D archetypeArtifactId=simpleapp-archetype \
- -D archetypeVersion=1.15.1 \
+ -D archetypeVersion=1.16.0 \
-D groupId=com.mycompany \
-D artifactId=myapp \
-D version=1.0-SNAPSHOT \
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_configuring_bulk-load.adoc b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_configuring_bulk-load.adoc
index 574c325..ba51ed2 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_configuring_bulk-load.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_configuring_bulk-load.adoc
@@ -1,5 +1,5 @@
[[_ugodn_configuring_bulk-load]]
-= Bulk Load of Standalone Collections (`1.16.0-SNAPSHOT`)
+= Bulk Load of Standalone Collections
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_configuring_properties.adoc b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_configuring_properties.adoc
index b7b89f8..fd22b73 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_configuring_properties.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugodn/_ugodn_configuring_properties.adoc
@@ -24,7 +24,7 @@ These configuration properties are typically stored in `WEB-INF/persistor_datanu
`bulkLoad`
|`true`, `false` +
(`false`)
-|(`1.16.0-SNAPSHOT`) Enables bulk load of standalone collections.
+|Enables bulk load of standalone collections.
Further xref:../ugodn/ugodn.adoc#_ugodn_configuring_bulk-load[discussion below].
@@ -45,7 +45,7 @@ There generally is no need to change this from its default.
`RegisterEntities.` +
`packagePrefix`
|fully qualified package names, CSV
-|(As of `1.16.0-SNAPSHOT`), this property is derived automatically derived from the set of modules provided in the xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AppManifest[`AppManifest`], and so does not need to be specified explicitly.
+|This property is derived automatically derived from the set of modules provided in the xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AppManifest[`AppManifest`], and so does not need to be specified explicitly.
It holds the set of packages to search so that DataNucleus builds its metamodel eagerly rather than lazily.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_bdd-spec-support_writing-a-bdd-spec.adoc b/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_bdd-spec-support_writing-a-bdd-spec.adoc
index dbf80f0..ae26c57 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_bdd-spec-support_writing-a-bdd-spec.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_bdd-spec-support_writing-a-bdd-spec.adoc
@@ -1,5 +1,5 @@
[[_ugtst_bdd-spec-support_writing-a-bdd-spec]]
-= Writing a BDD spec (`1.16.0-SNAPSHOT`)
+= Writing a BDD spec
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
@@ -45,11 +45,11 @@ The "@DomainAppDemo" is a custom tag we've specified to indicate the prerequisit
[NOTE]
====
-Prior to `1.16.0-SNAPSHOT` the BDD spec support provided by the framework aimed to allow tests to be written either as integration tests or as unit tests.
+Prior to `1.16.0` the BDD spec support provided by the framework aimed to allow tests to be written either as integration tests or as unit tests.
While there are good reasons for attempting this (see http://silkandspinach.net/2013/01/18/a-testing-strategy/[these] http://claysnow.co.uk/the-testing-iceberg/[blog] http://claysnow.co.uk/living-documentation-can-be-readable-and-fast/[posts]), the downside is that the programming model to support unit tests is quite different from "normal" Isis code.
-This feature is therefore being dropped.
-As of `1.16.0-SNAPSHOT`, BDD specs are assumed to run only as integration tests.
+This feature is therefore deprecated and will be removed in a future release.
+BDD specs are assumed to run only as integration tests.
====
The `RunBddSpecs` class to run this feature (and any other features in this package or subpackages) is just boilerplate
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_fixture-scripts_api-and-usage.adoc b/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_fixture-scripts_api-and-usage.adoc
index 38af6d8..ae12384 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_fixture-scripts_api-and-usage.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_fixture-scripts_api-and-usage.adoc
@@ -213,7 +213,7 @@ public class SimpleObjectIntegTest extends SimpleAppIntegTest {
[[_ugtst_fixture-scripts_api-and-usage_persona-and-builders]]
-== Personas and Builders (`1.16.0-SNAPSHOT`)
+== Personas and Builders
Good integration tests are probably the best way to understand the behaviour of the domain model: better, even, than reading the code itself.
This requires though that the tests are as minimal as possible so that the developer reading the test knows that everything mentioned in the test is essential to the functionality under test.
@@ -256,7 +256,7 @@ public interface PersonaWithFinder<T> {
}
----
-(As of `1.16.0-SNAPSHOT`) the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype] provides a sample implementation of these interfaces:
+The xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype] provides a sample implementation of these interfaces:
[source,java]
----
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_fixture-scripts_ticking-clock-fixture.adoc b/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_fixture-scripts_ticking-clock-fixture.adoc
index 179f864..fd82e9e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_fixture-scripts_ticking-clock-fixture.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_fixture-scripts_ticking-clock-fixture.adoc
@@ -1,5 +1,5 @@
[[_ugtst_fixture-scripts_ticking-clock-fixture]]
-= Ticking Clock Fixture (`1.16.0-SNAPSHOT`)
+= Ticking Clock Fixture
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_integ-test-support_abstract-class.adoc b/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_integ-test-support_abstract-class.adoc
index 00668fc..2afa3e9 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_integ-test-support_abstract-class.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_integ-test-support_abstract-class.adoc
@@ -17,10 +17,10 @@ This base class xref:ugtst.adoc#_ugtst_integ-test-support_bootstrapping[bootstra
[[__ugtst_integ-test-support_abstract-class_IntegrationTestAbstract3]]
-== `IntegrationTestAbstract3` (`1.16.0-SNAPSHOT`)
+== `IntegrationTestAbstract3`
-(As of `1.16.0-SNAPSHOT`) we recommend that your integration tests inherit from Apache Isis' `IntegrationTestAbstract3` class.
-The primary benefit over `IntegrationTestAbstract2` (discussed xref:ugtst.adoc#__ugtst_integ-test-support_abstract-class_IntegrationTestAbstract2[below] is that it allows the test to be bootstrapped by passing in a `Module` rather than an `AppManifest`.
+We recommend that your integration tests inherit from Apache Isis' `IntegrationTestAbstract3` class.
+The primary benefit over its predecessor, `IntegrationTestAbstract2` (discussed xref:ugtst.adoc#__ugtst_integ-test-support_abstract-class_IntegrationTestAbstract2[below] is that it allows the test to be bootstrapped by passing in a `Module` rather than an `AppManifest`.
For example:
@@ -35,7 +35,7 @@ public abstract class DomainAppIntegTest
}
----
-However, the `IntegrationTestAbstract3` class also allows the module to be specified externally, using either the `isis.integTest.module` or the (more general) `isis.headless.module` system property, eg by updating the `pom.xml`.
+The `IntegrationTestAbstract3` class also allows the module to be specified externally, using either the `isis.integTest.module` or the (more general) `isis.headless.module` system property, eg by updating the `pom.xml`.
For example:
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_integ-test-support_bootstrapping.adoc b/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_integ-test-support_bootstrapping.adoc
index 08d00cc..8180c9d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_integ-test-support_bootstrapping.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_integ-test-support_bootstrapping.adoc
@@ -8,15 +8,8 @@
Integration tests instantiate an Apache Isis "runtime" (as a singleton) within a JUnit test.
Because (depending on the size of your app) it takes a little time to bootstrap Apache Isis, the framework caches the runtime on a thread-local from one test to the next.
-Newer releases of the framework reduce the amount of boilerplate to do this; this guide documents multiple versions.
-The example code in this section is taken from the app generated by the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype].
-
-
-
-== 1.16.0-SNAPSHOT
-
-In `1.16.0-SNAPSHOT` and later, the bootstrapping of integration tests is done using a xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest2-bootstrapping[`Module`] implementation, along with the `IntegrationTestAbstract3` superclass.
+The recommended way to bootstrapping of integration tests is done using a xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest2-bootstrapping[`Module`] implementation, along with the `IntegrationTestAbstract3` superclass.
For example, the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype]'s integration tests all inherit from this class:
@@ -35,211 +28,3 @@ where `DomainAppApplicationModule` in turn declares all the dependencies that ma
If required, the `Module` can be customised first using the various `withXxx(...)` methods to specify addition modules, domain services and configuration properties.
-== 1.15.0
-
-In `1.15.0` the bootstrapping of integration tests is done using a combination of `AppManifestAbstract` (a framework-provided implementation of xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[`AppManifest`]) and `IntegrationTestAbstract2` superclass.
-
-For example, the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype]'s integration tests all inherit from this class:
-
-[source,java]
-----
-public abstract class DomainAppIntegTestAbstract extends IntegrationTestAbstract2 {
-
- @BeforeClass
- public static void initSystem() {
- bootstrapUsing(new DomainAppAppManifest());
- }
-}
-----
-
-where `DomainAppAppManifest` in turn is:
-
-[source,java]
-----
-public class DomainAppAppManifest extends AppManifestAbstract {
-
- public static final Builder BUILDER = Builder.forModules(
- SimpleModuleDomSubmodule.class,
- DomainAppApplicationModuleFixtureSubmodule.class,
- DomainAppApplicationModuleServicesSubmodule.class
- )
- .withConfigurationPropertiesFile(DomainAppAppManifest.class,
- "isis.properties",
- "authentication_shiro.properties",
- "persistor_datanucleus.properties",
- "viewer_restfulobjects.properties",
- "viewer_wicket.properties"
- ).withAuthMechanism("shiro");
-
- public DomainAppAppManifest() {
- super(BUILDER);
- }
-}
-----
-
-The `AppManifestAbstract` class (which is also used to bootstrap the regular app as well as integration tests) is discussed further xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[here], while the `IntegrationTestAbstract2` class is discussed further xref:ugtst.adoc#_ugtst_integ-test-support_abstract-class[here].
-
-
-
-== 1.13.0
-
-In `1.13.0` the bootstrapping itself is typically performed by a "system initializer" class.
-This is responsible for instantiating the Apache Isis runtime (based on a provided `AppManifest`) and binding it to a thread-local.
-
-The `AppManifest.Util` class allows configuration properties for integration testing to be defined (replacing the `IsisConfigurationForJdoIntegTests` of earlier releases).
-
-For example:
-
-[source,java]
-----
-public class DomainAppSystemInitializer {
- public static void initIsft() {
- IsisSystemForTest isft = IsisSystemForTest.getElseNull();
- if(isft == null) {
- isft = new IsisSystemForTest.Builder()
- .withLoggingAt(org.apache.log4j.Level.INFO)
- .with(new DomainAppAppManifest() {
- @Override
- public Map<String, String> getConfigurationProperties() {
- final Map<String, String> map = Maps.newHashMap();
- Util.withJavaxJdoRunInMemoryProperties(map);
- Util.withDataNucleusProperties(map);
- Util.withIsisIntegTestProperties(map);
- return map;
- }
- })
- .build();
- isft.setUpSystem();
- IsisSystemForTest.set(isft);
- }
- }
-}
-----
-
-
-The above code uses the `AppManifest.Util` helper class, which provides a number of static methods that can be used to set up xref:ugtst.adoc#_ugtst_integ-test-support_configuration-properties[configuration properties] appropriate for integration testing (eg run using an in-memory database).
-This allows the responsibility of returning the configuration properties to belong exclusively to the `AppManifest`.
-
-There are three such static methods:
-
-[source,java]
-----
-public interface AppManifest {
- ...
- public static class Util {
- public static Map<String,String>
- withJavaxJdoRunInMemoryProperties(Map<String, String> map) { ... } // <1>
- public static Map<String,String>
- withDataNucleusProperties(Map<String, String> map) { ... } // <2>
- public static Map<String,String>
- withIsisIntegTestProperties(Map<String, String> map) { ... } // <3>
- }
-}
-----
-<1> sets up the `javax.jdo.option.Connection*` properties so as to run against an in-memory instance of HSQLDB
-<2> sets up DataNucleus to automatically create the databse schema, as well as a number of other standard properties
-(disable persistence by reachability, support mixed case identifiers, disable level 2 cache)
-<3> sets up standard properties for the Apache Isis framework, most specifically to enable fixtures to be installed.
-
-
-
-
-== 1.9.0
-
-In `1.9.0` the `AppManifest` was introduced as mechanism to specify all parts (domain code, framework components, configuation properties) that make up a running application.
-
-The suggested way to use this concept was using a "system initializer" class.
-This uses a `IsisConfigurationForJdoIntegTests` class to bring together the configuration properties (discussed further xref:ugtst.adoc#_ugtst_integ-test-support_configuration-properties[here]) to bootstrap the application.
-
-For example:
-
-[source,java]
-----
-public class DomainAppSystemInitializer {
- public static void initIsft() {
- IsisSystemForTest isft = IsisSystemForTest.getElseNull();
- if(isft == null) {
- isft = new IsisSystemForTest.Builder()
- .withLoggingAt(org.apache.log4j.Level.INFO)
- .with(new DomainAppAppManifest())
- .with(new IsisConfigurationForJdoIntegTests())
- .build()
- .setUpSystem();
- IsisSystemForTest.set(isft);
- }
- }
-}
-----
-
-where `DomainAppAppManifest` in turn is defined as:
-
-[source,java]
-----
-public class DomainAppAppManifest implements AppManifest {
- @Override
- public List<Class<?>> getModules() {
- return Arrays.asList(
- domainapp.dom.DomainAppDomainModule.class,
- domainapp.fixture.DomainAppFixtureModule.class,
- domainapp.app.DomainAppAppModule.class
- );
- }
- ...
-}
-----
-
-Further details on bootstrapping with the `AppManifest` can be found in the xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[reference guide].
-
-
-
-== 1.8.0 and earlier
-
-Prior to 1.9.0, the services and entities had to be specified in two separate locations. The suggested way to do this was to introduce a subclass of the `IsisSystemForTest.Builder` class:
-
-[source,java]
-----
-private static class DomainAppSystemBuilder extends IsisSystemForTest.Builder { // <1>
- public DomainAppSystemBuilder() {
- withLoggingAt(org.apache.log4j.Level.INFO);
- with(testConfiguration());
- with(new DataNucleusPersistenceMechanismInstaller()); // <2>
- withServicesIn( "domainapp" ); // <3>
- }
- private static IsisConfiguration testConfiguration() {
- final IsisConfigurationForJdoIntegTests testConfiguration =
- new IsisConfigurationForJdoIntegTests(); // <4>
- testConfiguration.addRegisterEntitiesPackagePrefix("domainapp.dom.modules"); // <5>
- return testConfiguration;
- }
-}
-----
-<1> subclass the framework-provided `IsisSystemForTest.Builder`.
-<2> equivalent to `isis.persistor=datanucleus` in `isis.properties`
-<3> specify the `isis.services` key in `isis.properties` (where "domainapp" is the base package for all classes within the app)
-<4> `IsisConfigurationForJdoIntegTests` has pre-canned configuration for using an in-memory HSQLDB and other standard settings; more on this below.
-<5> equivalent to `isis.persistor.datanucleus.RegisterEntities.packagePrefix` key (typically in `persistor_datanucleus.properties`)
-
-
-
-This builder could then be used within the system initializer:
-
-[source,java]
-----
-public class DomainAppSystemInitializer {
- public static void initIsft() {
- IsisSystemForTest isft = IsisSystemForTest.getElseNull();
- if(isft == null) {
- isft = new DomainAppSystemBuilder() // <1>
- .build()
- .setUpSystem();
- IsisSystemForTest.set(isft); // <2>
- }
- }
- private static class DomainAppSystemBuilder
- extends IsisSystemForTest.Builder { ... }
-}
-----
-<1> instantiates and initializes the Apache Isis runtime (the `IsisSystemForTest` class)
-<2> binds the runtime to a thread-local.
-
-
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_layout-resources.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_layout-resources.adoc
index 35846a1..8bc924a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_layout-resources.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvro/_ugvro_layout-resources.adoc
@@ -1,11 +1,11 @@
[[_ugvro_layout-resources]]
-= Layout Resources (`1.16.0-SNAPSHOT`)
+= Layout Resources
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
-(As of `1.16.0-SNAPSHOT`) Apache Isis' Restful Objects viewer provides a number of additional resource endpoints that provide representations of the object layout (as per xref:../rgsvc/rgsvc.adoc#_rgsvc_presentation-layer-spi_GridService[`GridService`]) and of the menu layout (as per xref:../rgsvc/rgsvc.adoc#_rgsvc_presentation-layer-spi_MenuBarsService[`MenuBarsService`]).
+Apache Isis' Restful Objects viewer provides a number of additional resource endpoints that provide representations of the object layout (as per xref:../rgsvc/rgsvc.adoc#_rgsvc_presentation-layer-spi_GridService[`GridService`]) and of the menu layout (as per xref:../rgsvc/rgsvc.adoc#_rgsvc_presentation-layer-spi_MenuBarsService[`MenuBarsService`]).
This chapter provides details of these resources, the link ``Rel``s to access them, and the resultant representations.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_menubars-layout.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_menubars-layout.adoc
index 6e4ca6f..800b08a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_menubars-layout.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_menubars-layout.adoc
@@ -33,7 +33,7 @@ This is intended primarily for actions pertaining to the user themselves, eg the
image::{_imagesdir}application-menu/tertiary.png[width="300px",link="{_imagesdir}application-menu/tertiary.png"]
-The Apache Isis framework provides two mechanisms to control the arrangement of domain service actions across menubars and menus, either using annotations or (as of `1.16.0-SNAPSHOT`) using a file-based layout.
+The Apache Isis framework provides two mechanisms to control the arrangement of domain service actions across menubars and menus, either using annotations or using a file-based layout.
include::_ugvw_menubars-layout_annotation-based.adoc[leveloffset=+1]
include::_ugvw_menubars-layout_file-based.adoc[leveloffset=+1]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_menubars-layout_file-based.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_menubars-layout_file-based.adoc
index ae972a5..3a21146 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_menubars-layout_file-based.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvw/_ugvw_menubars-layout_file-based.adoc
@@ -1,11 +1,11 @@
[[_ugvw_menubars-layout_file-based]]
-= File-based Menu Bars (`1.16.0-SNAPSHOT`)
+= File-based Menu Bars
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
:_basedir: ../../
:_imagesdir: images/
-(As of `1.16.0-SNAPSHOT`) the domain service actions can be arranged across menu items using the `menubars.layout.xml` file.
+The domain service actions can be arranged across menu items using the `menubars.layout.xml` file.
Not only is this easier to work with, it also can be reloaded dynamically (if in prototype mode), substantially redu.
As for xref:ugvw.adoc#_ugvw_layout_file-based[file-based object layouts], this offers a number of benefits:
--
To stop receiving notification emails like this one, please contact
"commits@isis.apache.org" <co...@isis.apache.org>.