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 2017/10/16 19:51:16 UTC
[isis] 01/09: ISIS-1742: removes AuditingService3 (use
AuditerService instead). Updates .adoc
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch dev/2.0.0/ISIS-1742-remove-deprecations
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 79d2de8275693edabcc35d916208d2c17582f474
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Mon Oct 16 19:43:43 2017 +0100
ISIS-1742: removes AuditingService3 (use AuditerService instead). Updates .adoc
---
.../asciidoc/guides/rgant/_rgant-DomainObject.adoc | 3 +-
.../guides/rgant/_rgant-DomainObject_auditing.adoc | 3 +-
..._persistence-layer_AuditingServiceInternal.adoc | 22 ++----
...rgsvc_application-layer-api_CommandContext.adoc | 2 +-
...c_application-layer-api_InteractionContext.adoc | 3 +-
...rgsvc_application-layer-spi_CommandService.adoc | 7 +-
.../main/asciidoc/guides/rgsvc/_rgsvc_intro.adoc | 3 +-
...rgsvc_persistence-layer-api_MetricsService.adoc | 3 +-
.../guides/rgsvc/_rgsvc_persistence-layer-spi.adoc | 12 +--
...rgsvc_persistence-layer-spi_AuditerService.adoc | 10 ---
...gsvc_persistence-layer-spi_AuditingService.adoc | 86 ----------------------
...ailable-domain-services_framework-provided.adoc | 1 -
.../_ugfun_building-blocks_identifiers_oid.adoc | 2 +-
.../src/main/asciidoc/guides/ugsec/ugsec.adoc | 2 +-
.../isis/applib/annotation/DomainObject.java | 4 +-
.../applib/services/audit/AuditingService3.java | 55 --------------
.../services/session/SessionLoggingService.java | 6 +-
.../services/auditing/AuditingServiceInternal.java | 21 +-----
todo-deprecation-list.txt | 15 +---
19 files changed, 31 insertions(+), 229 deletions(-)
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject.adoc
index 99bc031..c9df160 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject.adoc
@@ -23,8 +23,7 @@ The table below summarizes the annotation's attributes.
|`AS_CONFIGURED`, `ENABLED`, `DISABLED` +
(`AS_CONFIGURED`)
|indicates whether each of the changed properties of an object should be submitted to the registered
-xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`] (deprecated) or (its replacement)
-xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`]
+xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`](s)
|xref:../rgant/rgant.adoc#_rgant-DomainObject_autoCompleteRepository[`autoCompleteRepository()`]
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_auditing.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_auditing.adoc
index f9610a8..2c2d464 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_auditing.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_auditing.adoc
@@ -6,8 +6,7 @@
The `auditing()` attribute indicates that if the object is modified, then each of its changed properties should be
-submitted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`] (if one has been configured), or to
-any
+submitted to the registered xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`](s).
The default value for the attribute is `AS_CONFIGURED`, meaning that the
xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.audit.objects` is used to determine the
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgfis/_rgfis_persistence-layer_AuditingServiceInternal.adoc b/adocs/documentation/src/main/asciidoc/guides/rgfis/_rgfis_persistence-layer_AuditingServiceInternal.adoc
index ca025c3..8809c21 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgfis/_rgfis_persistence-layer_AuditingServiceInternal.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgfis/_rgfis_persistence-layer_AuditingServiceInternal.adoc
@@ -5,17 +5,9 @@
:_imagesdir: images/
-The (internal) `AuditingServiceInternal` domain service acts as an internal facade to any
-configured xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`] and
-xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`] services. It is responsible for obtaining the details
-of all changes to domain objects within an interaction, and then to call the configured `AuditingService` to actually
-create audit entries of those changes.
+The (internal) `AuditingServiceInternal` domain service acts as an internal facade to any registered xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`] service(s).
+It is responsible for obtaining the details of all changes to domain objects within an interaction, and then to call the configured ``AuditerService``(s) to actually create audit entries of those changes.
-[NOTE]
-====
-xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`] is now deprecated, replaced by
-xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`].
-====
@@ -30,10 +22,9 @@ public class AuditingServiceInternal {
public void audit(); // <2>
}
----
-<1> minor performance optimization as to whether any auditing services are actually enabled; checks to see if
-any xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`] has been configured, also if any
-xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditService`] are enabled.
-<2> uses the xref:../rgfis/rgfis.adoc#_rgfis_persistence-layer_ChangedObjectsServiceInternal[`ChangedObjectsServiceInternal`] to obtain details of the changed properties, then call the configured xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`].
+<1> minor performance optimization as to whether any auditing services are actually enabled; checks to see if any
+xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`] are enabled.
+<2> uses the xref:../rgfis/rgfis.adoc#_rgfis_persistence-layer_ChangedObjectsServiceInternal[`ChangedObjectsServiceInternal`] to obtain details of the changed properties, then call the configured xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`](s).
The service implementation is `o.a.i.c.r.s.auditing.AuditingServiceInternal`.
@@ -49,6 +40,7 @@ so no further configuration is required.
== Related Classes
-The service delegates between the (internal) xref:../rgfis/rgfis.adoc#_rgfis_persistence-layer_ChangedObjectsServiceInternal[`ChangedObjectsServiceInternal`] domain service to the configured xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`]. If no such `AuditingService` is configured, this service is in effect a no-op.
+The service delegates between the (internal) xref:../rgfis/rgfis.adoc#_rgfis_persistence-layer_ChangedObjectsServiceInternal[`ChangedObjectsServiceInternal`] domain service to the configured xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`](s).
+If no such service(s) are configured, then _this_ service is in effect a no-op.
The (internal) xref:../rgfis/rgfis.adoc#_rgfis_persistence-layer_PublishingServiceInternal[`PublishingServiceInternal`] performs a similar function for the xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`], also collating details of the changed objects from `ChangedObjectsServiceInternal`.
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_CommandContext.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_CommandContext.adoc
index ccc9a24..765fc02 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_CommandContext.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_CommandContext.adoc
@@ -17,7 +17,7 @@ In previous versions of the framework, persistent ``Command``s also supported a
* they enable profiling of the running application (which actions are invoked then most often, what is their response time)
* if a xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`] is configured, they provide better traceability as the `Command` is also correlated with any published events, again through the unique `transactionId` GUID
-* if a xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuderService[`AuditerService`] or xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditService[`AuditingService`] (the latter now deprecated) is configured, they provide better audit information, since the `Command` (the 'cause' of an action) can be correlated to the audit records (the "effect" of the action) through the `transactionId` GUID
+* if xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`] service(s) are configured, they provide better audit information, since the `Command` (the 'cause' of an action) can be correlated to the audit records (the "effect" of the action) through the `transactionId` GUID
As of `1.13.0`, these other uses cases are now more fully supported through the
xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_InteractionContext[`InteractionContext`] service and persistent implementations of the ``Interaction`` object, eg as provided by the (non-ASF) link:http://platform.incode.org[Incode Platform^]'s publishmq module.
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_InteractionContext.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_InteractionContext.adoc
index 55af30a..5e36933 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_InteractionContext.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_InteractionContext.adoc
@@ -25,8 +25,7 @@ It is possible for ``Interaction.Execution``s to be persisted; this is supported
* they enable profiling of the running application (which actions are invoked then most often, what is their response
time)
-* if auditing is configured (using either xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[auditing] or
-xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`]), they provide better audit information, since the
+* if auditing is configured (using xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`]), they provide better audit information, since the
`Interaction.Execution` captures the 'cause' of an interaction and can be correlated to the audit records (the "effect"
of the interaction) by way of the xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_HasTransactionId[`transactionId`]
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi_CommandService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi_CommandService.adoc
index aa34fef..c794d3c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi_CommandService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-spi_CommandService.adoc
@@ -20,8 +20,7 @@ In previous versions of the framework, persistent ``Command``s also supported a
* if xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`] is configured, they provide
better traceability as the `Command` is also correlated with any published events, again through the unique
`transactionId` GUID
-* if xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuderService[`AuditerService`] or
-xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditService[`AuditingService`] (latter deprecated) is configured, they provide better audit
+* if xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditerService[`AuditerService`](s) are configured, they provide better audit
information, since the `Command` (the 'cause' of an action) can be correlated to the audit records (the "effect" of
the action) through the `transactionId` GUID
@@ -104,8 +103,8 @@ persisted. This is closely related to the xref:../rgsvc/rgsvc.adoc#_rgsvc_applic
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:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`].
-The `CommandService` captures the _cause_ of an interaction (an action was invoked, a property was edited), while the `AuditingService3` captures the _effect_ of that interaction in terms of changed state.
+The services provided by this module combines very well with the xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`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.
You may also want to configure the xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`].
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_intro.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_intro.adoc
index d6c4b16..407a933 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_intro.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_intro.adoc
@@ -224,8 +224,7 @@ xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_TransactionService[`Transa
====
* Also at the end of each transaction, details of all changed properties are passed to any registered
-xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`] or
-xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`] (the latter deprecated) by way of the (internal)
+xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`](s) by way of the (internal)
xref:../rgfis/rgfis.adoc#_rgfis_persistence-layer_AuditingServiceInternal[`AuditingServiceInternal`] domain service.
Implementations of xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-spi_CommandService[`CommandService`] can use the `Command#getMemento()`
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api_MetricsService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api_MetricsService.adoc
index b5345e6..5c742f1 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api_MetricsService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-api_MetricsService.adoc
@@ -28,8 +28,7 @@ public interface MetricsService {
----
<1> The number of objects that have, so far in this request, been loaded from the database. Corresponds to the number of times that `javax.jdo.listener.LoadLifecycleListener#postLoad(InstanceLifecycleEvent)` is fired.
<2> The number of objects that have, so far in this request, been dirtied/will need updating in the database); a good measure of the footprint of the interaction. Corresponds to the number of times that `javax.jdo.listener.DirtyLifecycleListener#preDirty(InstanceLifecycleEvent)` callback is fired.
-<3> The number of individual properties of objects that were modified; a good measure of the amount of work being done in the interaction. Corresponds to the number of times that the xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`]'s (or
-xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`]'s) `audit(...)` method will be called as the transaction
+<3> The number of individual properties of objects that were modified; a good measure of the amount of work being done in the interaction. Corresponds to the number of times that the xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`]'s `audit(...)` method will be called as the transaction
completes.
The framework provides a default implementation of this API, namely `o.a.i.c.r.s.metrics.MetricsServiceDefault`.
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi.adoc
index 267a356..e41851d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi.adoc
@@ -24,7 +24,7 @@ It also lists their corresponding implementation, either a default implementatio
-|xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`o.a.i.applib.` +
+|xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`o.a.i.applib.` +
`services.audit` +
`AuditerService`]
|Create an audit record for every changed property of every changed object within a transaction.
@@ -36,15 +36,6 @@ also +
|
-|xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`o.a.i.applib.` +
-`services.audit` +
-`AuditingService3`]
-|(deprecated, replaced by xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`]); creates
-an audit record for every changed property of every changed object within a transaction.
-|
-|
-
-
|xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`o.a.i.applib.` +
@@ -91,6 +82,5 @@ Where an implementation is available (on the classpath) then it is always regist
include::_rgsvc_persistence-layer-spi_AuditerService.adoc[leveloffset=+1]
-include::_rgsvc_persistence-layer-spi_AuditingService.adoc[leveloffset=+1]
include::_rgsvc_persistence-layer-spi_PublisherService.adoc[leveloffset=+1]
include::_rgsvc_persistence-layer-spi_UserRegistrationService.adoc[leveloffset=+1]
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi_AuditerService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi_AuditerService.adoc
index 9daa73d..e1f7abd 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi_AuditerService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi_AuditerService.adoc
@@ -9,12 +9,6 @@
The `AuditerService` auditing service 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]
-====
-This service is intended to replace the now-deprecated xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService3`].
-The difference between the two is that this service recognises that the `transactionId` is now (as of `1.13.0`)
-actually a request/interaction Id, and that an additional `sequence
-====
== SPI
@@ -124,7 +118,3 @@ of capturing the cause. As of `1.13.0`, ``Command``s are now primarily to captu
not the actual action invocation itself.
====
-The `AuditerService` is intended to replace the (now-deprecated)
-xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService3[`AuditingService3`], as the latter does not support the concept of multiple
-transactions within a single interaction.
-
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
deleted file mode 100644
index 76f204e..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_persistence-layer-spi_AuditingService.adoc
+++ /dev/null
@@ -1,86 +0,0 @@
-[[_rgsvc_persistence-layer-spi_AuditingService]]
-= `AuditingService3` (deprecated)
-: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 `AuditingService3` auditing service 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]
-====
-This service is deprecated, replaced by xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`].
-====
-
-
-== SPI
-
-The SPI for the service is:
-
-[source,java]
-----
-public interface AuditingService3 {
-
- @Programmatic
- public void audit(
- final UUID transactionId, String targetClassName, final Bookmark target,
- String memberIdentifier, final String propertyName,
- final String preValue, final String postValue,
- final String user, final java.sql.Timestamp timestamp);
- }
-----
-
-The framework will call this for each and every domain object property that is modified within a transaction.
-
-
-
-== Implementation
-
-The most full-featured available implementation is the (non-ASF) link:http://platform.incode.org[Incode Platform^]'s audit module. This creates an audit records for each changed property (ie every time that `AuditingService3#audit(...)` is called.
-The implementation is `org.isisaddons.module.audit.dom.AuditingService`.
-
-The module also provides:
-
-* `AuditingServiceMenu` service which provides actions to search for ``AuditEntry``s, underneath an 'Activity' menu on the secondary menu bar.
-
-* `AuditingServiceRepository` service to to search for persisted `AuditEntry``s.
-None of its actions are visible in the user interface (they are all `@Programmatic`).
-
-* `AuditingServiceContributions` which contrbutes collections to the xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_HasTransactionId[ `HasTransactionId`] interface.
-This will therefore display all audit entries that occurred in a given transaction, in other words whenever a command, a published event or another audit entry is displayed.
-
-
-
-If you just want to debug (writing to stderr), you can instead configure `o.a.i.applib.services.audit.AuditingService3$Stderr`
-
-
-
-== Usage
-
-The typical way to indicate that an object should be audited is to annotate it with the xref:../rgant/rgant.adoc#_rgant-DomainObject_auditing[`@DomainObject#auditing()`] annotation.
-
-
-
-
-== Registering the Services
-
-The (non-ASF) http://github.com/isisaddons/isis-module-audit[Isis addons' audit] module provides an implementation of
-this service (`AuditingService`), and also provides a number of related domain services (`AuditingServiceMenu`,
-`AuditingServiceRepository` and `AuditingServiceContributions`).
-
-Assuming that an `AppManifest` is being used to xref:../rgcms/rgcms.adoc#_rgcms_classes_AppManifest-bootstrapping[bootstrap the app])
-then this can be activated by updating the `pom.xml` and updating the `AppManifest#getModules()` method.
-
-If menu items or contributions are not required in the UI, these can be suppressed either using security or by
-implementing a xref:../ugbtb/ugbtb.adoc#_ugbtb_hints-and-tips_vetoing-visibility[vetoing subscriber].
-
-
-
-== Related Services
-
-This service has been deprecated and replaced by the equivalent
-xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`].
-
-
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_available-domain-services_framework-provided.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_available-domain-services_framework-provided.adoc
index 5dfc1e8..e90528e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_available-domain-services_framework-provided.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_available-domain-services_framework-provided.adoc
@@ -32,7 +32,6 @@ Commands/Interactions/Background/Auditing/Publishing/Profiling:
* xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_CommandContext[`CommandContext`] (SPI)
* xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-spi_CommandService[`CommandService`] (SPI)
* xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_InteractionContext[`InteractionContext`] (SPI)
-* xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`] (SPI) (deprecated)
* xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`] (SPI)
* xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_BackgroundService[`BackgroundService`]
* xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-spi_BackgroundCommandService[`BackgroundCommandService`] (SPI)
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_identifiers_oid.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_identifiers_oid.adoc
index 3f293ff..5ac01de 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_identifiers_oid.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_identifiers_oid.adoc
@@ -25,7 +25,7 @@ Some examples:
* the information within an OID could be converted into a barcode, and stamped onto a PDF form.
When the PDF is scanned by the mail room, the barcode could be read to attach the correspondence to the relevant domain object.
-* as a handle to any object in an audit record, as used by xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`] or xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`] (the latter deprecated);
+* as a handle to any object in an audit record, as used by xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditerService[`AuditerService`];
* similarly within implementations of xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-spi_CommandService[`CommandService`] to persist `Command`
objects
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugsec/ugsec.adoc b/adocs/documentation/src/main/asciidoc/guides/ugsec/ugsec.adoc
index 9f1a12f..0fcd1a8 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugsec/ugsec.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugsec/ugsec.adoc
@@ -82,7 +82,7 @@ When ``Interaction``s are persisted (eg by way of (non-ASF) link:http://platform
traceability.
The (non-ASF) link:http://platform.incode.org[Incode Platform^]'s audit module provides an implementation of the `AuditerService`.
-For earlier versions of the framework the xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-spi_CommandService[`CommandService`] can be used to capture actions, while the (deprecated) xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_AuditingService[`AuditingService`] used to capture data modified.
+For xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-spi_CommandService[`CommandService`] can be also be used to capture actions.
====
diff --git a/core/applib/src/main/java/org/apache/isis/applib/annotation/DomainObject.java b/core/applib/src/main/java/org/apache/isis/applib/annotation/DomainObject.java
index 4d72bee..23fc34d 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/annotation/DomainObject.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/annotation/DomainObject.java
@@ -44,7 +44,7 @@ public @interface DomainObject {
* Whether the entity should be audited (note: does not apply to view models or other recreatable objects.
*
* <p>
- * Requires that an implementation of the {@link org.apache.isis.applib.services.audit.AuditingService3} is
+ * Requires that an implementation of the {@link org.apache.isis.applib.services.audit.AuditerService} is
* registered with the framework.
* </p>
*/
@@ -58,7 +58,7 @@ public @interface DomainObject {
* Whether changes to the object should be published.
*
* <p>
- * Requires that an implementation of the {@link org.apache.isis.applib.services.publish.PublishingService} is
+ * Requires that an implementation of the {@link org.apache.isis.applib.services.publish.PublisherService} is
* registered with the framework.
* </p>
*/
diff --git a/core/applib/src/main/java/org/apache/isis/applib/services/audit/AuditingService3.java b/core/applib/src/main/java/org/apache/isis/applib/services/audit/AuditingService3.java
deleted file mode 100644
index fed10e8..0000000
--- a/core/applib/src/main/java/org/apache/isis/applib/services/audit/AuditingService3.java
+++ /dev/null
@@ -1,55 +0,0 @@
-/*
- * 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 agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied. See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-package org.apache.isis.applib.services.audit;
-
-import java.sql.Timestamp;
-import java.util.UUID;
-
-import org.apache.isis.applib.annotation.Programmatic;
-import org.apache.isis.applib.services.bookmark.Bookmark;
-
-/**
- * @deprecated - use {@link AuditerService} (to support multiple transactions within an interaction)
- */
-@Deprecated
-public interface AuditingService3 {
-
- @Programmatic
- public void audit(
- final UUID transactionId, String targetClassName, final Bookmark target,
- String memberIdentifier, final String propertyName,
- final String preValue, final String postValue,
- final String user, final java.sql.Timestamp timestamp);
-
-
- public static class Stderr implements AuditingService3 {
-
- @Programmatic
- @Override
- public void audit(
- final UUID transactionId, final String targetClassName, final Bookmark target,
- final String memberId, final String propertyName,
- final String preValue, final String postValue,
- final String user, final Timestamp timestamp) {
- String auditMessage = target.toString() + " by " + user + ", " + propertyName +": " + preValue + " -> " + postValue;
- System.err.println(auditMessage);
- }
- }
-
-}
diff --git a/core/applib/src/main/java/org/apache/isis/applib/services/session/SessionLoggingService.java b/core/applib/src/main/java/org/apache/isis/applib/services/session/SessionLoggingService.java
index 84d137a..c86737c 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/services/session/SessionLoggingService.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/services/session/SessionLoggingService.java
@@ -18,12 +18,12 @@
*/
package org.apache.isis.applib.services.session;
-import org.apache.isis.applib.annotation.Programmatic;
-
import java.util.Date;
+import org.apache.isis.applib.annotation.Programmatic;
+
/**
- * Similar to the {@link org.apache.isis.applib.services.audit.AuditingService3}, this defines an API to track
+ * Similar to the {@link org.apache.isis.applib.services.audit.AuditerService}, this defines an API to track
* the status of the current sessions ("users logged on") on the system.
*/
public interface SessionLoggingService {
diff --git a/core/runtime/src/main/java/org/apache/isis/core/runtime/services/auditing/AuditingServiceInternal.java b/core/runtime/src/main/java/org/apache/isis/core/runtime/services/auditing/AuditingServiceInternal.java
index 9cb8529..6fa118e 100644
--- a/core/runtime/src/main/java/org/apache/isis/core/runtime/services/auditing/AuditingServiceInternal.java
+++ b/core/runtime/src/main/java/org/apache/isis/core/runtime/services/auditing/AuditingServiceInternal.java
@@ -27,7 +27,6 @@ import org.apache.isis.applib.annotation.DomainService;
import org.apache.isis.applib.annotation.NatureOfService;
import org.apache.isis.applib.annotation.Programmatic;
import org.apache.isis.applib.services.audit.AuditerService;
-import org.apache.isis.applib.services.audit.AuditingService3;
import org.apache.isis.applib.services.bookmark.Bookmark;
import org.apache.isis.applib.services.clock.ClockService;
import org.apache.isis.applib.services.iactn.InteractionContext;
@@ -42,7 +41,7 @@ import org.apache.isis.core.runtime.services.changes.ChangedObjectsServiceIntern
import org.apache.isis.core.runtime.services.changes.PreAndPostValues;
/**
- * Wrapper around {@link org.apache.isis.applib.services.audit.AuditingService3}. Is a no-op if there is no injected service.
+ * Wrapper around {@link org.apache.isis.applib.services.audit.AuditerService}.
*/
@DomainService(
nature = NatureOfService.DOMAIN,
@@ -60,9 +59,6 @@ public class AuditingServiceInternal {
}
private boolean determineWhetherCanAudit() {
- if (auditingServiceIfAny != null) {
- return true;
- }
for (final AuditerService auditerService : auditerServices) {
if (auditerService.isEnabled()) {
return true;
@@ -114,11 +110,6 @@ public class AuditingServiceInternal {
final UUID transactionId = transaction.getTransactionId();
final int sequence = transaction.getSequence();
-
- if(auditingServiceIfAny != null) {
- auditingServiceIfAny
- .audit(transactionId, targetClass, target, memberId, propertyId, preValue, postValue, user, timestamp);
- }
for (AuditerService auditerService : auditerServices) {
if (auditerService.isEnabled()) {
auditerService
@@ -127,17 +118,11 @@ public class AuditingServiceInternal {
}
}
- /**
- * could be null if none has been registered.
- */
- @javax.inject.Inject
- private AuditingService3 auditingServiceIfAny;
-
@javax.inject.Inject
- private List<AuditerService> auditerServices;
+ List<AuditerService> auditerServices;
@javax.inject.Inject
- private ChangedObjectsServiceInternal changedObjectsServiceInternal;
+ ChangedObjectsServiceInternal changedObjectsServiceInternal;
@javax.inject.Inject
UserService userService;
diff --git a/todo-deprecation-list.txt b/todo-deprecation-list.txt
index 7a4e60a..6ceb3ef 100644
--- a/todo-deprecation-list.txt
+++ b/todo-deprecation-list.txt
@@ -7,22 +7,11 @@ TO REMOVE:
-org.apache.isis.applib
-
-
- DomainObjectContainer.java - entire class
-
-
-
-
org.apache.isis.applib.clock
Clock
-org.apache.isis.applib.services.audit (2 usages found)
- AuditingService3.java - remove entire service, use AuditerService instead
-
org.apache.isis.applib.services.bookmark (8 usages found)
BookmarkService.java - deprecated methods, have overloads in BookmarkService2 subtype [suggest we retain these for now]
org.apache.isis.applib.services.classdiscovery
@@ -384,6 +373,10 @@ org.apache.isis.applib.services.actinvoc
ActionInvocationContext.java -remove unused constructors
+org.apache.isis.applib.services.audit (2 usages found)
+ AuditingService3.java - remove entire service, use AuditerService instead
+
+
org.apache.isis.applib.services.background (10 usages found)
ActionInvocationMemento.java - remove entire class, use InteractionDto and CommandDto are used internally instead
BackgroundCommandService.java - remove methods using AIM, instead keep those using CommandDto (in BackgroundCommandService2)
--
To stop receiving notification emails like this one, please contact
"commits@isis.apache.org" <co...@isis.apache.org>.