opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/actors/dds/DistributedDataStoreClientBehavior.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.databroker.actors.dds;
   9
  10 import akka.actor.ActorRef;
  11 import akka.actor.Status;
  12 import java.util.concurrent.CompletableFuture;
  13 import java.util.concurrent.CompletionStage;
  14 import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
  15 import org.opendaylight.controller.cluster.datastore.actors.client.ClientActorBehavior;
  16 import org.opendaylight.controller.cluster.datastore.actors.client.ClientActorContext;
  17 import org.slf4j.Logger;
  18 import org.slf4j.LoggerFactory;
  19
  20 /**
  21  * {@link ClientActorBehavior} acting as an intermediary between the backend actors and the DistributedDataStore
  22  * frontend.
  23  *
  24  * This class is not visible outside of this package because it breaks the actor containment. Services provided to
  25  * Java world outside of actor containment are captured in {@link DistributedDataStoreClient}.
  26  *
  27  * IMPORTANT: this class breaks actor containment via methods implementing {@link DistributedDataStoreClient} contract.
  28  *            When touching internal state, be mindful of the execution context from which execution context, Actor
  29  *            or POJO, is the state being accessed or modified.
  30  *
  31  * THREAD SAFETY: this class must always be kept thread-safe, so that both the Actor System thread and the application
  32  *                threads can run concurrently. All state transitions must be made in a thread-safe manner. When in
  33  *                doubt, feel free to synchronize on this object.
  34  *
  35  * PERFORMANCE: this class lies in a performance-critical fast path. All code needs to be concise and efficient, but
  36  *              performance must not come at the price of correctness. Any optimizations need to be carefully analyzed
  37  *              for correctness and performance impact.
  38  *
  39  * TRADE-OFFS: part of the functionality runs in application threads without switching contexts, which makes it ideal
  40  *             for performing work and charging applications for it. That has two positive effects:
  41  *             - CPU usage is distributed across applications, minimizing work done in the actor thread
  42  *             - CPU usage provides back-pressure towards the application.
  43  *
  44  * @author Robert Varga
  45  */
  46 final class DistributedDataStoreClientBehavior extends ClientActorBehavior implements DistributedDataStoreClient {
  47     private static final Logger LOG = LoggerFactory.getLogger(DistributedDataStoreClientBehavior.class);
  48
  49     private long nextHistoryId;
  50
  51     DistributedDataStoreClientBehavior(final ClientActorContext context) {
  52         super(context);
  53     }
  54
  55     //
  56     //
  57     // Methods below are invoked from the client actor thread
  58     //
  59     //
  60
  61     @Override
  62     protected void haltClient(final Throwable cause) {
  63         // FIXME: Add state flushing here once we have state
  64     }
  65
  66     private ClientActorBehavior createLocalHistory(final CompletableFuture<ClientLocalHistory> future) {
  67         final LocalHistoryIdentifier historyId = new LocalHistoryIdentifier(getIdentifier(), nextHistoryId++);
  68         LOG.debug("{}: creating a new local history {} for {}", persistenceId(), historyId, future);
  69
  70         // FIXME: initiate backend instantiation
  71         future.completeExceptionally(new UnsupportedOperationException("Not implemented yet"));
  72         return this;
  73     }
  74
  75     private ClientActorBehavior shutdown() {
  76         // FIXME: Add shutdown procedures here
  77         return null;
  78     }
  79
  80     @Override
  81     protected ClientActorBehavior onCommand(final Object command) {
  82         if (command instanceof GetClientRequest) {
  83             ((GetClientRequest) command).getReplyTo().tell(new Status.Success(this), ActorRef.noSender());
  84         } else {
  85             LOG.warn("{}: ignoring unhandled command {}", persistenceId(), command);
  86         }
  87
  88         return this;
  89     }
  90
  91     //
  92     //
  93     // Methods below are invoked from application threads
  94     //
  95     //
  96
  97     @Override
  98     public CompletionStage<ClientLocalHistory> createLocalHistory() {
  99         final CompletableFuture<ClientLocalHistory> future = new CompletableFuture<>();
 100         context().executeInActor(() -> createLocalHistory(future));
 101         return future;
 102     }
 103
 104     @Override
 105     public void close() {
 106         context().executeInActor(this::shutdown);
 107     }
 108 }