removed dependency from policies-service to things-model by pulling o…

…ut new modules: * by pulling out new module ditto-internal-utils-pubsub-policies for pub/sub with Policy model scope * by pulling out new module ditto-internal-utils-pubsub-things for pub/sub with Thing model scope * by getting rid of thing model dependency in ditto-policies-enforcement as inline policy in createThing does not need to be resolve placeholders Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
eclipse-ditto · Jun 23, 2022 · 3212964 · 3212964
1 parent 084b5d0
commit 3212964
Show file tree

Hide file tree

Showing 64 changed files with 355 additions and 519 deletions.
diff --git a/bom/pom.xml b/bom/pom.xml
@@ -641,6 +641,16 @@
                 <artifactId>ditto-internal-utils-pubsub</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>org.eclipse.ditto</groupId>
+                <artifactId>ditto-internal-utils-pubsub-policies</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>org.eclipse.ditto</groupId>
+                <artifactId>ditto-internal-utils-pubsub-things</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>org.eclipse.ditto</groupId>
                 <artifactId>ditto-internal-utils-search</artifactId>

diff --git a/connectivity/service/pom.xml b/connectivity/service/pom.xml
@@ -93,6 +93,10 @@
             <groupId>org.eclipse.ditto</groupId>
             <artifactId>ditto-internal-utils-aggregator</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.eclipse.ditto</groupId>
+            <artifactId>ditto-internal-utils-pubsub-things</artifactId>
+        </dependency>
 
         <dependency>
             <groupId>org.webjars.npm</groupId>

diff --git a/...y/service/src/main/java/org/eclipse/ditto/connectivity/service/ConnectivityRootActor.java b/...y/service/src/main/java/org/eclipse/ditto/connectivity/service/ConnectivityRootActor.java
@@ -41,7 +41,7 @@
 import org.eclipse.ditto.internal.utils.persistence.mongo.streaming.MongoReadJournal;
 import org.eclipse.ditto.internal.utils.persistentactors.PersistencePingActor;
 import org.eclipse.ditto.internal.utils.persistentactors.cleanup.PersistenceCleanupActor;
-import org.eclipse.ditto.internal.utils.pubsub.DittoProtocolSub;
+import org.eclipse.ditto.internal.utils.pubsubthings.DittoProtocolSub;
 
 import akka.actor.ActorRef;
 import akka.actor.ActorSystem;

diff --git a/...rvice/src/main/java/org/eclipse/ditto/connectivity/service/messaging/BaseClientActor.java b/...rvice/src/main/java/org/eclipse/ditto/connectivity/service/messaging/BaseClientActor.java
@@ -118,8 +118,8 @@
 import org.eclipse.ditto.internal.utils.metrics.DittoMetrics;
 import org.eclipse.ditto.internal.utils.metrics.instruments.gauge.Gauge;
 import org.eclipse.ditto.internal.utils.protocol.ProtocolAdapterProvider;
-import org.eclipse.ditto.internal.utils.pubsub.DittoProtocolSub;
 import org.eclipse.ditto.internal.utils.pubsub.StreamingType;
+import org.eclipse.ditto.internal.utils.pubsubthings.DittoProtocolSub;
 import org.eclipse.ditto.internal.utils.search.SubscriptionManager;
 import org.eclipse.ditto.protocol.adapter.ProtocolAdapter;
 import org.eclipse.ditto.thingsearch.model.signals.commands.ThingSearchCommand;

diff --git a/...service/src/test/java/org/eclipse/ditto/connectivity/service/messaging/TestConstants.java b/...service/src/test/java/org/eclipse/ditto/connectivity/service/messaging/TestConstants.java
@@ -111,8 +111,8 @@
 import org.eclipse.ditto.internal.utils.config.DefaultScopedConfig;
 import org.eclipse.ditto.internal.utils.persistentactors.config.PingConfig;
 import org.eclipse.ditto.internal.utils.protocol.config.ProtocolConfig;
