diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java index 0cb82c5b30..b40d8d6dac 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java @@ -43,6 +43,7 @@ public Operator(KubernetesClient kubernetesClient) { } /** + * @param configurationService implementation * @deprecated Use {@link #Operator(Consumer)} instead */ @Deprecated(forRemoval = true) @@ -173,6 +174,7 @@ public void stop() throws OperatorException { * * @param reconciler the reconciler to register * @param
the {@code CustomResource} type associated with the reconciler + * @return registered controller * @throws OperatorException if a problem occurred during the registration process */ public
RegisteredController
register(Reconciler
reconciler) @@ -192,6 +194,7 @@ public
RegisteredController
register(Reconciler
re * @param reconciler part of the reconciler to register * @param configuration the configuration with which we want to register the reconciler * @param
the {@code HasMetadata} type associated with the reconciler + * @return registered controller * @throws OperatorException if a problem occurred during the registration process */ public
RegisteredController
register(Reconciler
reconciler, @@ -230,6 +233,7 @@ public
RegisteredController
register(Reconciler
re * * @param reconciler part of the reconciler to register * @param configOverrider consumer to use to change config values + * @return registered controller * @param
the {@code HasMetadata} type associated with the reconciler */ public
RegisteredController
register(Reconciler
reconciler,
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java
index d55984fae1..809a6ee359 100644
--- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java
+++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java
@@ -199,6 +199,8 @@ default Optional
getEventFilter() { /** * @deprecated Use {@link OnAddFilter}, {@link OnUpdateFilter} and {@link GenericFilter} instead + * + * @param eventFilter */ @Deprecated(forRemoval = true) protected void setEventFilter(ResourceEventFilter
eventFilter) { diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/informer/InformerConfiguration.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/informer/InformerConfiguration.java index 8adda74c0c..f883799cc9 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/informer/InformerConfiguration.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/informer/InformerConfiguration.java @@ -78,6 +78,8 @@ public
PrimaryToSecondaryMapper
getPrimaryToSecondary
* {@link io.javaoperatorsdk.operator.RegisteredController}). If true, changing the target
* namespaces of a controller would result to change target namespaces for the
* InformerEventSource.
+ *
+ * @return if namespace changes should be followed
*/
boolean followControllerNamespaceChanges();
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/monitoring/Metrics.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/monitoring/Metrics.java
index 1ce27d29df..42fee488d7 100644
--- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/monitoring/Metrics.java
+++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/monitoring/Metrics.java
@@ -23,6 +23,8 @@ public interface Metrics {
/**
* Do initialization if necessary;
+ *
+ * @param controller callback
*/
default void controllerRegistered(Controller extends HasMetadata> controller) {}
@@ -36,6 +38,9 @@ default void controllerRegistered(Controller extends HasMetadata> controller)
default void receivedEvent(Event event, Map eventSourceRetriever)
throws EventSourceNotFoundException;
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/ManagedDependentResourceContext.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/ManagedDependentResourceContext.java
index 42741c3a97..9c5b3dddb1 100644
--- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/ManagedDependentResourceContext.java
+++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/dependent/managed/ManagedDependentResourceContext.java
@@ -30,6 +30,7 @@ public interface ManagedDependentResourceContext {
* the semantics of this operation is defined as removing the mapping associated with the
* specified key.
*
+ * @param eventSourceRetriever) {
}
}
- /** To make this backwards compatible even for respect of overriding */
+ /**
+ * To make this backwards compatible even for respect of overriding
+ *
+ * @param context for event sources
+ * @return event source instance
+ */
@SuppressWarnings("unchecked")
public T initEventSource(EventSourceContext context) {
return (T) eventSource(context).orElseThrow();
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/DependentResourceWithExplicitState.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/DependentResourceWithExplicitState.java
index 2a1b0a64c7..6829442b2e 100644
--- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/DependentResourceWithExplicitState.java
+++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/DependentResourceWithExplicitState.java
@@ -31,7 +31,13 @@ default Optional the type of primary resources associated with the secondary resources we want to
* match
+ * @param strongEquality if the resource should match exactly
*/
public static
* Identifies the set of secondary resources associated with a given primary resource. This is
* typically needed when multiple secondary resources can be associated with one or several multiple
* primary resources *without* a standard way (e.g. owner reference or annotations) to materialize
@@ -18,16 +19,19 @@
* that this primary resource can properly be reconciled when changes impact the associated
* secondary resources, even though these don't contain any information allowing to make such an
* inference.
- *
* This helps particularly in cases where several secondary resources, listed in some way in the
* primary resource, need to or can be created before the primary resource exists. In that
* situation, attempting to retrieve the associated secondary resources by calling
* {@link io.javaoperatorsdk.operator.api.reconciler.Context#getSecondaryResource(Class)} would fail
* without providing a mapper to tell JOSDK how to retrieve the secondary resources.
- *
* You can see an example of this in action in the Reconciler
* for the PrimaryToSecondaryIT integration tests that handles many-to-many relationship.
+ * primary resource type
*/
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/retry/GenericRetry.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/retry/GenericRetry.java
index 3c67b87966..9d5a83dc51 100644
--- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/retry/GenericRetry.java
+++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/retry/GenericRetry.java
@@ -21,6 +21,9 @@ public static GenericRetry noRetry() {
/**
* @deprecated Use the {@link GradualRetry} annotation instead
+ *
+ * @param configuration retry config
+ * @return Retry instance
*/
@Deprecated(forRemoval = true)
public static Retry fromConfiguration(RetryConfiguration configuration) {
stateResourceClass();
- /** State resource which contains the target state. Usually an ID to address the resource */
+ /**
+ * State resource which contains the target state. Usually an ID to address the resource
+ *
+ * @param primary resource
+ * @param resource secondary resource
+ * @return that stores state
+ */
S stateResource(P primary, R resource);
}
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/GenericKubernetesResourceMatcher.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/GenericKubernetesResourceMatcher.java
index 352e4ee419..6a16d21b44 100644
--- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/GenericKubernetesResourceMatcher.java
+++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/GenericKubernetesResourceMatcher.java
@@ -124,6 +124,7 @@ public static