opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorContextImpl.java

   1 /*
   2  * Copyright (c) 2014 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
   9 package org.opendaylight.controller.cluster.raft;
  10
  11 import static com.google.common.base.Preconditions.checkState;
  12 import akka.actor.ActorRef;
  13 import akka.actor.ActorSelection;
  14 import akka.actor.ActorSystem;
  15 import akka.actor.Props;
  16 import akka.actor.UntypedActorContext;
  17 import com.google.common.annotations.VisibleForTesting;
  18 import com.google.common.base.Supplier;
  19 import java.util.Map;
  20 import org.opendaylight.controller.cluster.DataPersistenceProvider;
  21 import org.slf4j.Logger;
  22
  23 public class RaftActorContextImpl implements RaftActorContext {
  24
  25     private final ActorRef actor;
  26
  27     private final UntypedActorContext context;
  28
  29     private final String id;
  30
  31     private final ElectionTerm termInformation;
  32
  33     private long commitIndex;
  34
  35     private long lastApplied;
  36
  37     private ReplicatedLog replicatedLog;
  38
  39     private final Map<String, String> peerAddresses;
  40
  41     private final Logger LOG;
  42
  43     private ConfigParams configParams;
  44
  45     @VisibleForTesting
  46     private Supplier<Long> totalMemoryRetriever;
  47
  48     // Snapshot manager will need to be created on demand as it needs raft actor context which cannot
  49     // be passed to it in the constructor
  50     private SnapshotManager snapshotManager;
  51
  52     private final DataPersistenceProvider persistenceProvider;
  53
  54     private short payloadVersion;
  55
  56     public RaftActorContextImpl(ActorRef actor, UntypedActorContext context, String id,
  57             ElectionTerm termInformation, long commitIndex, long lastApplied, Map<String, String> peerAddresses,
  58             ConfigParams configParams, DataPersistenceProvider persistenceProvider, Logger logger) {
  59         this.actor = actor;
  60         this.context = context;
  61         this.id = id;
  62         this.termInformation = termInformation;
  63         this.commitIndex = commitIndex;
  64         this.lastApplied = lastApplied;
  65         this.peerAddresses = peerAddresses;
  66         this.configParams = configParams;
  67         this.persistenceProvider = persistenceProvider;
  68         this.LOG = logger;
  69     }
  70
  71     void setPayloadVersion(short payloadVersion) {
  72         this.payloadVersion = payloadVersion;
  73     }
  74
  75     @Override
  76     public short getPayloadVersion() {
  77         return payloadVersion;
  78     }
  79
  80     void setConfigParams(ConfigParams configParams) {
  81         this.configParams = configParams;
  82     }
  83
  84     @Override
  85     public ActorRef actorOf(Props props){
  86         return context.actorOf(props);
  87     }
  88
  89     @Override
  90     public ActorSelection actorSelection(String path){
  91         return context.actorSelection(path);
  92     }
  93
  94     @Override
  95     public String getId() {
  96         return id;
  97     }
  98
  99     @Override
 100     public ActorRef getActor() {
 101         return actor;
 102     }
 103
 104     @Override
 105     public ElectionTerm getTermInformation() {
 106         return termInformation;
 107     }
 108
 109     @Override
 110     public long getCommitIndex() {
 111         return commitIndex;
 112     }
 113
 114     @Override public void setCommitIndex(long commitIndex) {
 115         this.commitIndex = commitIndex;
 116     }
 117
 118     @Override
 119     public long getLastApplied() {
 120         return lastApplied;
 121     }
 122
 123     @Override public void setLastApplied(long lastApplied) {
 124         this.lastApplied = lastApplied;
 125     }
 126
 127     @Override public void setReplicatedLog(ReplicatedLog replicatedLog) {
 128         this.replicatedLog = replicatedLog;
 129     }
 130
 131     @Override public ReplicatedLog getReplicatedLog() {
 132         return replicatedLog;
 133     }
 134
 135     @Override public ActorSystem getActorSystem() {
 136         return context.system();
 137     }
 138
 139     @Override public Logger getLogger() {
 140         return this.LOG;
 141     }
 142
 143     @Override public Map<String, String> getPeerAddresses() {
 144         return peerAddresses;
 145     }
 146
 147     @Override public String getPeerAddress(String peerId) {
 148         return peerAddresses.get(peerId);
 149     }
 150
 151     @Override public ConfigParams getConfigParams() {
 152         return configParams;
 153     }
 154
 155     @Override public void addToPeers(String name, String address) {
 156         peerAddresses.put(name, address);
 157     }
 158
 159     @Override public void removePeer(String name) {
 160         peerAddresses.remove(name);
 161     }
 162
 163     @Override public ActorSelection getPeerActorSelection(String peerId) {
 164         String peerAddress = getPeerAddress(peerId);
 165         if(peerAddress != null){
 166             return actorSelection(peerAddress);
 167         }
 168         return null;
 169     }
 170
 171     @Override public void setPeerAddress(String peerId, String peerAddress) {
 172         LOG.info("Peer address for peer {} set to {}", peerId, peerAddress);
 173         checkState(peerAddresses.containsKey(peerId), peerId + " is unknown");
 174
 175         peerAddresses.put(peerId, peerAddress);
 176     }
 177
 178     @Override
 179     public SnapshotManager getSnapshotManager() {
 180         if(snapshotManager == null){
 181             snapshotManager = new SnapshotManager(this, LOG);
 182         }
 183         return snapshotManager;
 184     }
 185
 186     @Override
 187     public long getTotalMemory() {
 188         return totalMemoryRetriever != null ? totalMemoryRetriever.get() : Runtime.getRuntime().totalMemory();
 189     }
 190
 191     @Override
 192     public void setTotalMemoryRetriever(Supplier<Long> retriever) {
 193         totalMemoryRetriever = retriever;
 194     }
 195
 196     @Override
 197     public boolean hasFollowers() {
 198         return getPeerAddresses().keySet().size() > 0;
 199     }
 200
 201     @Override
 202     public DataPersistenceProvider getPersistenceProvider() {
 203         return persistenceProvider;
 204     }
 205 }