-import org.eclipse.ditto.internal.utils.pubsub.DittoProtocolSub;
 import org.eclipse.ditto.internal.utils.pubsub.StreamingType;
+import org.eclipse.ditto.internal.utils.pubsubthings.DittoProtocolSub;
 import org.eclipse.ditto.json.JsonFactory;
 import org.eclipse.ditto.messages.model.Message;
 import org.eclipse.ditto.messages.model.MessageDirection;

diff --git a/.../test/java/org/eclipse/ditto/connectivity/service/messaging/amqp/AmqpClientActorTest.java b/.../test/java/org/eclipse/ditto/connectivity/service/messaging/amqp/AmqpClientActorTest.java
@@ -99,7 +99,7 @@
 import org.eclipse.ditto.connectivity.service.messaging.AbstractBaseClientActorTest;
 import org.eclipse.ditto.connectivity.service.messaging.TestConstants;
 import org.eclipse.ditto.connectivity.service.messaging.TestConstants.Authorization;
-import org.eclipse.ditto.internal.utils.pubsub.DittoProtocolSub;
+import org.eclipse.ditto.internal.utils.pubsubthings.DittoProtocolSub;
 import org.eclipse.ditto.internal.utils.test.Retry;
 import org.eclipse.ditto.protocol.TopicPath;
 import org.eclipse.ditto.things.model.Attributes;

diff --git a/gateway/service/pom.xml b/gateway/service/pom.xml
@@ -89,6 +89,10 @@
             <groupId>org.eclipse.ditto</groupId>
             <artifactId>ditto-internal-utils-tracing</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.eclipse.ditto</groupId>
+            <artifactId>ditto-internal-utils-pubsub-things</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.eclipse.ditto</groupId>
             <artifactId>ditto-rql-query</artifactId>

diff --git a/...way/service/src/main/java/org/eclipse/ditto/gateway/service/starter/GatewayRootActor.java b/...way/service/src/main/java/org/eclipse/ditto/gateway/service/starter/GatewayRootActor.java
@@ -71,7 +71,7 @@
 import org.eclipse.ditto.internal.utils.http.DefaultHttpClientFacade;
 import org.eclipse.ditto.internal.utils.http.HttpClientFacade;
 import org.eclipse.ditto.internal.utils.protocol.ProtocolAdapterProvider;
-import org.eclipse.ditto.internal.utils.pubsub.DittoProtocolSub;
+import org.eclipse.ditto.internal.utils.pubsubthings.DittoProtocolSub;
 
 import akka.actor.ActorRef;
 import akka.actor.ActorRefFactory;

diff --git a/...vice/src/main/java/org/eclipse/ditto/gateway/service/streaming/actors/StreamingActor.java b/...vice/src/main/java/org/eclipse/ditto/gateway/service/streaming/actors/StreamingActor.java
@@ -28,7 +28,7 @@
 import org.eclipse.ditto.internal.utils.akka.logging.DittoLoggerFactory;
 import org.eclipse.ditto.internal.utils.metrics.DittoMetrics;
 import org.eclipse.ditto.internal.utils.metrics.instruments.gauge.Gauge;
-import org.eclipse.ditto.internal.utils.pubsub.DittoProtocolSub;
+import org.eclipse.ditto.internal.utils.pubsubthings.DittoProtocolSub;
 import org.eclipse.ditto.internal.utils.search.SubscriptionManager;
 
 import com.typesafe.config.Config;

diff --git a/...c/main/java/org/eclipse/ditto/gateway/service/streaming/actors/StreamingSessionActor.java b/...c/main/java/org/eclipse/ditto/gateway/service/streaming/actors/StreamingSessionActor.java
@@ -60,8 +60,8 @@
 import org.eclipse.ditto.internal.models.acks.config.AcknowledgementConfig;
 import org.eclipse.ditto.internal.utils.akka.logging.DittoLoggerFactory;
 import org.eclipse.ditto.internal.utils.akka.logging.ThreadSafeDittoLoggingAdapter;
