Migration API for record-based entities

client/src/main/java/io/spine/client/CompositeQueryFilter.java

@@ -20,6 +20,7 @@
 
 package io.spine.client;
 
+import com.google.common.annotations.VisibleForTesting;
 import io.spine.base.EntityState;
 import io.spine.client.CompositeFilter.CompositeOperator;
 
@@ -65,4 +66,10 @@ public static CompositeQueryFilter either(QueryFilter first, QueryFilter... rest
         checkNotNull(rest);
         return new CompositeQueryFilter(asList(first, rest), EITHER);
     }
+
+    @VisibleForTesting
+    @Override
+    public CompositeFilter value() {
+        return super.value();
+    }
 }

license-report.md

@@ -1,6 +1,6 @@
 
 
-# Dependencies of `io.spine:spine-client:1.4.10`
+# Dependencies of `io.spine:spine-client:1.4.11`
 
 ## Runtime
 1. **Group:** com.google.android **Name:** annotations **Version:** 4.1.1.4
@@ -415,12 +415,12 @@
  The dependencies distributed under several licenses, are used according their commercial-use-friendly license.
 
 
-This report was generated on **Tue Mar 03 16:17:23 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
+This report was generated on **Wed Mar 04 15:47:54 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
 
 
 
 
-# Dependencies of `io.spine:spine-core:1.4.10`
+# Dependencies of `io.spine:spine-core:1.4.11`
 
 ## Runtime
 1. **Group:** com.google.code.findbugs **Name:** jsr305 **Version:** 3.0.2
