Improve segmented journal actor metrics

[controller.git] / opendaylight / md-sal / cds-access-client / src / main / java / org / opendaylight / controller / cluster / access / client / BackendInfoResolver.java

diff --git a/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/BackendInfoResolver.java b/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/BackendInfoResolver.java
index e4aa2b1e75e267e1f6b4599c1e5c6347153e3c81..5c5cda5bae0b8f7eb2e4bb02bd827e47c234c07b 100644 (file)
--- a/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/BackendInfoResolver.java
+++ b/opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/BackendInfoResolver.java
@@ -9,7 +9,9 @@ package org.opendaylight.controller.cluster.access.client;
 
 import akka.actor.ActorRef;
 import java.util.concurrent.CompletionStage;
-import javax.annotation.Nonnull;
+import java.util.function.Consumer;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.yangtools.concepts.Registration;
 
 /**
  * Caching resolver which resolves a cookie to a leader {@link ActorRef}. This class needs to be specialized by the
@@ -17,17 +19,23 @@ import javax.annotation.Nonnull;
  * by either the client actor (when a message timeout is detected) and by the specific frontend (on explicit
  * invalidation or when updated information becomes available).
  *
+ * <p>
+ * If the completion stage returned by this interface's methods fails with a
+ * {@link org.opendaylight.controller.cluster.access.concepts.RequestException}, it will be forwarded to all
+ * outstanding requests towards the leader. If it fails with a {@link java.util.concurrent.TimeoutException},
+ * resolution process will be retried. If it fails with any other cause, it will we wrapped as a
+ * {@link org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException} wrapping that cause.
+ *
  * @author Robert Varga
  */
-public abstract class BackendInfoResolver<T extends BackendInfo> {
+public abstract class BackendInfoResolver<T extends BackendInfo> implements AutoCloseable {
     /**
      * Request resolution of a particular backend identified by a cookie. This request can be satisfied from the cache.
      *
      * @param cookie Backend cookie
      * @return A {@link CompletionStage} resulting in information about the backend
      */
-    @Nonnull
-    public abstract CompletionStage<? extends T> getBackendInfo(@Nonnull Long cookie);
+    public abstract @NonNull CompletionStage<? extends T> getBackendInfo(@NonNull Long cookie);
 
     /**
      * Request re-resolution of a particular backend identified by a cookie, indicating a particular information as
@@ -37,6 +45,21 @@ public abstract class BackendInfoResolver<T extends BackendInfo> {
      * @param staleInfo Stale backend information
      * @return A {@link CompletionStage} resulting in information about the backend
      */
-    @Nonnull
-    public abstract CompletionStage<? extends T> refreshBackendInfo(@Nonnull Long cookie, @Nonnull T staleInfo);
+    public abstract @NonNull CompletionStage<? extends T> refreshBackendInfo(@NonNull Long cookie,
+            @NonNull T staleInfo);
+
+    /**
+     * Registers a callback to be notified when BackendInfo that may have been previously obtained is now stale and
+     * should be refreshed.
+     *
+     * @param callback the callback that takes the backend cookie whose BackendInfo is now stale.
+     * @return a Registration
+     */
+    public abstract @NonNull Registration notifyWhenBackendInfoIsStale(Consumer<Long> callback);
+
+    public abstract @NonNull String resolveCookieName(Long cookie);
+
+    @Override
+    public void close() {
+    }
 }