refactor: renaming core classes and APIs

micrometer-support/src/main/java/io/javaoperatorsdk/operator/monitoring/micrometer/MicrometerMetrics.java

@@ -5,8 +5,8 @@
 import java.util.List;
 import java.util.Map;
 
-import io.javaoperatorsdk.operator.api.RetryInfo;
 import io.javaoperatorsdk.operator.api.monitoring.Metrics;
+import io.javaoperatorsdk.operator.api.reconciler.RetryInfo;
 import io.javaoperatorsdk.operator.processing.event.CustomResourceID;
 import io.javaoperatorsdk.operator.processing.event.Event;
 import io.micrometer.core.instrument.MeterRegistry;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/ControllerUtils.java

@@ -2,8 +2,8 @@
 
 import java.util.Locale;
 
-import io.javaoperatorsdk.operator.api.Controller;
-import io.javaoperatorsdk.operator.api.ResourceController;
+import io.javaoperatorsdk.operator.api.reconciler.Controller;
+import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 
 @SuppressWarnings("rawtypes")
 public class ControllerUtils {
@@ -14,7 +14,7 @@ public static String getDefaultFinalizerName(String crdName) {
     return crdName + FINALIZER_NAME_SUFFIX;
   }
 
-  public static String getNameFor(Class<? extends ResourceController> controllerClass) {
+  public static String getNameFor(Class<? extends Reconciler> controllerClass) {
     // if the controller annotation has a name attribute, use it
     final var annotation = controllerClass.getAnnotation(Controller.class);
     if (annotation != null) {
@@ -23,24 +23,23 @@ public static String getNameFor(Class<? extends ResourceController> controllerCl
         return name;
       }
     }
-
     // otherwise, use the lower-cased full class name
     return getDefaultNameFor(controllerClass);
   }
 
-  public static String getNameFor(ResourceController controller) {
+  public static String getNameFor(Reconciler controller) {
     return getNameFor(controller.getClass());
   }
 
-  public static String getDefaultNameFor(ResourceController controller) {
+  public static String getDefaultNameFor(Reconciler controller) {
     return getDefaultNameFor(controller.getClass());
   }
 
-  public static String getDefaultNameFor(Class<? extends ResourceController> controllerClass) {
-    return getDefaultResourceControllerName(controllerClass.getSimpleName());
+  public static String getDefaultNameFor(Class<? extends Reconciler> reconcilerClass) {
+    return getDefaultReconcilerName(reconcilerClass.getSimpleName());
   }
 
-  public static String getDefaultResourceControllerName(String rcControllerClassName) {
+  public static String getDefaultReconcilerName(String rcControllerClassName) {
     // if the name is fully qualified, extract the simple class name
     final var lastDot = rcControllerClassName.lastIndexOf('.');
     if (lastDot > 0) {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java

@@ -14,10 +14,10 @@
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.Version;
 import io.javaoperatorsdk.operator.api.LifecycleAware;
-import io.javaoperatorsdk.operator.api.ResourceController;
 import io.javaoperatorsdk.operator.api.config.ConfigurationService;
 import io.javaoperatorsdk.operator.api.config.ControllerConfiguration;
 import io.javaoperatorsdk.operator.api.config.ExecutorServiceManager;
+import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import io.javaoperatorsdk.operator.processing.ConfiguredController;
 
 @SuppressWarnings("rawtypes")
@@ -114,9 +114,9 @@ public void close() {
    * @param <R> the {@code CustomResource} type associated with the controller
    * @throws OperatorException if a problem occurred during the registration process
    */
-  public <R extends CustomResource<?, ?>> void register(ResourceController<R> controller)
+  public <R extends CustomResource<?, ?>> void registerController(Reconciler<R> controller)
       throws OperatorException {
-    register(controller, null);
+    registerController(controller, null);
   }
 
   /**
@@ -126,28 +126,28 @@ public void close() {
    * passing it the controller's original configuration. The effective registration of the
    * controller is delayed till the operator is started.
    *
-   * @param controller the controller to register
+   * @param reconciler part of the controller to register
    * @param configuration the configuration with which we want to register the controller, if {@code
    *     null}, the controller's original configuration is used
    * @param <R> the {@code CustomResource} type associated with the controller
    * @throws OperatorException if a problem occurred during the registration process
    */
-  public <R extends CustomResource<?, ?>> void register(
-      ResourceController<R> controller, ControllerConfiguration<R> configuration)
+  public <R extends CustomResource<?, ?>> void registerController(
+      Reconciler<R> reconciler, ControllerConfiguration<R> configuration)
       throws OperatorException {
-    final var existing = configurationService.getConfigurationFor(controller);
+    final var existing = configurationService.getConfigurationFor(reconciler);
     if (existing == null) {
       throw new OperatorException(
-          "Cannot register controller with name " + controller.getClass().getCanonicalName() +
-              " controller named " + ControllerUtils.getNameFor(controller)
+          "Cannot register controller with name " + reconciler.getClass().getCanonicalName() +
+              " controller named " + ControllerUtils.getNameFor(reconciler)
               + " because its configuration cannot be found.\n" +
               " Known controllers are: " + configurationService.getKnownControllerNames());
     } else {
       if (configuration == null) {
         configuration = existing;
       }
       final var configuredController =
-          new ConfiguredController<>(controller, configuration, kubernetesClient);
+          new ConfiguredController<>(reconciler, configuration, kubernetesClient);
       controllers.add(configuredController);
 
       final var watchedNS =

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/ObservedGenerationAware.java

@@ -3,6 +3,7 @@
 import java.util.Optional;
 
 import io.fabric8.kubernetes.client.CustomResource;
+import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
 
 /**
  * If the custom resource's status implements this interface, the observed generation will be

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/AbstractConfigurationService.java

@@ -7,7 +7,7 @@
 
 import io.fabric8.kubernetes.client.CustomResource;
 import io.javaoperatorsdk.operator.ControllerUtils;
-import io.javaoperatorsdk.operator.api.ResourceController;
+import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 
 @SuppressWarnings("rawtypes")
 public class AbstractConfigurationService implements ConfigurationService {
@@ -52,7 +52,7 @@ public AbstractConfigurationService(Version version) {
 
   @Override
   public <R extends CustomResource<?, ?>> ControllerConfiguration<R> getConfigurationFor(
-      ResourceController<R> controller) {
+      Reconciler<R> controller) {
     final var key = keyFor(controller);
     final var configuration = configurations.get(key);
     if (configuration == null) {
@@ -73,7 +73,7 @@ private String getControllersNameMessage() {
         + ".";
   }
 
-  protected <R extends CustomResource<?, ?>> String keyFor(ResourceController<R> controller) {
+  protected <R extends CustomResource<?, ?>> String keyFor(Reconciler<R> controller) {
     return ControllerUtils.getNameFor(controller);
   }
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java

@@ -6,8 +6,8 @@
 
 import io.fabric8.kubernetes.client.Config;
 import io.fabric8.kubernetes.client.CustomResource;
-import io.javaoperatorsdk.operator.api.ResourceController;
 import io.javaoperatorsdk.operator.api.monitoring.Metrics;
+import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -37,7 +37,7 @@ public interface ConfigurationService {
    * null} if no configuration exists for the controller
    */
   <R extends CustomResource<?, ?>> ControllerConfiguration<R> getConfigurationFor(
-      ResourceController<R> controller);
+      Reconciler<R> controller);
 
   /**
    * Retrieves the Kubernetes client configuration

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationServiceOverrider.java

@@ -4,8 +4,8 @@
 
 import io.fabric8.kubernetes.client.Config;
 import io.fabric8.kubernetes.client.CustomResource;
-import io.javaoperatorsdk.operator.api.ResourceController;
 import io.javaoperatorsdk.operator.api.monitoring.Metrics;
+import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 
 public class ConfigurationServiceOverrider {
   private final ConfigurationService original;
@@ -62,7 +62,7 @@ public ConfigurationService build() {
     return new ConfigurationService() {
       @Override
       public <R extends CustomResource<?, ?>> ControllerConfiguration<R> getConfigurationFor(
-          ResourceController<R> controller) {
+          Reconciler<R> controller) {
         return original.getConfigurationFor(controller);
       }
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfiguration.java

@@ -6,14 +6,14 @@
 
 import io.fabric8.kubernetes.client.CustomResource;
 import io.javaoperatorsdk.operator.ControllerUtils;
-import io.javaoperatorsdk.operator.api.Controller;
+import io.javaoperatorsdk.operator.api.reconciler.Controller;
 import io.javaoperatorsdk.operator.processing.event.internal.CustomResourceEventFilter;
 import io.javaoperatorsdk.operator.processing.event.internal.CustomResourceEventFilters;
 
 public interface ControllerConfiguration<R extends CustomResource<?, ?>> {
 
   default String getName() {
-    return ControllerUtils.getDefaultResourceControllerName(getAssociatedControllerClassName());
+    return ControllerUtils.getDefaultReconcilerName(getAssociatedControllerClassName());
   }
 
   default String getCRDName() {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/monitoring/Metrics.java

@@ -2,7 +2,7 @@
 
 import java.util.Map;
 
-import io.javaoperatorsdk.operator.api.RetryInfo;
+import io.javaoperatorsdk.operator.api.reconciler.RetryInfo;
 import io.javaoperatorsdk.operator.processing.event.CustomResourceID;
 import io.javaoperatorsdk.operator.processing.event.Event;
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/BaseControl.java → operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/BaseControl.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.api;
+package io.javaoperatorsdk.operator.api.reconciler;
 
 import java.util.Optional;
 import java.util.concurrent.TimeUnit;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/Context.java → operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/Context.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.api;
+package io.javaoperatorsdk.operator.api.reconciler;
 
 import java.util.Optional;
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/Controller.java → operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/Controller.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.api;
+package io.javaoperatorsdk.operator.api.reconciler;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/DefaultContext.java → operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/DefaultContext.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.api;
+package io.javaoperatorsdk.operator.api.reconciler;
 
 import java.util.Optional;
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/DeleteControl.java → operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/DeleteControl.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.api;
+package io.javaoperatorsdk.operator.api.reconciler;
 
 public class DeleteControl extends BaseControl<DeleteControl> {
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/EventSourceInitializer.java

@@ -0,0 +1,17 @@
+package io.javaoperatorsdk.operator.api.reconciler;
+
+import io.fabric8.kubernetes.client.CustomResource;
+import io.javaoperatorsdk.operator.processing.event.EventSourceRegistry;
+
+public interface EventSourceInitializer<T extends CustomResource<?, ?>> {
+
+  /**
+   * In this typically you might want to register event sources. But can access
+   * CustomResourceEventSource, what might be handy for some edge cases.
+   * 
+   * @param eventSourceRegistry the {@link EventSourceRegistry} where event sources can be
+   *        registered.
+   */
+  void prepareEventSources(EventSourceRegistry<T> eventSourceRegistry);
+
+}

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/ResourceController.java → operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/Reconciler.java

@@ -1,8 +1,8 @@
-package io.javaoperatorsdk.operator.api;
+package io.javaoperatorsdk.operator.api.reconciler;
 
 import io.fabric8.kubernetes.client.CustomResource;
 
-public interface ResourceController<R extends CustomResource<?, ?>> {
+public interface Reconciler<R extends CustomResource<?, ?>> {
 
   /**
    * Note that this method is used in combination of finalizers. If automatic finalizer handling is
@@ -28,7 +28,7 @@ public interface ResourceController<R extends CustomResource<?, ?>> {
    *         finalizer to indicate that the resource should not be deleted after all, in which case
    *         the controller should restore the resource's state appropriately.
    */
-  default DeleteControl deleteResource(R resource, Context context) {
+  default DeleteControl deleteResources(R resource, Context context) {
     return DeleteControl.defaultDelete();
   }
 
@@ -46,6 +46,6 @@ default DeleteControl deleteResource(R resource, Context context) {
    *         be skipped. <b>However we will always call an update if there is no finalizer on object
    *         and it's not marked for deletion.</b>
    */
-  UpdateControl<R> createOrUpdateResource(R resource, Context context);
+  UpdateControl<R> createOrUpdateResources(R resource, Context context);
 
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/RetryInfo.java → operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/RetryInfo.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.api;
+package io.javaoperatorsdk.operator.api.reconciler;
 
 public interface RetryInfo {
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/UpdateControl.java → operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/UpdateControl.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.operator.api;
+package io.javaoperatorsdk.operator.api.reconciler;
 
 import io.fabric8.kubernetes.client.CustomResource;