@@ -791,12 +791,12 @@ This report was generated on **Tue Mar 03 16:17:23 EET 2020** using [Gradle-Lice
  The dependencies distributed under several licenses, are used according their commercial-use-friendly license.
 
 
-This report was generated on **Tue Mar 03 16:17:24 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
+This report was generated on **Wed Mar 04 15:47:55 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
 
 
 
 
-# Dependencies of `io.spine.tools:spine-model-assembler:1.4.10`
+# Dependencies of `io.spine.tools:spine-model-assembler:1.4.11`
 
 ## Runtime
 1. **Group:** com.google.android **Name:** annotations **Version:** 4.1.1.4
@@ -1206,12 +1206,12 @@ This report was generated on **Tue Mar 03 16:17:24 EET 2020** using [Gradle-Lice
  The dependencies distributed under several licenses, are used according their commercial-use-friendly license.
 
 
-This report was generated on **Tue Mar 03 16:17:24 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
+This report was generated on **Wed Mar 04 15:47:56 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
 
 
 
 
-# Dependencies of `io.spine.tools:spine-model-verifier:1.4.10`
+# Dependencies of `io.spine.tools:spine-model-verifier:1.4.11`
 
 ## Runtime
 1. **Group:** com.google.android **Name:** annotations **Version:** 4.1.1.4
@@ -1681,12 +1681,12 @@ This report was generated on **Tue Mar 03 16:17:24 EET 2020** using [Gradle-Lice
  The dependencies distributed under several licenses, are used according their commercial-use-friendly license.
 
 
-This report was generated on **Tue Mar 03 16:17:25 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
+This report was generated on **Wed Mar 04 15:47:57 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
 
 
 
 
-# Dependencies of `io.spine:spine-server:1.4.10`
+# Dependencies of `io.spine:spine-server:1.4.11`
 
 ## Runtime
 1. **Group:** com.google.android **Name:** annotations **Version:** 4.1.1.4
@@ -2113,12 +2113,12 @@ This report was generated on **Tue Mar 03 16:17:25 EET 2020** using [Gradle-Lice
  The dependencies distributed under several licenses, are used according their commercial-use-friendly license.
 
 
-This report was generated on **Tue Mar 03 16:17:25 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
+This report was generated on **Wed Mar 04 15:47:58 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
 
 
 
 
-# Dependencies of `io.spine:spine-testutil-client:1.4.10`
+# Dependencies of `io.spine:spine-testutil-client:1.4.11`
 
 ## Runtime
 1. **Group:** com.google.android **Name:** annotations **Version:** 4.1.1.4
@@ -2586,12 +2586,12 @@ This report was generated on **Tue Mar 03 16:17:25 EET 2020** using [Gradle-Lice
  The dependencies distributed under several licenses, are used according their commercial-use-friendly license.
 
 
-This report was generated on **Tue Mar 03 16:17:28 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
+This report was generated on **Wed Mar 04 15:48:00 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
 
 
 
 
-# Dependencies of `io.spine:spine-testutil-core:1.4.10`
+# Dependencies of `io.spine:spine-testutil-core:1.4.11`
 
 ## Runtime
 1. **Group:** com.google.android **Name:** annotations **Version:** 4.1.1.4
@@ -3067,12 +3067,12 @@ This report was generated on **Tue Mar 03 16:17:28 EET 2020** using [Gradle-Lice
  The dependencies distributed under several licenses, are used according their commercial-use-friendly license.
 
 
-This report was generated on **Tue Mar 03 16:17:29 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
+This report was generated on **Wed Mar 04 15:48:02 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
 
 
 
 
-# Dependencies of `io.spine:spine-testutil-server:1.4.10`
+# Dependencies of `io.spine:spine-testutil-server:1.4.11`
 
 ## Runtime
 1. **Group:** com.google.android **Name:** annotations **Version:** 4.1.1.4
@@ -3584,4 +3584,4 @@ This report was generated on **Tue Mar 03 16:17:29 EET 2020** using [Gradle-Lice
  The dependencies distributed under several licenses, are used according their commercial-use-friendly license.
 
 
-This report was generated on **Tue Mar 03 16:17:32 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
+This report was generated on **Wed Mar 04 15:48:05 EET 2020** using [Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under [Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).

pom.xml

@@ -12,7 +12,7 @@ all modules and does not describe the project structure per-subproject.
 
 <groupId>io.spine</groupId>
 <artifactId>spine-core-java</artifactId>
-<version>1.4.10</version>
+<version>1.4.11</version>
 
 <inceptionYear>2015</inceptionYear>
 

server/src/main/java/io/spine/server/entity/EntityLifecycle.java

@@ -22,6 +22,7 @@
 
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.ImmutableList;
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.protobuf.Any;
 import io.spine.annotation.Internal;
 import io.spine.base.Error;
@@ -65,6 +66,7 @@
 import io.spine.system.server.event.EventDispatchedToReactor;
 import io.spine.system.server.event.EventDispatchedToSubscriber;
 import io.spine.system.server.event.EventImported;
+import io.spine.system.server.event.MigrationApplied;
 import io.spine.system.server.event.TargetAssignedToCommand;
 import io.spine.type.TypeUrl;
 import io.spine.validate.ValidationError;
@@ -316,6 +318,38 @@ public final void onStateChanged(EntityRecordChange change,
         postIfRestored(change, messageIds);
     }
 
+    /**
+     * Posts the {@link EntityDeleted} event signaling that the entity record was removed from the
+     * storage.
+     *
+     * @param signalIds
+     *         the IDs of handled messages that caused the deletion
+     */
+    public final void onRemovedFromStorage(Iterable<MessageId> signalIds) {
+        EntityDeleted event = EntityDeleted
+                .newBuilder()
+                .setEntity(entityId)
+                .addAllSignalId(ImmutableList.copyOf(signalIds))
+                .setRemovedFromStorage(true)
+                .vBuild();
+        postEvent(event);
+    }
+
+    /**
+     * Posts the {@link MigrationApplied} event.
+     *
+     * @return the event or an empty {@code Optional} if the posting was blocked by the
+     *         {@link #eventFilter}
+     */
+    public final Optional<Event> onMigrationApplied() {
+        MigrationApplied systemEvent = MigrationApplied
+                .newBuilder()
+                .setEntity(entityId)
+                .setWhen(currentTime())
+                .build();
+        return postEvent(systemEvent);
+    }
+
     /**
      * Posts the {@link ConstraintViolated} system event.
      *
@@ -480,6 +514,7 @@ private void postIfDeleted(EntityRecordChange change,
                     .setEntity(entityId)
                     .addAllSignalId(ImmutableList.copyOf(messageIds))
                     .setVersion(version)
+                    .setMarkedAsDeleted(true)
                     .vBuild();
             postEvent(event);
         }
@@ -568,14 +603,37 @@ private void postHandlerFailed(MessageId handledSignal, Error error) {
         postEvent(systemEvent);
     }
 
-    protected void postEvent(EventMessage event, Origin explicitOrigin) {
+    /**
+     * Posts a system event with the specified origin.
+     *
+     * @param event
+     *         an event to post
+     * @param explicitOrigin
+     *         the event origin
+     * @return an instance of posted {@code Event} if it was actually posted and an empty
+     *         {@code Optional} if the event was intercepted by the {@link #eventFilter}
+     */
+    @CanIgnoreReturnValue
+    protected Optional<Event> postEvent(EventMessage event, Origin explicitOrigin) {
         Optional<? extends EventMessage> filtered = eventFilter.filter(event);
-        filtered.ifPresent(systemEvent -> systemWriteSide.postEvent(systemEvent, explicitOrigin));
+        Optional<Event> result =
+                filtered.map(systemEvent -> systemWriteSide.postEvent(systemEvent, explicitOrigin));
+        return result;
     }
 
-    protected void postEvent(EventMessage event) {
+    /**
+     * Posts an event to a system write side.
+     *
+     * @param event
+     *         an event to post
+     * @return an instance of posted {@code Event} if it was actually posted and an empty
+     *         {@code Optional} if the event was intercepted by the {@link #eventFilter}
+     */
+    @CanIgnoreReturnValue
+    protected Optional<Event> postEvent(EventMessage event) {
         Optional<? extends EventMessage> filtered = eventFilter.filter(event);
-        filtered.ifPresent(systemWriteSide::postEvent);
+        Optional<Event> result = filtered.map(systemWriteSide::postEvent);
+        return result;
     }
 
     /**

server/src/main/java/io/spine/server/entity/EntityLifecycleMonitor.java

@@ -73,13 +73,33 @@ private EntityLifecycleMonitor(Repository<I, ?> repository, I id) {
      *
      * @param repository
      *         the repository of the entity under transaction
+     * @param id
+     *         the entity ID
      */
-    public static <I> TransactionListener<I> newInstance(Repository<I, ?> repository, I id) {
+    public static <I> EntityLifecycleMonitor<I> newInstance(Repository<I, ?> repository, I id) {
         checkNotNull(repository);
         checkNotNull(id);
         return new EntityLifecycleMonitor<>(repository, id);
     }
 
+    /**
+     * Creates a new instance with a single {@linkplain #acknowledgedMessages acknowledged} message.
+     *
+     * @param repository
+     *         the repository of the entity under transaction
+     * @param id
+     *         the entity ID
+     * @param message
+     *         the artificially injected acknowledged message
+     */
+    static <I> EntityLifecycleMonitor<I>
+    withAcknowledgedMessage(Repository<I, ?> repository, I id, Signal<?, ?, ?> message) {
+        EntityLifecycleMonitor<I> monitor = newInstance(repository, id);
+        monitor.lastMessage = message;
+        monitor.acknowledgedMessages.add(message.messageId());
+        return monitor;
+    }
+
     /**
      * {@inheritDoc}
      *