PR remarks

DEPENDENCIES

@@ -75,7 +75,7 @@ maven/mavencentral/com.jcraft/jzlib/1.1.3, BSD-2-Clause, approved, CQ6218
 maven/mavencentral/com.lmax/disruptor/3.4.4, Apache-2.0, approved, clearlydefined
 maven/mavencentral/com.networknt/json-schema-validator/1.0.76, Apache-2.0, approved, CQ22638
 maven/mavencentral/com.nimbusds/nimbus-jose-jwt/9.28, Apache-2.0, approved, clearlydefined
-maven/mavencentral/com.nimbusds/nimbus-jose-jwt/9.32, , restricted, clearlydefined
+maven/mavencentral/com.nimbusds/nimbus-jose-jwt/9.32, Apache-2.0, approved, #10561
 maven/mavencentral/com.puppycrawl.tools/checkstyle/10.0, LGPL-2.1-or-later, approved, #7936
 maven/mavencentral/com.samskivert/jmustache/1.15, BSD-2-Clause, approved, clearlydefined
 maven/mavencentral/com.squareup.okhttp3/okhttp-dnsoverhttps/4.11.0, Apache-2.0, approved, clearlydefined

core/common/connector-core/src/main/java/org/eclipse/edc/connector/core/entity/AbstractStateEntityManager.java

@@ -30,6 +30,12 @@
 import java.time.Clock;
 import java.util.Objects;
 
+/**
+ * Abstraction that provides a common ground for state machine manager implementation.
+ *
+ * @param <E> the entity type.
+ * @param <S> the store type.
+ */
 public abstract class AbstractStateEntityManager<E extends StatefulEntity<E>, S extends StateEntityStore<E>> implements StateEntityManager {
 
     public static final long DEFAULT_ITERATION_WAIT = 1000;
@@ -66,7 +72,7 @@ public void stop() {
     }
 
     /**
-     * configure the State Machine Manager builder
+     * configures the State Machine Manager builder
      *
      * @param builder the builder.
      * @return the builder.

core/policy-monitor/policy-monitor-core/src/main/java/org/eclipse/edc/connector/policy/monitor/manager/PolicyMonitorManagerImpl.java

@@ -35,6 +35,9 @@
 import static org.eclipse.edc.connector.policy.monitor.spi.PolicyMonitorEntryStates.STARTED;
 import static org.eclipse.edc.spi.persistence.StateEntityStore.hasState;
 
+/**
+ * Implementation of the {@link PolicyMonitorManager}
+ */
 public class PolicyMonitorManagerImpl extends AbstractStateEntityManager<PolicyMonitorEntry, PolicyMonitorStore>
         implements PolicyMonitorManager {
 

core/policy-monitor/policy-monitor-core/src/main/java/org/eclipse/edc/connector/policy/monitor/store/InMemoryPolicyMonitorStore.java

@@ -27,6 +27,9 @@
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * In-memory implementation of the {@link PolicyMonitorStore}
+ */
 public class InMemoryPolicyMonitorStore implements PolicyMonitorStore {
 
     private final InMemoryStatefulEntityStore<PolicyMonitorEntry> store;

core/policy-monitor/policy-monitor-core/src/main/java/org/eclipse/edc/connector/policy/monitor/subscriber/StartMonitoring.java

@@ -22,6 +22,9 @@
 
 import static org.eclipse.edc.connector.transfer.spi.types.TransferProcess.Type.PROVIDER;
 
+/**
+ * Event subscriber that will start monitoring a transfer process whenever it gets started and it's a PROVIDER one.
+ */
 public class StartMonitoring implements EventSubscriber {
 
     private final PolicyMonitorManager manager;

spi/common/core-spi/src/main/java/org/eclipse/edc/spi/entity/StateEntityManager.java

@@ -15,7 +15,7 @@
 package org.eclipse.edc.spi.entity;
 
 /**
- * Is a long-running process that takes care of managing entity and their status.
+ * A long-running process that manages entities and their states
  */
 public interface StateEntityManager {
 

spi/policy-monitor/policy-monitor-spi/src/main/java/org/eclipse/edc/connector/policy/monitor/spi/PolicyMonitorEntry.java

@@ -20,6 +20,9 @@
 import static org.eclipse.edc.connector.policy.monitor.spi.PolicyMonitorEntryStates.FAILED;
 import static org.eclipse.edc.connector.policy.monitor.spi.PolicyMonitorEntryStates.STARTED;
 
+/**
+ * Entity that represent a transfer process into the Policy Monitor context.
+ */
 public class PolicyMonitorEntry extends StatefulEntity<PolicyMonitorEntry> {
 
     private String contractId;

spi/policy-monitor/policy-monitor-spi/src/main/java/org/eclipse/edc/connector/policy/monitor/spi/PolicyMonitorEntryStates.java

@@ -16,6 +16,9 @@
 
 import java.util.Arrays;
 
+/**
+ * States for the {@link PolicyMonitorEntry} entity.
+ */
 public enum PolicyMonitorEntryStates {
     STARTED(100),
     COMPLETED(200),

spi/policy-monitor/policy-monitor-spi/src/main/java/org/eclipse/edc/connector/policy/monitor/spi/PolicyMonitorManager.java

@@ -17,8 +17,7 @@
 import org.eclipse.edc.spi.entity.StateEntityManager;
 
 /**
- * Takes care to iterate over the ongoing transfers verifying their policy, completing them whenever the policy
- * cannot be evaluated anymore.
+ * Iterates over ongoing transfers, verifying their policies and completing when the policy can no longer be evaluated.
  */
 public interface PolicyMonitorManager extends StateEntityManager {