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