opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/FrontendMetadata.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.datastore;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.collect.Collections2;
  12 import com.google.common.collect.Maps;
  13 import java.util.HashMap;
  14 import java.util.Map;
  15 import javax.annotation.Nonnull;
  16 import javax.annotation.concurrent.NotThreadSafe;
  17 import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier;
  18 import org.opendaylight.controller.cluster.access.concepts.FrontendIdentifier;
  19 import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
  20 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  21 import org.opendaylight.controller.cluster.datastore.persisted.FrontendClientMetadata;
  22 import org.opendaylight.controller.cluster.datastore.persisted.FrontendShardDataTreeSnapshotMetadata;
  23 import org.slf4j.Logger;
  24 import org.slf4j.LoggerFactory;
  25
  26 /**
  27  * Frontend state as observed by a shard follower. This class is responsible for maintaining metadata state
  28  * so that this can be used to seed {@link LeaderFrontendState} with proper state so that the frontend/backend
  29  * conversation can continue where it left off.
  30  *
  31  * @author Robert Varga
  32  */
  33 @NotThreadSafe
  34 final class FrontendMetadata extends ShardDataTreeMetadata<FrontendShardDataTreeSnapshotMetadata> {
  35     private static final Logger LOG = LoggerFactory.getLogger(FrontendMetadata.class);
  36
  37     private final Map<FrontendIdentifier, FrontendClientMetadataBuilder> clients = new HashMap<>();
  38     private final String shardName;
  39
  40     FrontendMetadata(final String shardName) {
  41         this.shardName = Preconditions.checkNotNull(shardName);
  42     }
  43
  44     @Override
  45     Class<FrontendShardDataTreeSnapshotMetadata> getSupportedType() {
  46         return FrontendShardDataTreeSnapshotMetadata.class;
  47     }
  48
  49     @Override
  50     void reset() {
  51         clients.clear();
  52     }
  53
  54     @Override
  55     void doApplySnapshot(final FrontendShardDataTreeSnapshotMetadata snapshot) {
  56         clients.clear();
  57
  58         for (FrontendClientMetadata m : snapshot.getClients()) {
  59             clients.put(m.getIdentifier().getFrontendId(), new FrontendClientMetadataBuilder(m));
  60         }
  61     }
  62
  63     @Override
  64     FrontendShardDataTreeSnapshotMetadata toSnapshot() {
  65         return new FrontendShardDataTreeSnapshotMetadata(Collections2.transform(clients.values(),
  66             FrontendClientMetadataBuilder::build));
  67     }
  68
  69     private FrontendClientMetadataBuilder ensureClient(final ClientIdentifier id) {
  70         final FrontendClientMetadataBuilder existing = clients.get(id.getFrontendId());
  71         if (existing != null && id.equals(existing.getIdentifier())) {
  72             return existing;
  73         }
  74
  75         final FrontendClientMetadataBuilder client = new FrontendClientMetadataBuilder(id);
  76         final FrontendClientMetadataBuilder previous = clients.put(id.getFrontendId(), client);
  77         if (previous != null) {
  78             LOG.debug("{}: Replaced client {} with {}", shardName, previous, client);
  79         } else {
  80             LOG.debug("{}: Added client {}", shardName, client);
  81         }
  82         return client;
  83     }
  84
  85     @Override
  86     void onHistoryCreated(final LocalHistoryIdentifier historyId) {
  87         ensureClient(historyId.getClientId()).onHistoryCreated(historyId);
  88     }
  89
  90     @Override
  91     void onHistoryClosed(final LocalHistoryIdentifier historyId) {
  92         ensureClient(historyId.getClientId()).onHistoryClosed(historyId);
  93     }
  94
  95     @Override
  96     void onHistoryPurged(final LocalHistoryIdentifier historyId) {
  97         ensureClient(historyId.getClientId()).onHistoryPurged(historyId);
  98     }
  99
 100     @Override
 101     void onTransactionAborted(final TransactionIdentifier txId) {
 102         ensureClient(txId.getHistoryId().getClientId()).onTransactionAborted(txId);
 103     }
 104
 105     @Override
 106     void onTransactionCommitted(final TransactionIdentifier txId) {
 107         ensureClient(txId.getHistoryId().getClientId()).onTransactionCommitted(txId);
 108     }
 109
 110     @Override
 111     void onTransactionPurged(final TransactionIdentifier txId) {
 112         ensureClient(txId.getHistoryId().getClientId()).onTransactionPurged(txId);
 113     }
 114
 115     /**
 116      * Transform frontend metadata into an active leader state map.
 117      *
 118      * @return Leader frontend state
 119      */
 120     @Nonnull Map<FrontendIdentifier, LeaderFrontendState> toLeaderState(@Nonnull final Shard shard) {
 121         return new HashMap<>(Maps.transformValues(clients, meta -> meta.toLeaderState(shard)));
 122     }
 123 }