opendaylight/md-sal/statistics-manager/src/main/java/org/opendaylight/controller/md/statistics/manager/AbstractStatsTracker.java

   1 /*
   2  * Copyright IBM Corporation, 2013.  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.md.statistics.manager;
   9
  10 import java.util.HashMap;
  11 import java.util.Iterator;
  12 import java.util.List;
  13 import java.util.Map;
  14 import java.util.Map.Entry;
  15 import java.util.concurrent.Future;
  16
  17 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionAware;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionId;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  22 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  23 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  24 import org.opendaylight.yangtools.yang.common.RpcResult;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 import com.google.common.base.Function;
  29 import com.google.common.base.Preconditions;
  30 import com.google.common.util.concurrent.Futures;
  31 import com.google.common.util.concurrent.JdkFutureAdapters;
  32
  33 abstract class AbstractStatsTracker<I, K> {
  34     private static final Logger logger = LoggerFactory.getLogger(AbstractStatsTracker.class);
  35     private static final Function<RpcResult<? extends TransactionAware>, TransactionId> FUNCTION =
  36             new Function<RpcResult<? extends TransactionAware>, TransactionId>() {
  37         @Override
  38         public TransactionId apply(RpcResult<? extends TransactionAware> input) {
  39             if (!input.isSuccessful()) {
  40                 logger.debug("Statistics request failed: {}", input.getErrors());
  41                 throw new RPCFailedException("Failed to send statistics request", input.getErrors());
  42             }
  43
  44             return input.getResult().getTransactionId();
  45         }
  46     };
  47
  48     private final Map<K, Long> trackedItems = new HashMap<>();
  49     private final FlowCapableContext context;
  50     private final long lifetimeNanos;
  51
  52     protected AbstractStatsTracker(final FlowCapableContext context, final long lifetimeNanos) {
  53         this.context = Preconditions.checkNotNull(context);
  54         this.lifetimeNanos = lifetimeNanos;
  55     }
  56
  57     protected final InstanceIdentifierBuilder<Node> getNodeIdentifierBuilder() {
  58         return InstanceIdentifier.builder(getNodeIdentifier());
  59     }
  60
  61     protected final NodeRef getNodeRef() {
  62         return context.getNodeRef();
  63     }
  64
  65     protected final InstanceIdentifier<Node> getNodeIdentifier() {
  66         return context.getNodeIdentifier();
  67     }
  68
  69     protected final <T extends TransactionAware> void requestHelper(Future<RpcResult<T>> future) {
  70         context.registerTransaction(Futures.transform(JdkFutureAdapters.listenInPoolThread(future), FUNCTION));
  71     }
  72
  73     protected final DataModificationTransaction startTransaction() {
  74         return context.startDataModification();
  75     }
  76
  77     protected abstract void cleanupSingleStat(DataModificationTransaction trans, K item);
  78     protected abstract K updateSingleStat(DataModificationTransaction trans, I item);
  79
  80     public final synchronized void updateStats(List<I> list) {
  81         final Long expiryTime = System.nanoTime() + lifetimeNanos;
  82         final DataModificationTransaction trans = startTransaction();
  83
  84         for (final I item : list) {
  85             trackedItems.put(updateSingleStat(trans, item), expiryTime);
  86         }
  87
  88         trans.commit();
  89     }
  90
  91     public final synchronized void cleanup(final DataModificationTransaction trans, long now) {
  92         for (Iterator<Entry<K, Long>> it = trackedItems.entrySet().iterator();it.hasNext();){
  93             Entry<K, Long> e = it.next();
  94             if (now > e.getValue()) {
  95                 cleanupSingleStat(trans, e.getKey());
  96                 it.remove();
  97             }
  98         }
  99     }
 100 }