-import org.eclipse.ditto.internal.utils.pubsub.DittoProtocolSub;
 import org.eclipse.ditto.internal.utils.pubsub.StreamingType;
+import org.eclipse.ditto.internal.utils.pubsubthings.DittoProtocolSub;
 import org.eclipse.ditto.internal.utils.search.SubscriptionManager;
 import org.eclipse.ditto.jwt.model.ImmutableJsonWebToken;
 import org.eclipse.ditto.messages.model.signals.commands.MessageCommand;

diff --git a/...se/ditto/gateway/service/streaming/actors/StreamingSessionActorHeaderInteractionTest.java b/...se/ditto/gateway/service/streaming/actors/StreamingSessionActorHeaderInteractionTest.java
@@ -42,7 +42,7 @@
 import org.eclipse.ditto.gateway.service.streaming.signals.IncomingSignal;
 import org.eclipse.ditto.internal.models.acks.AcknowledgementAggregatorActorStarter;
 import org.eclipse.ditto.internal.models.acks.config.DefaultAcknowledgementConfig;
-import org.eclipse.ditto.internal.utils.pubsub.DittoProtocolSub;
+import org.eclipse.ditto.internal.utils.pubsubthings.DittoProtocolSub;
 import org.eclipse.ditto.things.model.Thing;
 import org.eclipse.ditto.things.model.ThingId;
 import org.eclipse.ditto.things.model.signals.commands.exceptions.ThingNotAccessibleException;

diff --git a/...st/java/org/eclipse/ditto/gateway/service/streaming/actors/StreamingSessionActorTest.java b/...st/java/org/eclipse/ditto/gateway/service/streaming/actors/StreamingSessionActorTest.java
@@ -51,8 +51,8 @@
 import org.eclipse.ditto.gateway.service.streaming.signals.StreamingAck;
 import org.eclipse.ditto.internal.models.acks.config.DefaultAcknowledgementConfig;
 import org.eclipse.ditto.internal.utils.akka.ActorSystemResource;
-import org.eclipse.ditto.internal.utils.pubsub.DittoProtocolSub;
 import org.eclipse.ditto.internal.utils.pubsub.StreamingType;
+import org.eclipse.ditto.internal.utils.pubsubthings.DittoProtocolSub;
 import org.eclipse.ditto.json.JsonObject;
 import org.eclipse.ditto.jwt.model.JsonWebToken;
 import org.eclipse.ditto.jwt.model.JwtInvalidException;

diff --git a/internal/utils/persistent-actors/pom.xml b/internal/utils/persistent-actors/pom.xml
@@ -70,6 +70,11 @@
         </dependency>
 
         <!-- tests -->
+        <dependency>
+            <groupId>org.eclipse.ditto</groupId>
+            <artifactId>ditto-things-model</artifactId>
+            <scope>test</scope> <!-- only needed for unit test -->
+        </dependency>
         <dependency>
             <groupId>com.typesafe.akka</groupId>
             <artifactId>akka-stream-testkit_${scala.version}</artifactId>
@@ -87,4 +92,36 @@
         </dependency>
     </dependencies>
 
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-enforcer-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>enforce-banned-dependencies</id>
+                        <goals>
+                            <goal>enforce</goal>
+                        </goals>
+                        <configuration>
+                            <rules>
+                                <bannedDependencies>
+                                    <excludes>
+                                        <!-- we don't want to have things-model dependency here -->
+                                        <exclude>org.eclipse.ditto:ditto-things-model</exclude>
+                                    </excludes>
+                                    <includes>
+                                        <include>org.eclipse.ditto:ditto-things-model:*:jar:test</include>
+                                    </includes>
+                                    <message>Persistence actors in general must not depend on Ditto Things model</message>
+                                </bannedDependencies>
+                            </rules>
+                            <fail>true</fail>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
 </project>
