opendaylight/md-sal/cds-access-client/src/main/java/org/opendaylight/controller/cluster/access/client/AbstractClientActor.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 akka.actor.PoisonPill;
  12 import akka.persistence.UntypedPersistentActor;
  13 import com.google.common.annotations.Beta;
  14 import org.opendaylight.controller.cluster.access.concepts.FrontendIdentifier;
  15 import org.slf4j.Logger;
  16 import org.slf4j.LoggerFactory;
  17
  18 /**
  19  * Frontend actor which takes care of persisting generations and creates an appropriate ClientIdentifier.
  20  *
  21  * @author Robert Varga
  22  */
  23 @Beta
  24 public abstract class AbstractClientActor extends UntypedPersistentActor {
  25     private static final Logger LOG = LoggerFactory.getLogger(AbstractClientActor.class);
  26     private AbstractClientActorBehavior<?> currentBehavior;
  27
  28     protected AbstractClientActor(final FrontendIdentifier frontendId) {
  29         currentBehavior = new RecoveringClientActorBehavior(
  30                 new InitialClientActorContext(this, frontendId.toPersistentId()), frontendId);
  31     }
  32
  33     @Override
  34     public final String persistenceId() {
  35         return currentBehavior.persistenceId();
  36     }
  37
  38     @Override
  39     public void postStop() {
  40         if (currentBehavior != null) {
  41             currentBehavior.close();
  42         }
  43
  44         super.postStop();
  45     }
  46
  47     private void switchBehavior(final AbstractClientActorBehavior<?> nextBehavior) {
  48         if (!currentBehavior.equals(nextBehavior)) {
  49             if (nextBehavior == null) {
  50                 LOG.debug("{}: shutting down", persistenceId());
  51                 self().tell(PoisonPill.getInstance(), ActorRef.noSender());
  52             } else {
  53                 LOG.debug("{}: switched from {} to {}", persistenceId(), currentBehavior, nextBehavior);
  54             }
  55
  56             currentBehavior.close();
  57             currentBehavior = nextBehavior;
  58         }
  59     }
  60
  61     @Override
  62     public final void onReceiveCommand(final Object command) {
  63         if (command == null) {
  64             LOG.debug("{}: ignoring null command", persistenceId());
  65             return;
  66         }
  67
  68         if (currentBehavior != null) {
  69             switchBehavior(currentBehavior.onReceiveCommand(command));
  70         } else {
  71             LOG.debug("{}: shutting down, ignoring command {}", persistenceId(), command);
  72         }
  73     }
  74
  75     @Override
  76     public final void onReceiveRecover(final Object recover) {
  77         switchBehavior(currentBehavior.onReceiveRecover(recover));
  78     }
  79
  80     protected abstract ClientActorBehavior<?> initialBehavior(ClientActorContext context);
  81
  82     protected abstract ClientActorConfig getClientActorConfig();
  83 }