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 2020/02/20 07:55:52 UTC
[isis] 10/14: ISIS-2062: fixes up xrefs for IsisJdoSupport,
more commenting out of BackgroundService (for now, until it's reinstated).
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 9f57685a2dee3411752bcf1a47cd45eb48543246
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Feb 20 00:31:19 2020 +0000
ISIS-2062: fixes up xrefs for IsisJdoSupport, more commenting out of BackgroundService (for now, until it's reinstated).
---
.../hints-and-tips/transactions-and-errors.adoc | 15 ++++-----
.../framework-provided.adoc | 1 -
.../userguide/modules/fun/pages/crud/finding.adoc | 2 +-
.../userguide/modules/fun/pages/crud/updating.adoc | 2 +-
.../modules/applib-ant/pages/Action/command.adoc | 2 +-
.../modules/applib-ant/pages/Property/command.adoc | 4 +--
.../pages/classes/mixins/Persistable.adoc | 2 +-
.../applib-cm/pages/methods/lifecycle/jdo-api.adoc | 4 +--
.../modules/applib-svc/pages/BookmarkService.adoc | 5 ++-
.../modules/applib-svc/pages/CommandContext.adoc | 36 +++++++++++-----------
.../modules/applib-svc/pages/CommandService.adoc | 8 ++---
.../applib-svc/pages/RepositoryService.adoc | 6 ++--
...Service.adoc => _BackgroundCommandService.adoc} | 0
.../applib-svc/pages/_IsisConfiguration.adoc | 6 ----
.../applib-svc/pages/_IsisSystemEnvironment.adoc | 5 ---
.../applib-svc/partials/application-layer-api.adoc | 2 +-
.../applib-svc/partials/core-domain-api.adoc | 9 +-----
.../modules/applib-svc/partials/module-nav.adoc | 3 +-
.../applib-svc/partials/persistence-layer-api.adoc | 10 ------
.../src/main/adoc/modules/config/pages/about.adoc | 5 +--
.../ROOT/pages/services/IsisJdoSupport.adoc | 5 ++-
.../jdo/adoc/modules/ROOT/partials/module-nav.adoc | 2 ++
22 files changed, 51 insertions(+), 83 deletions(-)
diff --git a/api/adoc/userguide/modules/btb/pages/hints-and-tips/transactions-and-errors.adoc b/api/adoc/userguide/modules/btb/pages/hints-and-tips/transactions-and-errors.adoc
index ad92703..ccbee52 100644
--- a/api/adoc/userguide/modules/btb/pages/hints-and-tips/transactions-and-errors.adoc
+++ b/api/adoc/userguide/modules/btb/pages/hints-and-tips/transactions-and-errors.adoc
@@ -3,17 +3,14 @@
: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 [...]
:page-partial:
-In Apache Isis, every interaction (action invocation or property edit) is automatically wrapped in a transaction,
-and any repository query automatically does a flush before hand.
+In Apache Isis, every interaction (action invocation or property edit) is automatically wrapped in a transaction, and any repository query automatically does a flush before hand.
-What that means is that there's no need to explicitly start or commit transactions in Apache Isis; this will be done
-for you. Indeed, if you do try to manage transactions (eg by reaching into the JDO `PersistenceManager` exposed by the
-xref:refguide:applib-svc:persistence-layer-api/IsisJdoSupport.adoc[IsisJdoSupport] domain service, then you are likely to confuse the
-framework and get a stack trace for your trouble.
+What that means is that there's no need to explicitly start or commit transactions in Apache Isis; this will be done for you.
+Indeed, if you do try to manage transactions (eg by reaching into the JDO `PersistenceManager` exposed by the xref:pjdo:ROOT:services/IsisJdoSupport.adoc[IsisJdoSupport] domain service, then you are likely to confuse the framework and get a stack trace for your trouble.
-However, you can complete a given transaction and start a new one. This is sometimes useful if writing a fixture
-script which is going to perform some sort of bulk migration of data from an old system. For this use case, use the
-xref:refguide:applib-svc:application-layer-api/TransactionService.adoc[`TransactionService`].
+However, you can complete a given transaction and start a new one.
+This is sometimes useful if writing a fixture script which is going to perform some sort of bulk migration of data from an old system.
+For this use case, use the xref:refguide:applib-svc:application-layer-api/TransactionService.adoc[`TransactionService`].
For example:
diff --git a/api/adoc/userguide/modules/fun/pages/available-domain-services/framework-provided.adoc b/api/adoc/userguide/modules/fun/pages/available-domain-services/framework-provided.adoc
index 80be478..a955266 100644
--- a/api/adoc/userguide/modules/fun/pages/available-domain-services/framework-provided.adoc
+++ b/api/adoc/userguide/modules/fun/pages/available-domain-services/framework-provided.adoc
@@ -19,7 +19,6 @@ General purpose:
* xref:refguide:applib-svc:persistence-layer-api/RepositoryService.adoc[`RepositoryService`]
* xref:refguide:applib-svc:metadata-api/ServiceRegistry.adoc[`ServiceRegistry`]
* xref:refguide:applib-svc:core-domain-api/UserService.adoc[`UserService`]
-* xref:refguide:applib-svc:persistence-layer-api/IsisJdoSupport.adoc[`IsisJdoSupport`]
* xref:refguide:applib-svc:application-layer-api/WrapperFactory.adoc[`WrapperFactory`]
* xref:refguide:applib-svc:core-domain-api/EventBusService.adoc[`EventBusService`]
* xref:refguide:applib-svc:integration-api/EmailService.adoc[`EmailService`]
diff --git a/api/adoc/userguide/modules/fun/pages/crud/finding.adoc b/api/adoc/userguide/modules/fun/pages/crud/finding.adoc
index bd12ab0..adbb39b 100644
--- a/api/adoc/userguide/modules/fun/pages/crud/finding.adoc
+++ b/api/adoc/userguide/modules/fun/pages/crud/finding.adoc
@@ -61,5 +61,5 @@ When an object is loaded from the database the framework will emit `ObjectLoaded
== Type-safe queries
-DataNucleus also supports type-safe queries; see xref:refguide:applib-svc:persistence-layer-api/IsisJdoSupport.adoc#type-safe-jdoql-queries[here] for further details.
+DataNucleus also supports type-safe queries; see xref:pjdo:ROOT:services/IsisJdoSupport.adoc#type-safe-jdoql-queries[here] for further details.
diff --git a/api/adoc/userguide/modules/fun/pages/crud/updating.adoc b/api/adoc/userguide/modules/fun/pages/crud/updating.adoc
index 4f9517e..0df3235 100644
--- a/api/adoc/userguide/modules/fun/pages/crud/updating.adoc
+++ b/api/adoc/userguide/modules/fun/pages/crud/updating.adoc
@@ -12,7 +12,7 @@ That said, it is possible to "flush" pending changes:
* xref:refguide:applib-svc:application-layer-api/TransactionService.adoc[`TransactionService`] acts at the Apache Isis layer, and flushes any pending object persistence or object deletions
-* using xref:refguide:applib-svc:persistence-layer-api/IsisJdoSupport.adoc[`IsisJdoSupport`] it is possible to reach down to the underlying JDO API, and perform a flush of pending object updates also.
+* using xref:pjdo:ROOT:services/IsisJdoSupport.adoc[`IsisJdoSupport`] it is possible to reach down to the underlying JDO API, and perform a flush of pending object updates also.
When an object is updated the framework will emit `ObjectUpdatingEvent` and `ObjectUpdatedEvent` xref:userguide:fun:building-blocks.adoc#lifecycle-events[lifecycle events].
diff --git a/api/applib/src/main/adoc/modules/applib-ant/pages/Action/command.adoc b/api/applib/src/main/adoc/modules/applib-ant/pages/Action/command.adoc
index 276adc2..14d376f 100644
--- a/api/applib/src/main/adoc/modules/applib-ant/pages/Action/command.adoc
+++ b/api/applib/src/main/adoc/modules/applib-ant/pages/Action/command.adoc
@@ -280,7 +280,7 @@ For persisted commands, the `commandExecuteIn` attribute determines whether the
WARNING: TODO: v2 - background execution has temporarily been removed, will be reinstated for v2.0.
-//Background execution means that the command is not executed immediately, but is available for a configured xref:refguide:applib-svc:application-layer-spi/BackgroundCommandService.adoc[`BackgroundCommandService`] to execute, eg by way of an in-memory scheduler such as Quartz.
+//Background execution means that the command is not executed immediately, but is available for a configured xref:refguide:applib-svc:application-layer-spi/_BackgroundCommandService.adoc[`BackgroundCommandService`] to execute, eg by way of an in-memory scheduler such as Quartz.
//See xref:userguide:btb:about.adoc#BackgroundCommandExecution[here] for further information on this topic.
//For example:
diff --git a/api/applib/src/main/adoc/modules/applib-ant/pages/Property/command.adoc b/api/applib/src/main/adoc/modules/applib-ant/pages/Property/command.adoc
index f1c5fd1..af2152f 100644
--- a/api/applib/src/main/adoc/modules/applib-ant/pages/Property/command.adoc
+++ b/api/applib/src/main/adoc/modules/applib-ant/pages/Property/command.adoc
@@ -16,7 +16,7 @@ The annotation works with (and is influenced by the behaviour of) a number of do
* xref:refguide:applib-svc:application-layer-api/CommandContext.adoc[`CommandContext`]
* xref:refguide:applib-svc:application-layer-spi/CommandService.adoc[`CommandService`]
//* xref:refguide:applib-svc:spi/BackgroundService.adoc[`BackgroundService`] and
-//* xref:refguide:applib-svc:application-layer-spi/BackgroundCommandService.adoc[`BackgroundCommandService`]
+//* xref:refguide:applib-svc:application-layer-spi/_BackgroundCommandService.adoc[`BackgroundCommandService`]
Each property edit is automatically reified by the xref:refguide:applib-svc:application-layer-api/CommandContext.adoc[`CommandContext`] service into a `Command` object, capturing details of the target object, the property, the proposed new value fo the property, the user, a timestamp and so on.
@@ -195,7 +195,7 @@ For persisted commands, the `commandExecuteIn` attribute determines whether the
WARNING: TODO: v2 - background execution has temporarily been removed, will be reinstated for v2.0.
-//Background execution means that the command is not executed immediately, but is available for a configured xref:refguide:applib-svc:application-layer-spi/BackgroundCommandService.adoc[`BackgroundCommandService`] to execute, eg by way of an in-memory scheduler such as Quartz.
+//Background execution means that the command is not executed immediately, but is available for a configured xref:refguide:applib-svc:application-layer-spi/_BackgroundCommandService.adoc[`BackgroundCommandService`] to execute, eg by way of an in-memory scheduler such as Quartz.
//See xref:userguide:btb:about.adoc#BackgroundCommandExecution[here] for further information on this topic.
//For example:
diff --git a/api/applib/src/main/adoc/modules/applib-cm/pages/classes/mixins/Persistable.adoc b/api/applib/src/main/adoc/modules/applib-cm/pages/classes/mixins/Persistable.adoc
index aa284c3..b87a2e1 100644
--- a/api/applib/src/main/adoc/modules/applib-cm/pages/classes/mixins/Persistable.adoc
+++ b/api/applib/src/main/adoc/modules/applib-cm/pages/classes/mixins/Persistable.adoc
@@ -31,7 +31,7 @@ public Clob downloadJdoMetadata( // <1>
=== Related Services
-The mixin delegates to the xref:refguide:applib-svc:persistence-layer-api/IsisJdoSupport.adoc[`IsisJdoSupport`] service to obtain a reference to the JDO `PersistenceManagerFactory`.
+The mixin delegates to the xref:pjdo:ROOT:services/IsisJdoSupport.adoc[`IsisJdoSupport`] service to obtain a reference to the JDO `PersistenceManagerFactory`.
== `datanucleusXxx`
diff --git a/api/applib/src/main/adoc/modules/applib-cm/pages/methods/lifecycle/jdo-api.adoc b/api/applib/src/main/adoc/modules/applib-cm/pages/methods/lifecycle/jdo-api.adoc
index 4d5ec6c..7443e31 100644
--- a/api/applib/src/main/adoc/modules/applib-cm/pages/methods/lifecycle/jdo-api.adoc
+++ b/api/applib/src/main/adoc/modules/applib-cm/pages/methods/lifecycle/jdo-api.adoc
@@ -11,7 +11,7 @@ As an alternative to relying on Apache Isis to call lifecycle callback methods,
We may decide to deprecate the Apache Isis callbacks in the future because they merely duplicate this functionality already available in JDO.
====
-You can gain access to the relevant JDO API using the xref:refguide:applib-svc:persistence-layer-api/IsisJdoSupport.adoc[`IsisJdoSupport`] domain service.
+You can gain access to the relevant JDO API using the xref:pjdo:ROOT:services/IsisJdoSupport.adoc[`IsisJdoSupport`] domain service.
For example:
@@ -44,7 +44,7 @@ public class ObjectChangedListenerService
----
<1> must be `@RequestScoped` because we register on the `PersistenceManager`, which is different for each request.
<2> implement whichever callback lifecycle listeners are of interest
-<3> use the injected xref:refguide:applib-svc:persistence-layer-api/IsisJdoSupport.adoc[`IsisJdoSupport`] service to obtain the `PersistenceManager`.
+<3> use the injected xref:pjdo:ROOT:services/IsisJdoSupport.adoc[`IsisJdoSupport`] service to obtain the `PersistenceManager`.
Note that it isn't possible to register on the `PersistenceManagerFactory` because listeners cannot be attached once a persistence session has been created (which it will have been when the service's `@PostConstruct` method is called).
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/BookmarkService.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/BookmarkService.adoc
index 701c7e1..2f6eaed 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/BookmarkService.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/pages/BookmarkService.adoc
@@ -92,10 +92,9 @@ A more sophisticated implementation could look inside the passed `ev` argument a
== Usage by other services
-Bookmarks are used by the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s command module's implementation of xref:refguide:applib-svc:.BackgroundCommandService.adoc[`BackgroundCommandService`], which uses a bookmark to capture the target object on which an action will be invoked subsequently.
+//Bookmarks are used by the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s command module's implementation of xref:refguide:applib-svc:._BackgroundCommandService.adoc[`BackgroundCommandService`], which uses a bookmark to capture the target object on which an action will be invoked subsequently.
-Bookmarks are also used by the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s auditing module's implementation of
-xref:refguide:applib-svc:.AuditerService.adoc[`AuditerService`].
+Bookmarks are also used by the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s auditing module's implementation of xref:refguide:applib-svc:.AuditerService.adoc[`AuditerService`].
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/CommandContext.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/CommandContext.adoc
index 268baf4..d103cac 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/CommandContext.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/pages/CommandContext.adoc
@@ -138,23 +138,23 @@ See xref:refguide:applib-ant:Action.adoc#command[`@Action#command()`] and xref:r
====
-The xref:refguide:applib-ant:Action.adoc#command[`@Action#command()`] annotation can also be used to specify whether the command should be performed in the background, for example:
-
-[source,java]
-----
-public class ToDoItem ... {
- @Action(commandExecuteIn=CommandExecuteIn.BACKGROUND)
- public ToDoItem scheduleImplicitly() {
- completeSlowly(3000);
- return this;
- }
-}
-----
-
-When a background command is invoked, the user is returned the command object itself (to provide a handle to the command being invoked).
-
-This requires that an implementation of xref:refguide:applib-svc:.CommandService.adoc[`CommandService`] that persists the commands (such as the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s command module's `CommandService`) is configured.
-It also requires that a scheduler is configured to execute the background commands, see xref:refguide:applib-svc:.BackgroundCommandService.adoc[`BackgroundCommandService`]).
+//The xref:refguide:applib-ant:Action.adoc#command[`@Action#command()`] annotation can also be used to specify whether the command should be performed in the background, for example:
+//
+//[source,java]
+//----
+//public class ToDoItem ... {
+// @Action(commandExecuteIn=CommandExecuteIn.BACKGROUND)
+// public ToDoItem scheduleImplicitly() {
+// completeSlowly(3000);
+// return this;
+// }
+//}
+//----
+//
+//When a background command is invoked, the user is returned the command object itself (to provide a handle to the command being invoked).
+//
+//This requires that an implementation of xref:refguide:applib-svc:.CommandService.adoc[`CommandService`] that persists the commands (such as the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s command module's `CommandService`) is configured.
+//It also requires that a scheduler is configured to execute the background commands, see xref:refguide:applib-svc:._BackgroundCommandService.adoc[`BackgroundCommandService`]).
@@ -217,7 +217,7 @@ The principle distinction is that while `Command` represents the __intention__ t
//Most of the time a `Command` will be followed directly by its corresponding `Interaction`.
//However, if the `Command` is annotated to run in the background (using xref:refguide:applib-ant:Action.adoc#command[`@Action#commandExecuteIn()`], or is explicitly created through the xref:refguide:applib-svc:.BackgroundService.adoc[`BackgroundService`], then the actual interaction/execution is deferred until some other mechanism invokes the command (eg as described xref:userguide:btb:about.adoc#BackgroundCommandExecution[here]).
-//The persistence of background commands requires a configured xref:refguide:applib-svc:.BackgroundCommandService.adoc[`BackgroundCommandService`]) to actually persist such commands for execution.
+//The persistence of background commands requires a configured xref:refguide:applib-svc:._BackgroundCommandService.adoc[`BackgroundCommandService`]) to actually persist such commands for execution.
``Command``s
//- even if executed in the foreground -
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/CommandService.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/CommandService.adoc
index 633b9dc..4bfb7db 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/CommandService.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/pages/CommandService.adoc
@@ -74,8 +74,8 @@ It further provides a number of supporting services:
* `org.isisaddons.module.command.dom.CommandServiceJdoContributions` contributes actions for searching for persisted child and sibling ``Command``s.
-* implementation of the
-xref:refguide:applib-svc:.CommandService.adoc[`BackgroundCommandService`].
+//* implementation of the
+//xref:refguide:applib-svc:.CommandService.adoc[`BackgroundCommandService`].
All of these can be activated by updating the `pom.xml` and updating the `AppManifest#getModules()` method.
@@ -86,7 +86,7 @@ If contributions are not required in the UI, these can be suppressed either usin
== Alternative Implementations
The (non-ASF) link:https://platform.incode.org[Incode Platform^]'s command module provides an implementation of this service (`CommandService`), and also provides a number of related domain services (`CommandJdoRepository` and `CommandServiceJdoContributions`).
-This module also provides service implementations of the xref:refguide:applib-svc:.CommandService.adoc[`BackgroundCommandService`].
+//This module also provides service implementations of the xref:refguide:applib-svc:.CommandService.adoc[`BackgroundCommandService`].
If contributions are not required in the UI, these can be suppressed either using security or by implementing a xref:userguide:btb:about.adoc#vetoing-visibility[vetoing subscriber].
@@ -96,7 +96,7 @@ If contributions are not required in the UI, these can be suppressed either usin
== Related Services
As discussed above, this service supports the xref:refguide:applib-svc:.CommandContext.adoc[`CommandContext`], providing the ability for `Command` objects to be persisted.
-//This is closely related to the xref:refguide:applib-svc:.BackgroundCommandService.adoc[`BackgroundCommandService`]that allows the xref:refguide:applib-svc:.BackgroundService.adoc[`BackgroundService`] to schedule commands for background/asynchronous execution.
+//This is closely related to the xref:refguide:applib-svc:._BackgroundCommandService.adoc[`BackgroundCommandService`]that allows the xref:refguide:applib-svc:.BackgroundService.adoc[`BackgroundService`] to schedule commands for background/asynchronous execution.
//The implementations of `CommandService` and `BackgroundCommandService` are intended to go together, so that persistent parent `Command`s can be associated with their child background `Command`s.
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/RepositoryService.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/RepositoryService.adoc
index b670a4c..c12813a 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/RepositoryService.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/pages/RepositoryService.adoc
@@ -9,7 +9,7 @@ It acts as an abstraction over the JDO/DataNucleus objectstore.
You can use it during prototyping to write naive queries (find all rows, then filter using the Guava `Predicate` API, or you can use it to call JDO link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/query.html#named[named queries] using JDOQL.
-As an alternative, you could also use link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html[JDO typesafe queries] through the xref:refguide:applib-svc:.IsisJdoSupport.adoc[`IsisJdoSupport`] service.
+
@@ -232,8 +232,8 @@ The first parameter is the `start` (0-based, the second is the `count`.
[TIP]
====
-It is also possible to query using DataNucleus' type-safe query API.
-For more details, see xref:refguide:applib-svc:.IsisJdoSupport.adoc[`IsisJdoSupport`].
+If using JDO/DataNucleus, it is also possible to use the DataNucleus type-safe query API.
+For more details, see xref:pjdo:ROOT:services/IsisJdoSupport.adoc[`IsisJdoSupport`].
====
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/BackgroundCommandService.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/_BackgroundCommandService.adoc
similarity index 100%
rename from api/applib/src/main/adoc/modules/applib-svc/pages/BackgroundCommandService.adoc
rename to api/applib/src/main/adoc/modules/applib-svc/pages/_BackgroundCommandService.adoc
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/_IsisConfiguration.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/_IsisConfiguration.adoc
deleted file mode 100644
index d8ab997..0000000
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/_IsisConfiguration.adoc
+++ /dev/null
@@ -1,6 +0,0 @@
-= `IsisConfiguration`
-: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 [...]
-:page-partial:
-
-
-WARNING: TODO: v2: to document.
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/_IsisSystemEnvironment.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/_IsisSystemEnvironment.adoc
deleted file mode 100644
index 97aba32..0000000
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/_IsisSystemEnvironment.adoc
+++ /dev/null
@@ -1,5 +0,0 @@
-= `IsisSystemEnvironment`
-: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 [...]
-
-
-TODO
diff --git a/api/applib/src/main/adoc/modules/applib-svc/partials/application-layer-api.adoc b/api/applib/src/main/adoc/modules/applib-svc/partials/application-layer-api.adoc
index c6f3d24..346fd10 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/partials/application-layer-api.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/partials/application-layer-api.adoc
@@ -27,7 +27,7 @@ It also lists their corresponding implementation, either a default implementatio
//``o.a.i.core`` +
//``isis-core-runtime``
//|depends on: +
-//xref:refguide:applib-svc:application-layer-spi/BackgroundCommandService.adoc[`BackgroundCommand-Service`]
+//xref:refguide:applib-svc:application-layer-spi/_BackgroundCommandService.adoc[`BackgroundCommand-Service`]
//
//NOTE: TODO: v2: this has been replaced by `WrapperFactory#async(...)`
diff --git a/api/applib/src/main/adoc/modules/applib-svc/partials/core-domain-api.adoc b/api/applib/src/main/adoc/modules/applib-svc/partials/core-domain-api.adoc
index d05b95a..8432c7f 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/partials/core-domain-api.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/partials/core-domain-api.adoc
@@ -56,14 +56,7 @@ It also lists their corresponding implementation, either a default implementatio
-|xref:refguide:applib-svc:core-domain-api/IsisConfiguration.adoc[`o.a.i.applib.` +
-`core.config` +
-`IsisConfiguration`]
-|Access configuration properties (eg from `application.properties` file)
-|`IsisConfiguration`
-``o.a.i.core`` +
-``isis-core-config``
-|A lower-level mechanism to obtain configuration properties.
+
diff --git a/api/applib/src/main/adoc/modules/applib-svc/partials/module-nav.adoc b/api/applib/src/main/adoc/modules/applib-svc/partials/module-nav.adoc
index a67d23f..0a64406 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/partials/module-nav.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/partials/module-nav.adoc
@@ -3,7 +3,7 @@
** xref:refguide:applib-svc:AcceptHeaderService.adoc[AcceptHeaderService]
** xref:refguide:applib-svc:ApplicationFeatureRepository.adoc[ApplicationFeatureRepository]
** xref:refguide:applib-svc:AuditerService.adoc[AuditerService]
-** xref:refguide:applib-svc:BackgroundCommandService.adoc[BackgroundCommandService]
+//** xref:refguide:applib-svc:_BackgroundCommandService.adoc[BackgroundCommandService]
//** xref:refguide:applib-svc:_BackgroundService.adoc[BackgroundService]
//*** xref:refguide:applib-svc:BackgroundService/_BackgroundCommandExecution.adoc[BackgroundCommandExecution]
//*** xref:refguide:applib-svc:BackgroundService/_Quartz.adoc[Quartz]
@@ -29,7 +29,6 @@
** xref:refguide:applib-svc:HintStore.adoc[HintStore]
** xref:refguide:applib-svc:HomePageResolverService.adoc[HomePageResolverService]
** xref:refguide:applib-svc:InteractionContext.adoc[InteractionContext]
-** xref:refguide:applib-svc:_IsisJdoSupport.adoc[JdoSupport]
** xref:refguide:applib-svc:JaxbService.adoc[JaxbService]
** xref:refguide:applib-svc:LayoutService.adoc[LayoutService]
** xref:refguide:applib-svc:LocaleProvider.adoc[LocaleProvider]
diff --git a/api/applib/src/main/adoc/modules/applib-svc/partials/persistence-layer-api.adoc b/api/applib/src/main/adoc/modules/applib-svc/partials/persistence-layer-api.adoc
index 50c9ae2..b78d8ea 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/partials/persistence-layer-api.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/partials/persistence-layer-api.adoc
@@ -20,16 +20,6 @@ It also lists their corresponding implementation, either a default implementatio
|Notes
-|xref:refguide:applib-svc:persistence-layer-api/IsisJdoSupport.adoc[`o.a.i.applib.` +
-`services.jdosupport` +
-`IsisJdoSupport`]
-|Lower level access to the JDO Persistence API.
-|`IsisJdoSupportImpl` +
-``o.a.i.core`` +
-``isis-core-runtime``
-|
-
-
|xref:refguide:applib-svc:persistence-layer-api/MetricsService.adoc[`o.a.i.applib.` +
`services.metrics` +
`MetricsService`]
diff --git a/core/config/src/main/adoc/modules/config/pages/about.adoc b/core/config/src/main/adoc/modules/config/pages/about.adoc
index 7fdc377..fbb8acf 100644
--- a/core/config/src/main/adoc/modules/config/pages/about.adoc
+++ b/core/config/src/main/adoc/modules/config/pages/about.adoc
@@ -86,7 +86,7 @@ If (by a combination of mechanisms) both prototyping and production modes are sp
=== `IsisSystemEnvironment` domain service
-Applications can discover the prototyping mode by injecting the xref:refguide:applib-svc:testing/IsisSystemEnvironment.adoc[IsisSystemEnvironment] service.
+Applications can discover the prototyping mode by injecting the `IsisSystemEnvironment` service.
@@ -162,4 +162,5 @@ The remainder of this guide lists the various configuration properties available
=== `IsisConfiguration` domain service
-Applications can discover the current configuration properties by injecting the xref:refguide:applib-svc:core-domain-api/IsisConfiguration.adoc[`IsisConfiguration`] domain service.
+Applications can discover the current configuration properties for the framework (under the `isis` top-level key) by injecting the `IsisConfiguration` domain service.
+Applications can also create their own configuration properties file; the xref:docs:starters:simpleapp.adoc[simpleapp] starter app provides an example.
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/_IsisJdoSupport.adoc b/persistence/jdo/adoc/modules/ROOT/pages/services/IsisJdoSupport.adoc
similarity index 97%
rename from api/applib/src/main/adoc/modules/applib-svc/pages/_IsisJdoSupport.adoc
rename to persistence/jdo/adoc/modules/ROOT/pages/services/IsisJdoSupport.adoc
index 5473bf6..0dbb243 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/_IsisJdoSupport.adoc
+++ b/persistence/jdo/adoc/modules/ROOT/pages/services/IsisJdoSupport.adoc
@@ -50,7 +50,7 @@ The returned value is the number of rows updated.
[TIP]
====
-As an alternative, consider using DataNucleus' link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html[type-safe JDO query API], discussed xref:refguide:applib-svc:.IsisJdoSupport.adoc#type-safe-query-api[below].
+As an alternative, consider using DataNucleus' link:http://www.datanucleus.org/products/accessplatform_4_0/jdo/jdoql_typesafe.html[type-safe JDO query API], discussed xref:pjdo:ROOT:services/IsisJdoSupport.adoc#type-safe-query-api[below].
====
@@ -144,14 +144,13 @@ private static <T> List<T> executeListAndClose(final TypesafeQuery<T> query) {
== Fixture support
-When writing xref:testing:integtestsupport:about.adoc[integration tests] you'll usually need to tear down some/all mutable transactional data before each test. One way to do that is to use the `executeUpdate(...)` method described xref:refguide:applib-svc:.IsisJdoSupport.adoc#executing-sql[above].
+When writing xref:testing:integtestsupport:about.adoc[integration tests] you'll usually need to tear down some/all mutable transactional data before each test. One way to do that is to use the `executeUpdate(...)` method described xref:pjdo:ROOT:services/IsisJdoSupport.adoc#executing-sql[above].
Alternatively, the `deleteAll(...)` method will let your test delete all instances of a class without resorting to SQL:
[source,java]
----
public interface IsisJdoSupport {
- @Programmatic
void deleteAll(Class<?>... pcClasses);
...
}
diff --git a/persistence/jdo/adoc/modules/ROOT/partials/module-nav.adoc b/persistence/jdo/adoc/modules/ROOT/partials/module-nav.adoc
index 5f95188..610e211 100644
--- a/persistence/jdo/adoc/modules/ROOT/partials/module-nav.adoc
+++ b/persistence/jdo/adoc/modules/ROOT/partials/module-nav.adoc
@@ -2,3 +2,5 @@
* xref:pjdo:ROOT:jdo-mappings.adoc[JDO Mappings]
* xref:pjdo:ROOT:db-schemas.adoc[DB Schemas]
* xref:pjdo:ROOT:hints-and-tips.adoc[Hints-n-Tips]
+* Domain Services
+** xref:pjdo:ROOT:services/IsisJdoSupport.adoc[IsisJdoSupport]