2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.openflowplugin.impl.services.batch;
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;
47 * Transform between FlatBatch API and meter batch API.
49 public class FlatBatchMeterAdapters {
51 private FlatBatchMeterAdapters() {
52 throw new IllegalStateException("This class should not be instantiated.");
56 * Adapt flat batch add meter.
57 * @param planStep batch step containing changes of the same type
58 * @param node pointer for RPC routing
59 * @return input suitable for {@link org.opendaylight.yang.gen.v1.urn
60 * .opendaylight.meters.service.rev160316.SalMetersBatchService#addMetersBatch(AddMetersBatchInput)}
62 public static AddMetersBatchInput adaptFlatBatchAddMeter(final BatchPlanStep planStep, final NodeRef node) {
63 final List<BatchAddMeters> batchMeters = new ArrayList<>();
64 for (FlatBatchAddMeter batchAddMeter : planStep.<FlatBatchAddMeter>getTaskBag()) {
65 final BatchAddMeters addMeters = new BatchAddMetersBuilder(batchAddMeter)
66 .setMeterId(batchAddMeter.getMeterId())
68 batchMeters.add(addMeters);
71 return new AddMetersBatchInputBuilder()
72 .setBarrierAfter(planStep.isBarrierAfter())
74 .setBatchAddMeters(batchMeters)
79 * Adapt flat batch remove meter.
80 * @param planStep batch step containing changes of the same type
81 * @param node pointer for RPC routing
82 * @return input suitable for {@link org.opendaylight.yang.gen.v1.urn
83 * .opendaylight.meters.service.rev160316.SalMetersBatchService#removeMetersBatch(RemoveMetersBatchInput)}
85 public static RemoveMetersBatchInput adaptFlatBatchRemoveMeter(final BatchPlanStep planStep, final NodeRef node) {
86 final List<BatchRemoveMeters> batchMeters = new ArrayList<>();
87 for (FlatBatchRemoveMeter batchRemoveMeter : planStep.<FlatBatchRemoveMeter>getTaskBag()) {
88 final BatchRemoveMeters removeMeters = new BatchRemoveMetersBuilder(batchRemoveMeter)
89 .setMeterId(batchRemoveMeter.getMeterId())
91 batchMeters.add(removeMeters);
94 return new RemoveMetersBatchInputBuilder()
95 .setBarrierAfter(planStep.isBarrierAfter())
97 .setBatchRemoveMeters(batchMeters)
102 * Adapt flat batch update meter.
103 * @param planStep batch step containing changes of the same type
104 * @param node pointer for RPC routing
105 * @return input suitable for {@link org.opendaylight.yang.gen.v1.urn
106 * .opendaylight.meters.service.rev160316.SalMetersBatchService#updateMetersBatch(UpdateMetersBatchInput)}
108 public static UpdateMetersBatchInput adaptFlatBatchUpdateMeter(final BatchPlanStep planStep, final NodeRef node) {
109 final List<BatchUpdateMeters> batchMeters = new ArrayList<>();
110 for (FlatBatchUpdateMeter batchUpdateMeter : planStep.<FlatBatchUpdateMeter>getTaskBag()) {
111 final BatchUpdateMeters updateMeters = new BatchUpdateMetersBuilder(batchUpdateMeter)
113 batchMeters.add(updateMeters);
116 return new UpdateMetersBatchInputBuilder()
117 .setBarrierAfter(planStep.isBarrierAfter())
119 .setBatchUpdateMeters(batchMeters)
124 * Convert meter batch result.
125 * @param stepOffset offset of current batch plan step
126 * @return converted {@link ProcessFlatBatchOutput} RPC result
129 static <T extends BatchMeterOutputListGrouping> Function<RpcResult<T>, RpcResult<ProcessFlatBatchOutput>>
130 convertBatchMeterResult(final int stepOffset) {
131 return new Function<RpcResult<T>, RpcResult<ProcessFlatBatchOutput>>() {
134 public RpcResult<ProcessFlatBatchOutput> apply(@Nullable final RpcResult<T> input) {
135 List<BatchFailure> batchFailures = wrapBatchMeterFailuresForFlat(input, stepOffset);
136 ProcessFlatBatchOutputBuilder outputBuilder =
137 new ProcessFlatBatchOutputBuilder().setBatchFailure(batchFailures);
138 return RpcResultBuilder.<ProcessFlatBatchOutput>status(input.isSuccessful())
139 .withRpcErrors(input.getErrors())
140 .withResult(outputBuilder.build())
146 private static <T extends BatchMeterOutputListGrouping> List<BatchFailure> wrapBatchMeterFailuresForFlat(
147 final RpcResult<T> input, final int stepOffset) {
148 final List<BatchFailure> batchFailures = new ArrayList<>();
149 if (input.getResult().getBatchFailedMetersOutput() != null) {
150 for (BatchFailedMetersOutput stepOutput : input.getResult().getBatchFailedMetersOutput()) {
151 final BatchFailure batchFailure = new BatchFailureBuilder()
152 .setBatchOrder(stepOffset + stepOutput.getBatchOrder())
153 .setBatchItemIdChoice(new FlatBatchFailureMeterIdCaseBuilder()
154 .setMeterId(stepOutput.getMeterId())
157 batchFailures.add(batchFailure);
160 return batchFailures;
164 * Shortcut for {@link #convertBatchMeterResult(int)} with conversion {@link ListenableFuture}.
166 * @param <T> exact type of batch flow output
167 * @param resultUpdateMeterFuture batch group rpc-result (add/remove/update)
168 * @param currentOffset offset of current batch plan step with respect to entire chain of steps
169 * @return ListenableFuture with converted result {@link ProcessFlatBatchOutput}
171 public static <T extends BatchMeterOutputListGrouping> ListenableFuture<RpcResult<ProcessFlatBatchOutput>>
172 convertMeterBatchFutureForChain(final Future<RpcResult<T>> resultUpdateMeterFuture,
173 final int currentOffset) {
174 return Futures.transform(JdkFutureAdapters.listenInPoolThread(resultUpdateMeterFuture),
175 FlatBatchMeterAdapters.<T>convertBatchMeterResult(currentOffset));