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:51 UTC
[isis] 09/14: ISIS-2062: fixes up links to BackgroundService.adoc,
BackgroundCommandExecution.adoc, Quartz.adoc
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 af2954d09acc64e089d8654db4d013f1c26d3abd
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Feb 20 00:14:10 2020 +0000
ISIS-2062: fixes up links to BackgroundService.adoc, BackgroundCommandExecution.adoc, Quartz.adoc
---
.../modules/btb/pages/headless-access.adoc | 2 +-
.../BackgroundCommandExecution.adoc | 3 +-
.../framework-provided.adoc | 2 +-
.../modules/applib-ant/pages/Action/command.adoc | 50 ++++++++++----------
.../modules/applib-ant/pages/Property/command.adoc | 53 ++++++++++++----------
.../applib-svc/pages/BackgroundCommandService.adoc | 6 +--
.../modules/applib-svc/pages/CommandContext.adoc | 14 +++---
.../modules/applib-svc/pages/CommandService.adoc | 10 ++--
.../applib-svc/pages/InteractionContext.adoc | 15 ++----
.../applib-svc/pages/_BackgroundService.adoc | 2 +-
.../_BackgroundCommandExecution.adoc | 2 +-
.../_Quartz.adoc | 2 +-
.../applib-svc/partials/application-layer-api.adoc | 24 +++++-----
.../modules/applib-svc/partials/module-nav.adoc | 6 +--
14 files changed, 98 insertions(+), 93 deletions(-)
diff --git a/api/adoc/userguide/modules/btb/pages/headless-access.adoc b/api/adoc/userguide/modules/btb/pages/headless-access.adoc
index a518e8c..7d479ed 100644
--- a/api/adoc/userguide/modules/btb/pages/headless-access.adoc
+++ b/api/adoc/userguide/modules/btb/pages/headless-access.adoc
@@ -20,4 +20,4 @@ The API described in this chapter is reasonably low-level, allowing code to inte
include::headless-access/AbstractIsisSessionTemplate.adoc[leveloffset=+1]
-include::headless-access/BackgroundCommandExecution.adoc[leveloffset=+1]
+//include::headless-access/BackgroundCommandExecution.adoc[leveloffset=+1]
diff --git a/api/adoc/userguide/modules/btb/pages/headless-access/BackgroundCommandExecution.adoc b/api/adoc/userguide/modules/btb/pages/headless-access/BackgroundCommandExecution.adoc
index 3314384..482b93e 100644
--- a/api/adoc/userguide/modules/btb/pages/headless-access/BackgroundCommandExecution.adoc
+++ b/api/adoc/userguide/modules/btb/pages/headless-access/BackgroundCommandExecution.adoc
@@ -1,9 +1,10 @@
-[[BackgroundCommandExecution]]
= BackgroundCommandExecution
: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 - this functionality has been temporarily removed, will be reinstated for v2.0
+
The `BackgroundCommandExecution` class (a subclass of xref:userguide:btb:about.adoc#BackgroundCommandService[`BackgroundCommandService`].
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 fbe14f8..80be478 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
@@ -30,7 +30,7 @@ Commands/Interactions/Background/Auditing/Publishing/Profiling:
* xref:refguide:applib-svc:application-layer-spi/CommandService.adoc[`CommandService`] (SPI)
* xref:refguide:applib-svc:application-layer-api/InteractionContext.adoc[`InteractionContext`] (SPI)
* xref:refguide:applib-svc:persistence-layer-spi/AuditerService.adoc[`AuditerService`] (SPI)
-* xref:refguide:applib-svc:application-layer-api/BackgroundService.adoc[`BackgroundService`]
+//* xref:refguide:applib-svc:application-layer-api/BackgroundService.adoc[`BackgroundService`]
* xref:refguide:applib-svc:application-layer-spi/BackgroundCommandService.adoc[`BackgroundCommandService`] (SPI)
* xref:refguide:applib-svc:persistence-layer-spi/PublisherService.adoc[`PublisherService`] (SPI)
* xref:refguide:applib-svc:persistence-layer-api/MetricsService.adoc[`MetricsService`]
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 5e99b9d..276adc2 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
@@ -19,7 +19,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:spi/BackgroundService.adoc[`BackgroundService`] and
* xref:refguide:applib-svc:application-layer-spi/BackgroundCommandService.adoc[`BackgroundCommandService`]
@@ -28,12 +28,12 @@ Each action invocation is automatically reified by the xref:refguide:applib-svc:
If an appropriate `CommandService` is configured (for example using (non-ASF) link:https://platform.incode.org/modules/spi/command/spi-command.html[Incode Platform's command] module), then the `Command` itself is persisted.
By default, actions are invoked in directly in the thread of the invocation.
-If there is an implementation of `BackgroundCommandService` (as the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s command module does provide), then this means in turn that the `BackgroundService` can be used by the domain object code to programmatically create background ``Command``s.
+//If there is an implementation of `BackgroundCommandService` (as the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s command module does provide), then this means in turn that the `BackgroundService` can be used by the domain object code to programmatically create background ``Command``s.
-[NOTE]
-====
-If background ``Command``s are used, then an external scheduler, using xref:userguide:btb:about.adoc#BackgroundCommandExecution[headless access], must also be configured.
-====
+//[NOTE]
+//====
+//If background ``Command``s are used, then an external scheduler, using xref:userguide:btb:about.adoc#BackgroundCommandExecution[headless access], must also be configured.
+//====
@@ -278,24 +278,26 @@ If `command` is `DISABLED` or does not otherwise apply due to the action's decla
For persisted commands, the `commandExecuteIn` attribute determines whether the `Command` should be executed in the foreground (the default) or executed in the background.
-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:
-
-[source,java]
-----
-public class Order {
- @Action(
- command=CommandReification.ENABLED,
- commandExecuteIn=CommandExecuteIn.BACKGROUND
- )
- public Invoice generateInvoice(...) { /* ... */ }
-}
-----
-
-will result in the `Command` being persisted but its execution deferred to a background execution mechanism.
-The returned object from this action invocation is the persisted `Command` itself.
+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.
+//See xref:userguide:btb:about.adoc#BackgroundCommandExecution[here] for further information on this topic.
+
+//For example:
+//
+//[source,java]
+//----
+//public class Order {
+// @Action(
+// command=CommandReification.ENABLED,
+// commandExecuteIn=CommandExecuteIn.BACKGROUND
+// )
+// public Invoice generateInvoice(...) { /* ... */ }
+//}
+//----
+//
+//will result in the `Command` being persisted but its execution deferred to a background execution mechanism.
+//The returned object from this action invocation is the persisted `Command` itself.
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 e9a267b..f1c5fd1 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
@@ -15,8 +15,8 @@ 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:spi/BackgroundService.adoc[`BackgroundService`] and
+//* 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.
@@ -24,12 +24,12 @@ Each property edit is automatically reified by the xref:refguide:applib-svc:appl
If an appropriate `CommandService` is configured (for example using (non-ASF) link:https://platform.incode.org/modules/spi/command/spi-command.html[Incode Platform's command] module), then the `Command` itself is persisted.
By default, actions are invoked in directly in the thread of the invocation.
-If there is an implementation of `BackgroundCommandService` (as the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s command module does provide), then this means in turn that the `BackgroundService` can be used by the domain object code to programmatically create background ``Command``s.
+//If there is an implementation of `BackgroundCommandService` (as the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s command module does provide), then this means in turn that the `BackgroundService` can be used by the domain object code to programmatically create background ``Command``s.
-[NOTE]
-====
-If background ``Command``s are used, then an external scheduler, using xref:userguide:btb:about.adoc#BackgroundCommandExecution[headless access], must also be configured.
-====
+//[NOTE]
+//====
+//If background ``Command``s are used, then an external scheduler, using xref:userguide:btb:about.adoc#BackgroundCommandExecution[headless access], must also be configured.
+//====
== `command()` and `commandPersistence()`
@@ -193,24 +193,27 @@ If `command` is `DISABLED` or does not otherwise apply due to the action's decla
For persisted commands, the `commandExecuteIn` attribute determines whether the `Command` should be executed in the foreground (the default) or executed in the background.
-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:
-
-[source,java]
-----
-public class Order {
- @Property(
- command=CommandReification.ENABLED,
- commandExecuteIn=CommandExecuteIn.BACKGROUND
- )
- public Product getProduct() { /* ... */ }
- public void setProduct(Product p) { /* ... */ }
-}
-----
-
-will result in the `Command` being persisted but its execution deferred to a background execution mechanism.
-The returned object from this property edit is the persisted `Command` itself.
+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.
+//See xref:userguide:btb:about.adoc#BackgroundCommandExecution[here] for further information on this topic.
+
+//For example:
+//
+//[source,java]
+//----
+//public class Order {
+// @Property(
+// command=CommandReification.ENABLED,
+// commandExecuteIn=CommandExecuteIn.BACKGROUND
+// )
+// public Product getProduct() { /* ... */ }
+// public void setProduct(Product p) { /* ... */ }
+//}
+//----
+//
+//will result in the `Command` being persisted but its execution deferred to a background execution mechanism.
+//The returned object from this property edit is the persisted `Command` itself.
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
index be6a85b..53c066a 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/BackgroundCommandService.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/pages/BackgroundCommandService.adoc
@@ -1,15 +1,15 @@
-[[BackgroundCommandService]]
= `BackgroundCommandService2`
: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 - temporarily removed, to be reinstated in v2.0
The `BackgroundCommandService2` (SPI) service supports the xref:refguide:applib-svc:.BackgroundService.adoc[`BackgroundService`] (API) service, persisting action invocations as commands such that they can subsequently be invoked in the background.
The `BackgroundService` is responsible for capturing a memento representing the action invocation, and then hands off to the xref:refguide:applib-svc:.BackgroundCommandService.adoc[`BackgroundCommandService`] `BackgroundCommandService` to actually persist it.
-The persisting of commands is only half the story; there needs to be a separate process to read the commands and execute them. The abstract xref:refguide:applib-svc:.BackgroundService/BackgroundCommandExecution.adoc[`BackgroundCommandExecution`] provides a mechanism to execute such commands. This can be considered an API, albeit "internal" because the implementation relies on internals of the framework.
+The persisting of commands is only half the story; there needs to be a separate process to read the commands and execute them.
+The abstract xref:refguide:applib-svc:.BackgroundService/BackgroundCommandExecution.adoc[`BackgroundCommandExecution`] provides a mechanism to execute such commands. This can be considered an API, albeit "internal" because the implementation relies on internals of the framework.
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 881786b..268baf4 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
@@ -215,9 +215,11 @@ String user = commandContext.getCommand().getUser();
The xref:refguide:applib-svc:.CommandContext.adoc[`CommandContext`] service is very similar in nature to the xref:refguide:applib-svc:.InteractionContext.adoc[`InteractionContext`], in that the `Command` object accessed through it is very similar to the `Interaction` object obtained from the `InteractionContext`.
The principle distinction is that while `Command` represents the __intention__ to invoke an action or edit a property, the `Interaction` (and contained ``Execution``s) represents the actual execution.
-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.
-
-``Command``s - even if executed in the foreground - can also be persisted by way of the xref:refguide:applib-svc:.CommandService.adoc[`CommandService`].
-Implementations of `CommandService` and `BackgroundCommandService` are intended to go together, so that child ``Command``s persistent (to be executed in the background) can be associated with their parent ``Command``s (executed in the foreground, with the background `Command` created explicitly through the xref:refguide:applib-svc:.BackgroundService.adoc[`BackgroundService`]).
+//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.
+
+``Command``s
+//- even if executed in the foreground -
+can also be persisted by way of the xref:refguide:applib-svc:.CommandService.adoc[`CommandService`].
+//Implementations of `CommandService` and `BackgroundCommandService` are intended to go together, so that child ``Command``s persistent (to be executed in the background) can be associated with their parent ``Command``s (executed in the foreground, with the background `Command` created explicitly through the xref:refguide:applib-svc:.BackgroundService.adoc[`BackgroundService`]).
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 b583896..633b9dc 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
@@ -7,9 +7,11 @@
The `CommandService` service supports the xref:refguide:applib-svc:.CommandContext.adoc[`CommandContext`] service such that `Command` objects (that reify the invocation of an action/edit of a property on a domain object) can be persisted.
-The primary use case for persistent ``Command``s is in support of background commands; they act as a parent to any background commands that can be persisted either explicitly using the xref:refguide:applib-svc:.BackgroundService.adoc[`BackgroundService`], or implicitly by way of the xref:refguide:applib-ant:Action.adoc#command[`@Action#command()`] annotation.
+//The primary use case for persistent ``Command``s is in support of background commands; they act as a parent to any background commands that can be persisted either explicitly using the xref:refguide:applib-svc:.BackgroundService.adoc[`BackgroundService`], or implicitly by way of the xref:refguide:applib-ant:Action.adoc#command[`@Action#command()`] annotation.
-Persistent ``Command``s also support the ability to replicate from a master to a slave instance of an application.
+Persistent ``Command``s
+//also
+support the ability to replicate from a master to a slave instance of an application.
One use case for this is for regression testing, allowing a production usages to be replayed against a new release candidate, eg after upgrading that application to a new version of Apache Isis itself (or some other dependency).
There are a number of related use cases:
@@ -94,9 +96,9 @@ 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.
+//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.
The services provided by this module combines very well with the xref:refguide:applib-svc:.AuditerService.adoc[`AuditerService`].
The `CommandService` captures the __cause__ of an interaction (an action was invoked, a property was edited), while the `AuditerService` captures the __effect__ of that interaction in terms of changed state.
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/InteractionContext.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/InteractionContext.adoc
index afe24c6..e90e95a 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/InteractionContext.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/pages/InteractionContext.adoc
@@ -187,15 +187,10 @@ xref:refguide:applib-svc:.EventBusService.adoc[`EventBusService`].
== Related Classes
-This service is very similar in nature to xref:refguide:applib-svc:.CommandContext.adoc[`CommandContext`], in that the
-`Interaction` object accessed through it is very similar to the `Command` object obtained from the `CommandContext`.
-The principle distinction is that while `Command` represents the __intention__ to invoke an action or edit a property,
-the `Interaction` (and contained ``Execution``s) represents the actual execution.
-
-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]).
+This service is very similar in nature to xref:refguide:applib-svc:.CommandContext.adoc[`CommandContext`], in that the `Interaction` object accessed through it is very similar to the `Command` object obtained from the `CommandContext`.
+The principle distinction is that while `Command` represents the __intention__ to invoke an action or edit a property, the `Interaction` (and contained ``Execution``s) represents the actual execution.
+
+//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]).
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/_BackgroundService.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/_BackgroundService.adoc
index baa75fd..de6cb3e 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/_BackgroundService.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/pages/_BackgroundService.adoc
@@ -1,8 +1,8 @@
-[[BackgroundService]]
= `BackgroundService`
: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 - temporarily removed, will be reinstated for v2.0
The `BackgroundService` domain service (and its various supertypes), and also the companion xref:refguide:applib-svc:.BackgroundCommandService.adoc[`BackgroundCommandService2`] SPI service, enable commands to be persisted such that they may be invoked in the background.
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/BackgroundService/_BackgroundCommandExecution.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/_BackgroundService/_BackgroundCommandExecution.adoc
similarity index 94%
rename from api/applib/src/main/adoc/modules/applib-svc/pages/BackgroundService/_BackgroundCommandExecution.adoc
rename to api/applib/src/main/adoc/modules/applib-svc/pages/_BackgroundService/_BackgroundCommandExecution.adoc
index b598674..ec09d01 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/BackgroundService/_BackgroundCommandExecution.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/pages/_BackgroundService/_BackgroundCommandExecution.adoc
@@ -1,8 +1,8 @@
-[[BackgroundCommandExecution]]
= `BackgroundCommandExec'n` abstract class
: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 - temporarily removed, will be reintroduced in v2.0
The `BackgroundCommandExecution` (in isis-core) is an abstract template class provided by isis-core that defines an abstract hook method to obtain background `Command`s to be executed:
diff --git a/api/applib/src/main/adoc/modules/applib-svc/pages/BackgroundService/_Quartz.adoc b/api/applib/src/main/adoc/modules/applib-svc/pages/_BackgroundService/_Quartz.adoc
similarity index 98%
rename from api/applib/src/main/adoc/modules/applib-svc/pages/BackgroundService/_Quartz.adoc
rename to api/applib/src/main/adoc/modules/applib-svc/pages/_BackgroundService/_Quartz.adoc
index ead0d43..7b02d06 100644
--- a/api/applib/src/main/adoc/modules/applib-svc/pages/BackgroundService/_Quartz.adoc
+++ b/api/applib/src/main/adoc/modules/applib-svc/pages/_BackgroundService/_Quartz.adoc
@@ -3,7 +3,7 @@
: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 - background command execution temporarily removed, will be reinstated for v2.0
The last part of the puzzle is to actually run the (appropriate implementation of) `BackgroundCommandExecution`).
This could be run in a batch job overnight, or run continually by, say, the http://quartz-scheduler.org[Quartz] scheduler or by link:http://camel.apache.org[Apache Camel].
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 5e9e24d..c6f3d24 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
@@ -18,18 +18,18 @@ It also lists their corresponding implementation, either a default implementatio
|Implementation
|Notes
-|xref:refguide:applib-svc:application-layer-api/BackgroundService.adoc[`o.a.i.applib.` +
-`services.background` +
-`BackgroundService`]
-|Programmatic persistence of commands to be persisted (so can be executed by a background mechanism, eg scheduler)
-|`BackgroundService-`
-`Default` +
-``o.a.i.core`` +
-``isis-core-runtime``
-|depends on: +
-xref:refguide:applib-svc:application-layer-spi/BackgroundCommandService.adoc[`BackgroundCommand-Service`]
-
-NOTE: TODO: v2: this has been replaced by `WrapperFactory#async(...)`
+//|xref:refguide:applib-svc:application-layer-api/BackgroundService.adoc[`o.a.i.applib.` +
+//`services.background` +
+//`BackgroundService`]
+//|Programmatic persistence of commands to be persisted (so can be executed by a background mechanism, eg scheduler)
+//|`BackgroundService-`
+//`Default` +
+//``o.a.i.core`` +
+//``isis-core-runtime``
+//|depends on: +
+//xref:refguide:applib-svc:application-layer-spi/BackgroundCommandService.adoc[`BackgroundCommand-Service`]
+//
+//NOTE: TODO: v2: this has been replaced by `WrapperFactory#async(...)`
|xref:refguide:applib-svc:application-layer-api/CommandContext.adoc[`o.a.i.applib.` +
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 093dba3..a67d23f 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
@@ -4,9 +4,9 @@
** 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:_BackgroundService.adoc[BackgroundService]
-*** xref:refguide:applib-svc:BackgroundService/_BackgroundCommandExecution.adoc[BackgroundCommandExecution]
-*** xref:refguide:applib-svc:BackgroundService/_Quartz.adoc[Quartz]
+//** xref:refguide:applib-svc:_BackgroundService.adoc[BackgroundService]
+//*** xref:refguide:applib-svc:BackgroundService/_BackgroundCommandExecution.adoc[BackgroundCommandExecution]
+//*** xref:refguide:applib-svc:BackgroundService/_Quartz.adoc[Quartz]
** xref:refguide:applib-svc:BookmarkService.adoc[BookmarkService]
** xref:refguide:applib-svc:BookmarkUiService.adoc[BookmarkUiService]
** xref:refguide:applib-svc:ClockService.adoc[ClockService]