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

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.access.client;
   9
  10 import akka.actor.ActorRef;
  11 import java.util.concurrent.CompletionStage;
  12 import javax.annotation.Nonnull;
  13
  14 /**
  15  * Caching resolver which resolves a cookie to a leader {@link ActorRef}. This class needs to be specialized by the
  16  * client. It is used by {@link ClientActorBehavior} for request dispatch. Results are cached until they are invalidated
  17  * by either the client actor (when a message timeout is detected) and by the specific frontend (on explicit
  18  * invalidation or when updated information becomes available).
  19  *
  20  * <p>
  21  * If the completion stage returned by this interface's methods fails with a
  22  * {@link org.opendaylight.controller.cluster.access.concepts.RequestException}, it will be forwarded to all
  23  * outstanding requests towards the leader. If it fails with a {@link java.util.concurrent.TimeoutException},
  24  * resolution process will be retries. If it fails with any other cause, it will we wrapped as a
  25  * {@link org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException} wrapping that cause.
  26  *
  27  * @author Robert Varga
  28  */
  29 public abstract class BackendInfoResolver<T extends BackendInfo> {
  30     /**
  31      * Request resolution of a particular backend identified by a cookie. This request can be satisfied from the cache.
  32      *
  33      * @param cookie Backend cookie
  34      * @return A {@link CompletionStage} resulting in information about the backend
  35      */
  36     @Nonnull
  37     public abstract CompletionStage<? extends T> getBackendInfo(@Nonnull Long cookie);
  38
  39     /**
  40      * Request re-resolution of a particular backend identified by a cookie, indicating a particular information as
  41      * being stale. If the implementation's cache holds the stale information, it should be purged.
  42      *
  43      * @param cookie Backend cookie
  44      * @param staleInfo Stale backend information
  45      * @return A {@link CompletionStage} resulting in information about the backend
  46      */
  47     @Nonnull
  48     public abstract CompletionStage<? extends T> refreshBackendInfo(@Nonnull Long cookie, @Nonnull T staleInfo);
  49 }