diff --git a/...itto/internal/utils/persistentactors/AbstractPersistentActorWithTimersAndCleanupTest.java b/...itto/internal/utils/persistentactors/AbstractPersistentActorWithTimersAndCleanupTest.java
@@ -25,7 +25,6 @@
 import org.eclipse.ditto.base.model.entity.id.EntityId;
 import org.eclipse.ditto.base.model.entity.type.EntityType;
 import org.eclipse.ditto.base.model.headers.DittoHeaders;
-import org.eclipse.ditto.things.model.ThingConstants;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Rule;
@@ -256,7 +255,7 @@ private static void resetMocks() {
     }
 
     private String persistenceId() {
-        return ThingConstants.ENTITY_TYPE + ":" + NAMESPACE + ":" + name.getMethodName();
+        return EntityType.of("thing") + ":" + NAMESPACE + ":" + name.getMethodName();
     }
 
     private static EntityId extractEntityIdFromPersistenceId(final String persistenceId) {

diff --git a/internal/utils/pom.xml b/internal/utils/pom.xml
@@ -28,7 +28,6 @@
     <modules>
         <module>aggregator</module>
         <module>akka</module>
-        <module>pubsub</module>
         <module>cache</module>
         <module>cache-loaders</module>
         <module>cluster</module>
@@ -40,6 +39,9 @@
         <module>jwt</module>
         <module>namespaces</module>
         <module>persistence</module>
+        <module>pubsub</module>
+        <module>pubsub-policies</module>
+        <module>pubsub-things</module>
         <module>protocol</module>
         <module>search</module>
         <module>test</module>

diff --git a/internal/utils/pubsub-policies/pom.xml b/internal/utils/pubsub-policies/pom.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright (c) 2022 Contributors to the Eclipse Foundation
+  ~
+  ~ See the NOTICE file(s) distributed with this work for additional
+  ~ information regarding copyright ownership.
+  ~
+  ~ This program and the accompanying materials are made available under the
+  ~ terms of the Eclipse Public License 2.0 which is available at
+  ~ http://www.eclipse.org/legal/epl-2.0
+  ~
+  ~ SPDX-License-Identifier: EPL-2.0
+  -->
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.eclipse.ditto</groupId>
+        <artifactId>ditto-internal-utils</artifactId>
+        <version>${revision}</version>
+    </parent>
+
+    <artifactId>ditto-internal-utils-pubsub-policies</artifactId>
+    <name>Eclipse Ditto :: Internal :: Utils :: Pub-Sub Policies</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.eclipse.ditto</groupId>
+            <artifactId>ditto-policies-model</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.eclipse.ditto</groupId>
+            <artifactId>ditto-internal-utils-pubsub</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/...bsub/PolicyAnnouncementPubSubFactory.java → ...cies/PolicyAnnouncementPubSubFactory.java b/...bsub/PolicyAnnouncementPubSubFactory.java → ...cies/PolicyAnnouncementPubSubFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021 Contributors to the Eclipse Foundation
+ * Copyright (c) 2022 Contributors to the Eclipse Foundation
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -10,8 +10,10 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.eclipse.ditto.internal.utils.pubsub;
+package org.eclipse.ditto.internal.utils.pubsubpolicies;
 
+import org.eclipse.ditto.internal.utils.pubsub.AbstractPubSubFactory;
+import org.eclipse.ditto.internal.utils.pubsub.DistributedAcks;
 import org.eclipse.ditto.internal.utils.pubsub.extractors.AckExtractor;
 import org.eclipse.ditto.policies.model.signals.announcements.PolicyAnnouncement;
 

diff --git a/...sub/PolicyAnnouncementTopicExtractor.java → ...ies/PolicyAnnouncementTopicExtractor.java b/...sub/PolicyAnnouncementTopicExtractor.java → ...ies/PolicyAnnouncementTopicExtractor.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021 Contributors to the Eclipse Foundation
+ * Copyright (c) 2022 Contributors to the Eclipse Foundation
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.eclipse.ditto.internal.utils.pubsub;
+package org.eclipse.ditto.internal.utils.pubsubpolicies;
 
 import java.util.Collection;
 import java.util.List;

diff --git a/...-policies/src/main/java/org/eclipse/ditto/internal/utils/pubsubpolicies/package-info.java b/...-policies/src/main/java/org/eclipse/ditto/internal/utils/pubsubpolicies/package-info.java
@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2022 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+
+@org.eclipse.ditto.utils.jsr305.annotations.AllValuesAreNonnullByDefault
+package org.eclipse.ditto.internal.utils.pubsubpolicies;
diff --git a/internal/utils/pubsub-things/pom.xml b/internal/utils/pubsub-things/pom.xml
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright (c) 2022 Contributors to the Eclipse Foundation
+  ~
+  ~ See the NOTICE file(s) distributed with this work for additional
+  ~ information regarding copyright ownership.
+  ~
+  ~ This program and the accompanying materials are made available under the
+  ~ terms of the Eclipse Public License 2.0 which is available at
+  ~ http://www.eclipse.org/legal/epl-2.0
+  ~
+  ~ SPDX-License-Identifier: EPL-2.0
+  -->
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.eclipse.ditto</groupId>
+        <artifactId>ditto-internal-utils</artifactId>
+        <version>${revision}</version>
+    </parent>
+
+    <artifactId>ditto-internal-utils-pubsub-things</artifactId>
+    <name>Eclipse Ditto :: Internal :: Utils :: Pub-Sub Things</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.eclipse.ditto</groupId>
+            <artifactId>ditto-things-model</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>org.eclipse.ditto</groupId>
+            <artifactId>ditto-internal-utils-pubsub</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.ditto</groupId>
+            <artifactId>ditto-internal-utils-pubsub-policies</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/...ternal/utils/pubsub/DittoProtocolSub.java → .../utils/pubsubthings/DittoProtocolSub.java b/...ternal/utils/pubsub/DittoProtocolSub.java → .../utils/pubsubthings/DittoProtocolSub.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019 Contributors to the Eclipse Foundation
+ * Copyright (c) 2022 Contributors to the Eclipse Foundation
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -10,14 +10,15 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.eclipse.ditto.internal.utils.pubsub;
+package org.eclipse.ditto.internal.utils.pubsubthings;
 
 import java.util.Collection;
 import java.util.concurrent.CompletionStage;
 
 import javax.annotation.Nullable;
 
 import org.eclipse.ditto.base.model.acks.AcknowledgementLabel;
+import org.eclipse.ditto.internal.utils.pubsub.StreamingType;
 
 import akka.actor.ActorRef;
 import akka.actor.ActorSystem;

diff --git a/...al/utils/pubsub/DittoProtocolSubImpl.java → ...ls/pubsubthings/DittoProtocolSubImpl.java b/...al/utils/pubsub/DittoProtocolSubImpl.java → ...ls/pubsubthings/DittoProtocolSubImpl.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019 Contributors to the Eclipse Foundation
+ * Copyright (c) 2022 Contributors to the Eclipse Foundation
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.eclipse.ditto.internal.utils.pubsub;
+package org.eclipse.ditto.internal.utils.pubsubthings;
 
 import java.util.Collection;
 import java.util.Collections;
@@ -25,6 +25,10 @@
 import javax.annotation.Nullable;
 
 import org.eclipse.ditto.base.model.acks.AcknowledgementLabel;
+import org.eclipse.ditto.internal.utils.pubsub.DistributedAcks;
+import org.eclipse.ditto.internal.utils.pubsub.DistributedSub;
+import org.eclipse.ditto.internal.utils.pubsub.StreamingType;
+import org.eclipse.ditto.internal.utils.pubsubpolicies.PolicyAnnouncementPubSubFactory;
 
 import akka.actor.AbstractExtensionId;
 import akka.actor.ActorRef;