openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/services/batch/FlatBatchMeterAdapters.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.services.batch;
  10
  11 import com.google.common.annotations.VisibleForTesting;
  12 import com.google.common.base.Function;
  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 java.util.ArrayList;
  17 import java.util.List;
  18 import java.util.concurrent.Future;
  19 import javax.annotation.Nullable;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.ProcessFlatBatchOutput;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.ProcessFlatBatchOutputBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.flat.batch.add.meter._case.FlatBatchAddMeter;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.flat.batch.remove.meter._case.FlatBatchRemoveMeter;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.flat.batch.update.meter._case.FlatBatchUpdateMeter;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.output.BatchFailure;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.output.BatchFailureBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.output.batch.failure.batch.item.id.choice.FlatBatchFailureMeterIdCaseBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.AddMetersBatchInput;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.AddMetersBatchInputBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.BatchMeterOutputListGrouping;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.RemoveMetersBatchInput;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.RemoveMetersBatchInputBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.UpdateMetersBatchInput;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.UpdateMetersBatchInputBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.add.meters.batch.input.BatchAddMeters;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.add.meters.batch.input.BatchAddMetersBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.batch.meter.output.list.grouping.BatchFailedMetersOutput;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.remove.meters.batch.input.BatchRemoveMeters;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.remove.meters.batch.input.BatchRemoveMetersBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.update.meters.batch.input.BatchUpdateMeters;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.update.meters.batch.input.BatchUpdateMetersBuilder;
  43 import org.opendaylight.yangtools.yang.common.RpcResult;
  44 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  45
  46 /**
  47  * Transform between FlatBatch API and meter batch API.
  48  */
  49 public class FlatBatchMeterAdapters {
  50
  51     private FlatBatchMeterAdapters() {
  52         throw new IllegalStateException("This class should not be instantiated.");
  53     }
  54
  55     /**
  56      * @param planStep batch step containing changes of the same type
  57      * @param node     pointer for RPC routing
  58      * @return input suitable for {@link org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.SalMetersBatchService#addMetersBatch(AddMetersBatchInput)}
  59      */
  60     public static AddMetersBatchInput adaptFlatBatchAddMeter(final BatchPlanStep planStep, final NodeRef node) {
  61         final List<BatchAddMeters> batchMeters = new ArrayList<>();
  62         for (FlatBatchAddMeter batchAddMeter : planStep.<FlatBatchAddMeter>getTaskBag()) {
  63             final BatchAddMeters addMeters = new BatchAddMetersBuilder(batchAddMeter)
  64                     .setMeterId(batchAddMeter.getMeterId())
  65                     .build();
  66             batchMeters.add(addMeters);
  67         }
  68
  69         return new AddMetersBatchInputBuilder()
  70                 .setBarrierAfter(planStep.isBarrierAfter())
  71                 .setNode(node)
  72                 .setBatchAddMeters(batchMeters)
  73                 .build();
  74     }
  75
  76     /**
  77      * @param planStep batch step containing changes of the same type
  78      * @param node     pointer for RPC routing
  79      * @return input suitable for {@link org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.SalMetersBatchService#removeMetersBatch(RemoveMetersBatchInput)}
  80      */
  81     public static RemoveMetersBatchInput adaptFlatBatchRemoveMeter(final BatchPlanStep planStep, final NodeRef node) {
  82         final List<BatchRemoveMeters> batchMeters = new ArrayList<>();
  83         for (FlatBatchRemoveMeter batchRemoveMeter : planStep.<FlatBatchRemoveMeter>getTaskBag()) {
  84             final BatchRemoveMeters removeMeters = new BatchRemoveMetersBuilder(batchRemoveMeter)
  85                     .setMeterId(batchRemoveMeter.getMeterId())
  86                     .build();
  87             batchMeters.add(removeMeters);
  88         }
  89
  90         return new RemoveMetersBatchInputBuilder()
  91                 .setBarrierAfter(planStep.isBarrierAfter())
  92                 .setNode(node)
  93                 .setBatchRemoveMeters(batchMeters)
  94                 .build();
  95     }
  96
  97     /**
  98      * @param planStep batch step containing changes of the same type
  99      * @param node     pointer for RPC routing
 100      * @return input suitable for {@link org.opendaylight.yang.gen.v1.urn.opendaylight.meters.service.rev160316.SalMetersBatchService#updateMetersBatch(UpdateMetersBatchInput)}
 101      */
 102     public static UpdateMetersBatchInput adaptFlatBatchUpdateMeter(final BatchPlanStep planStep, final NodeRef node) {
 103         final List<BatchUpdateMeters> batchMeters = new ArrayList<>();
 104         for (FlatBatchUpdateMeter batchUpdateMeter : planStep.<FlatBatchUpdateMeter>getTaskBag()) {
 105             final BatchUpdateMeters updateMeters = new BatchUpdateMetersBuilder(batchUpdateMeter)
 106                     .build();
 107             batchMeters.add(updateMeters);
 108         }
 109
 110         return new UpdateMetersBatchInputBuilder()
 111                 .setBarrierAfter(planStep.isBarrierAfter())
 112                 .setNode(node)
 113                 .setBatchUpdateMeters(batchMeters)
 114                 .build();
 115     }
 116
 117     /**
 118      * @param stepOffset offset of current batch plan step
 119      * @return converted {@link ProcessFlatBatchOutput} RPC result
 120      */
 121     @VisibleForTesting
 122     static <T extends BatchMeterOutputListGrouping> Function<RpcResult<T>, RpcResult<ProcessFlatBatchOutput>>
 123     convertBatchMeterResult(final int stepOffset) {
 124         return new Function<RpcResult<T>, RpcResult<ProcessFlatBatchOutput>>() {
 125             @Nullable
 126             @Override
 127             public RpcResult<ProcessFlatBatchOutput> apply(@Nullable final RpcResult<T> input) {
 128                 List<BatchFailure> batchFailures = wrapBatchMeterFailuresForFlat(input, stepOffset);
 129                 ProcessFlatBatchOutputBuilder outputBuilder = new ProcessFlatBatchOutputBuilder().setBatchFailure(batchFailures);
 130                 return RpcResultBuilder.<ProcessFlatBatchOutput>status(input.isSuccessful())
 131                         .withRpcErrors(input.getErrors())
 132                         .withResult(outputBuilder.build())
 133                         .build();
 134             }
 135         };
 136     }
 137
 138     private static <T extends BatchMeterOutputListGrouping> List<BatchFailure> wrapBatchMeterFailuresForFlat(
 139             final RpcResult<T> input, final int stepOffset) {
 140         final List<BatchFailure> batchFailures = new ArrayList<>();
 141         if (input.getResult().getBatchFailedMetersOutput() != null) {
 142             for (BatchFailedMetersOutput stepOutput : input.getResult().getBatchFailedMetersOutput()) {
 143                 final BatchFailure batchFailure = new BatchFailureBuilder()
 144                         .setBatchOrder(stepOffset + stepOutput.getBatchOrder())
 145                         .setBatchItemIdChoice(new FlatBatchFailureMeterIdCaseBuilder()
 146                                 .setMeterId(stepOutput.getMeterId())
 147                                 .build())
 148                         .build();
 149                 batchFailures.add(batchFailure);
 150             }
 151         }
 152         return batchFailures;
 153     }
 154
 155     /**
 156      * shortcut for {@link #convertBatchMeterResult(int)} with conversion {@link ListenableFuture}
 157      *
 158      * @param <T>                     exact type of batch flow output
 159      * @param resultUpdateMeterFuture batch group rpc-result (add/remove/update)
 160      * @param currentOffset           offset of current batch plan step with respect to entire chain of steps
 161      * @return ListenableFuture with converted result {@link ProcessFlatBatchOutput}
 162      */
 163     public static <T extends BatchMeterOutputListGrouping> ListenableFuture<RpcResult<ProcessFlatBatchOutput>>
 164     convertMeterBatchFutureForChain(final Future<RpcResult<T>> resultUpdateMeterFuture,
 165                                     final int currentOffset) {
 166         return Futures.transform(JdkFutureAdapters.listenInPoolThread(resultUpdateMeterFuture),
 167                 FlatBatchMeterAdapters.<T>convertBatchMeterResult(currentOffset));
 168     }
 169 }