naming improvements

Author: csviri

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/AbstractPollingDependentResource.java

@@ -1,10 +1,10 @@
 package io.javaoperatorsdk.operator.processing.dependent.external;
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
-import io.javaoperatorsdk.operator.processing.event.source.IDMapper;
+import io.javaoperatorsdk.operator.processing.event.source.CacheKeyMapper;
 
 public abstract class AbstractPollingDependentResource<R, P extends HasMetadata>
-    extends AbstractCachingDependentResource<R, P> implements IDMapper<R> {
+    extends AbstractCachingDependentResource<R, P> implements CacheKeyMapper<R> {
 
   public static final int DEFAULT_POLLING_PERIOD = 5000;
   private long pollingPeriod;
@@ -28,7 +28,7 @@ public long getPollingPeriod() {
 
   // for now dependent resources support event sources only with one owned resource.
   @Override
-  public String getID(R r) {
-    return IDMapper.singleResourceIDMapper().getID(r);
+  public String keyFor(R r) {
+    return CacheKeyMapper.singleResourceIDMapper().keyFor(r);
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/external/PollingDependentResource.java

@@ -2,23 +2,23 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.api.reconciler.EventSourceContext;
+import io.javaoperatorsdk.operator.processing.event.source.CacheKeyMapper;
 import io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource;
-import io.javaoperatorsdk.operator.processing.event.source.IDMapper;
 import io.javaoperatorsdk.operator.processing.event.source.polling.PollingEventSource;
 
 public abstract class PollingDependentResource<R, P extends HasMetadata>
     extends AbstractPollingDependentResource<R, P>
     implements PollingEventSource.GenericResourceFetcher<R> {
 
-  private final IDMapper<R> idProvider;
+  private final CacheKeyMapper<R> idProvider;
 
-  public PollingDependentResource(Class<R> resourceType, IDMapper<R> idProvider) {
+  public PollingDependentResource(Class<R> resourceType, CacheKeyMapper<R> idProvider) {
     super(resourceType);
     this.idProvider = idProvider;
   }
 
   public PollingDependentResource(Class<R> resourceType, long pollingPeriod,
-      IDMapper<R> idProvider) {
+      CacheKeyMapper<R> idProvider) {
     super(resourceType, pollingPeriod);
     this.idProvider = idProvider;
   }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/IDMapper.java renamed to operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/CacheKeyMapper.java

@@ -1,8 +1,8 @@
 package io.javaoperatorsdk.operator.processing.event.source;
 
-public interface IDMapper<R> {
+public interface CacheKeyMapper<R> {
 
-  String getID(R var1);
+  String keyFor(R var1);
 
   /**
    * Used if a polling event source handles only single secondary resource. See also docs for:
@@ -11,7 +11,7 @@ public interface IDMapper<R> {
    * @return static id mapper, all resources are mapped for same id.
    * @param <T> secondary resource type
    */
-  static <T> IDMapper<T> singleResourceIDMapper() {
+  static <T> CacheKeyMapper<T> singleResourceIDMapper() {
     return r -> "id";
   }
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/ExternalResourceCachingEventSource.java

@@ -35,13 +35,14 @@ public abstract class ExternalResourceCachingEventSource<R, P extends HasMetadat
 
   private static Logger log = LoggerFactory.getLogger(ExternalResourceCachingEventSource.class);
 
-  protected final IDMapper<R> idMapper;
+  protected final CacheKeyMapper<R> cacheKeyMapper;
 
   protected Map<ResourceID, Map<String, R>> cache = new ConcurrentHashMap<>();
 
-  protected ExternalResourceCachingEventSource(Class<R> resourceClass, IDMapper<R> idMapper) {
+  protected ExternalResourceCachingEventSource(Class<R> resourceClass,
+      CacheKeyMapper<R> cacheKeyMapper) {
     super(resourceClass);
-    this.idMapper = idMapper;
+    this.cacheKeyMapper = cacheKeyMapper;
   }
 
   protected synchronized void handleDelete(ResourceID primaryID) {
@@ -52,11 +53,12 @@ protected synchronized void handleDelete(ResourceID primaryID) {
   }
 
   protected synchronized void handleDeletes(ResourceID primaryID, Set<R> resource) {
-    handleDelete(primaryID, resource.stream().map(idMapper::getID).collect(Collectors.toSet()));
+    handleDelete(primaryID,
+        resource.stream().map(cacheKeyMapper::keyFor).collect(Collectors.toSet()));
   }
 
   protected synchronized void handleDelete(ResourceID primaryID, R resource) {
-    handleDelete(primaryID, Set.of(idMapper.getID(resource)));
+    handleDelete(primaryID, Set.of(cacheKeyMapper.keyFor(resource)));
   }
 
   protected synchronized void handleDelete(ResourceID primaryID, Set<String> resourceID) {
@@ -98,7 +100,8 @@ protected synchronized void handleResources(ResourceID primaryID, Set<R> newReso
       return;
     }
     var cachedResources = cache.get(primaryID);
-    var newResourcesMap = newResources.stream().collect(Collectors.toMap(idMapper::getID, r -> r));
+    var newResourcesMap =
+        newResources.stream().collect(Collectors.toMap(cacheKeyMapper::keyFor, r -> r));
     cache.put(primaryID, newResourcesMap);
     if (propagateEvent && !newResourcesMap.equals(cachedResources)) {
       getEventHandler().handleEvent(new Event(primaryID));
@@ -108,7 +111,7 @@ protected synchronized void handleResources(ResourceID primaryID, Set<R> newReso
   @Override
   public synchronized void handleRecentResourceCreate(ResourceID primaryID, R resource) {
     var actualValues = cache.get(primaryID);
-    var resourceId = idMapper.getID(resource);
+    var resourceId = cacheKeyMapper.keyFor(resource);
     if (actualValues == null) {
       actualValues = new HashMap<>();
       cache.put(primaryID, actualValues);
@@ -123,7 +126,7 @@ public synchronized void handleRecentResourceUpdate(
       ResourceID primaryID, R resource, R previousVersionOfResource) {
     var actualValues = cache.get(primaryID);
     if (actualValues != null) {
-      var resourceId = idMapper.getID(resource);
+      var resourceId = cacheKeyMapper.keyFor(resource);
       R actualResource = actualValues.get(resourceId);
       if (actualResource.equals(previousVersionOfResource)) {
         actualValues.put(resourceId, resource);

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/inbound/CachingInboundEventSource.java

@@ -4,13 +4,13 @@
 
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
+import io.javaoperatorsdk.operator.processing.event.source.CacheKeyMapper;
 import io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource;
-import io.javaoperatorsdk.operator.processing.event.source.IDMapper;
 
 public class CachingInboundEventSource<R, P extends HasMetadata>
     extends ExternalResourceCachingEventSource<R, P> {
 
-  public CachingInboundEventSource(Class<R> resourceClass, IDMapper<R> idProvider) {
+  public CachingInboundEventSource(Class<R> resourceClass, CacheKeyMapper<R> idProvider) {
     super(resourceClass, idProvider);
   }
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/polling/PerResourcePollingEventSource.java

@@ -11,9 +11,9 @@
 import io.javaoperatorsdk.operator.OperatorException;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 import io.javaoperatorsdk.operator.processing.event.source.Cache;
+import io.javaoperatorsdk.operator.processing.event.source.CacheKeyMapper;
 import io.javaoperatorsdk.operator.processing.event.source.CachingEventSource;
 import io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource;
-import io.javaoperatorsdk.operator.processing.event.source.IDMapper;
 import io.javaoperatorsdk.operator.processing.event.source.ResourceEventAware;
 
 /**
@@ -44,18 +44,18 @@ public class PerResourcePollingEventSource<R, P extends HasMetadata>
   public PerResourcePollingEventSource(ResourceFetcher<R, P> resourceFetcher,
       Cache<P> resourceCache, long period, Class<R> resourceClass) {
     this(resourceFetcher, resourceCache, period, null, resourceClass,
-        IDMapper.singleResourceIDMapper());
+        CacheKeyMapper.singleResourceIDMapper());
   }
 
   public PerResourcePollingEventSource(ResourceFetcher<R, P> resourceFetcher,
-      Cache<P> resourceCache, long period, Class<R> resourceClass, IDMapper<R> idProvider) {
+      Cache<P> resourceCache, long period, Class<R> resourceClass, CacheKeyMapper<R> idProvider) {
     this(resourceFetcher, resourceCache, period, null, resourceClass, idProvider);
   }
 
   public PerResourcePollingEventSource(ResourceFetcher<R, P> resourceFetcher,
       Cache<P> resourceCache, long period,
       Predicate<P> registerPredicate, Class<R> resourceClass,
-      IDMapper<R> idProvider) {
+      CacheKeyMapper<R> idProvider) {
     super(resourceClass, idProvider);
     this.resourceFetcher = resourceFetcher;
     this.resourceCache = resourceCache;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/polling/PollingEventSource.java

@@ -11,8 +11,8 @@
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.javaoperatorsdk.operator.OperatorException;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
+import io.javaoperatorsdk.operator.processing.event.source.CacheKeyMapper;
 import io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource;
-import io.javaoperatorsdk.operator.processing.event.source.IDMapper;
 
 /**
  * Polls resource (on contrary to {@link PerResourcePollingEventSource}) not per resource bases but
@@ -53,7 +53,7 @@ public PollingEventSource(
       GenericResourceFetcher<R> supplier,
       long period,
       Class<R> resourceClass) {
-    super(resourceClass, IDMapper.singleResourceIDMapper());
+    super(resourceClass, CacheKeyMapper.singleResourceIDMapper());
     this.genericResourceFetcher = supplier;
     this.period = period;
   }
@@ -62,8 +62,8 @@ public PollingEventSource(
       GenericResourceFetcher<R> supplier,
       long period,
       Class<R> resourceClass,
-      IDMapper<R> idMapper) {
-    super(resourceClass, idMapper);
+      CacheKeyMapper<R> cacheKeyMapper) {
+    super(resourceClass, cacheKeyMapper);
     this.genericResourceFetcher = supplier;
     this.period = period;
   }

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/source/polling/PerResourcePollingEventSourceTest.java

@@ -11,7 +11,7 @@
 import io.javaoperatorsdk.operator.processing.event.EventHandler;
 import io.javaoperatorsdk.operator.processing.event.source.AbstractEventSourceTestBase;
 import io.javaoperatorsdk.operator.processing.event.source.Cache;
-import io.javaoperatorsdk.operator.processing.event.source.IDMapper;
+import io.javaoperatorsdk.operator.processing.event.source.CacheKeyMapper;
 import io.javaoperatorsdk.operator.processing.event.source.SampleExternalResource;
 import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;
 
@@ -57,7 +57,7 @@ void pollsTheResourceAfterAwareOfIt() throws InterruptedException {
   void registeringTaskOnAPredicate() throws InterruptedException {
     setUpSource(new PerResourcePollingEventSource<>(supplier, resourceCache, PERIOD,
         testCustomResource -> testCustomResource.getMetadata().getGeneration() > 1,
-        SampleExternalResource.class, IDMapper.singleResourceIDMapper()));
+        SampleExternalResource.class, CacheKeyMapper.singleResourceIDMapper()));
     source.onResourceCreated(testCustomResource);
     Thread.sleep(2 * PERIOD);