wip

Author: csviri

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/ResourceIDMapper.java

@@ -19,7 +19,13 @@
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 import io.javaoperatorsdk.operator.processing.event.source.ExternalResourceCachingEventSource;
 
-/** Provides id for the target resource. */
+/**
+ * Provides id for the target resource. This mapper is used across multiple component of the
+ * framework, like the {@link
+ * io.javaoperatorsdk.operator.processing.dependent.AbstractExternalDependentResource}, in {@link
+ * ExternalResourceCachingEventSource}, and {@link
+ * io.javaoperatorsdk.operator.processing.dependent.KubernetesBulkDependentResource}.
+ */
 public interface ResourceIDMapper<R, ID> {
 
   ID idFor(R resource);
@@ -29,7 +35,7 @@ public interface ResourceIDMapper<R, ID> {
    * String. See also docs for: {@link ExternalResourceCachingEventSource}
    *
    * @return static id mapper, all resources are mapped for same id.
-   * @param <T> secondary resource type
+   * @param <R> secondary resource type
    */
   static <R> ResourceIDMapper<R, String> singleResourceCacheKeyMapper() {
     return r -> "id";

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

@@ -26,9 +26,21 @@
 import io.javaoperatorsdk.operator.processing.ResourceIDMapper;
 import io.javaoperatorsdk.operator.processing.event.ResourceID;
 
+/**
+ * A narrowed interface for bulk dependent resources for Kubernetes resources, that assumes that the
+ * ID is a {@link ResourceID}. Note that you are not limited to this when dealing with Kubernetes
+ * resources you can still choose a different ID type and directly implement {@link
+ * BulkDependentResource}.
+ */
 public interface KubernetesBulkDependentResource<R extends HasMetadata, P extends HasMetadata>
     extends BulkDependentResource<R, P, ResourceID>, DependentResource<R, P> {
 
+  /**
+   * Since we can list all the related resources and by assuming the ID is type of {@link
+   * ResourceID} it is trivial to create the target map. The only issue is if there are other
+   * secondary resources of the target type which are not managed by this bulk dependent resources,
+   * for those it is enough to override secondaryResourceFilter method.
+   */
   @Override
   default Map<ResourceID, R> getSecondaryResources(P primary, Context<P> context) {
     return context
@@ -40,6 +52,10 @@ default Map<ResourceID, R> getSecondaryResources(P primary, Context<P> context)
                 Function.identity()));
   }
 
+  /**
+   * Override if not all the secondary resources of target type are managed by the bulk dependent
+   * resource.
+   */
   default Predicate<R> secondaryResourceFilter(P primary, Context<P> context) {
     return r -> true;
   }