openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/util/BarrierUtil.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
   9 package org.opendaylight.openflowplugin.impl.util;
  10
  11 import com.google.common.base.Function;
  12 import com.google.common.util.concurrent.AsyncFunction;
  13 import com.google.common.util.concurrent.Futures;
  14 import com.google.common.util.concurrent.JdkFutureAdapters;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import javax.annotation.Nullable;
  17 import org.apache.commons.lang3.tuple.MutablePair;
  18 import org.apache.commons.lang3.tuple.Pair;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.FlowCapableTransactionService;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.SendBarrierInput;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.SendBarrierInputBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  23 import org.opendaylight.yangtools.yang.common.RpcResult;
  24
  25 /**
  26  * Provides barrier message chaining and factory methods.
  27  */
  28 public final class BarrierUtil {
  29
  30
  31     private BarrierUtil() {
  32         throw new IllegalStateException("This class should not be instantiated.");
  33     }
  34
  35
  36     /**
  37      * Chain a barrier message - regardless of previous result and use given {@link Function} to combine
  38      * original result and barrier result.
  39      *
  40      * @param <T>                type of input future
  41      * @param input              future to chain barrier to
  42      * @param nodeRef            target device
  43      * @param transactionService barrier service
  44      * @param compositeTransform composite transform
  45      * @return future holding both results (input and of the barrier)
  46      */
  47     public static <T> ListenableFuture<RpcResult<T>> chainBarrier(
  48             final ListenableFuture<RpcResult<T>> input, final NodeRef nodeRef,
  49             final FlowCapableTransactionService transactionService,
  50             final Function<Pair<RpcResult<T>, RpcResult<Void>>, RpcResult<T>> compositeTransform) {
  51         final MutablePair<RpcResult<T>, RpcResult<Void>> resultPair = new MutablePair<>();
  52
  53         // store input result and append barrier
  54         final ListenableFuture<RpcResult<Void>> barrierResult = Futures.transformAsync(input,
  55                 new AsyncFunction<RpcResult<T>, RpcResult<Void>>() {
  56                     @Override
  57                     public ListenableFuture<RpcResult<Void>> apply(@Nullable final RpcResult<T> interInput)
  58                             throws Exception {
  59                         resultPair.setLeft(interInput);
  60                         final SendBarrierInput barrierInput = createSendBarrierInput(nodeRef);
  61                         return JdkFutureAdapters.listenInPoolThread(transactionService.sendBarrier(barrierInput));
  62                     }
  63                 });
  64         // store barrier result and return initiated pair
  65         final ListenableFuture<Pair<RpcResult<T>, RpcResult<Void>>> compositeResult = Futures.transform(
  66                 barrierResult, new Function<RpcResult<Void>, Pair<RpcResult<T>, RpcResult<Void>>>() {
  67                     @Nullable
  68                     @Override
  69                     public Pair<RpcResult<T>, RpcResult<Void>> apply(@Nullable final RpcResult<Void> input) {
  70                         resultPair.setRight(input);
  71                         return resultPair;
  72                     }
  73                 });
  74         // append assembling transform to barrier result
  75         return Futures.transform(compositeResult, compositeTransform);
  76     }
  77
  78     /**
  79      * Creates barrier input.
  80      *
  81      * @param nodeRef rpc routing context
  82      * @return input for {@link FlowCapableTransactionService#sendBarrier(SendBarrierInput)}
  83      */
  84     public static SendBarrierInput createSendBarrierInput(final NodeRef nodeRef) {
  85         return new SendBarrierInputBuilder()
  86                 .setNode(nodeRef)
  87                 .build();
  88     }
  89 }