openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/statistics/services/compatibility/AbstractCompatibleStatService.java

   1 /*
   2  * Copyright (c) 2015 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.statistics.services.compatibility;
  10
  11 import com.google.common.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.Futures;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import java.math.BigInteger;
  15 import java.util.List;
  16 import java.util.concurrent.atomic.AtomicLong;
  17 import javax.annotation.Nullable;
  18 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  19 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  20 import org.opendaylight.openflowplugin.api.openflow.device.RequestContextStack;
  21 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
  22 import org.opendaylight.openflowplugin.api.openflow.statistics.compatibility.BackwardCompatibleAtomicService;
  23 import org.opendaylight.openflowplugin.impl.services.AbstractMultipartService;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionId;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  26 import org.opendaylight.yangtools.yang.binding.DataContainer;
  27 import org.opendaylight.yangtools.yang.binding.Notification;
  28 import org.opendaylight.yangtools.yang.common.RpcResult;
  29 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 /**
  34  * pulled up common functionality of notification emitting stats services (backward compatibility relic)
  35  */
  36 public abstract class AbstractCompatibleStatService<I extends DataContainer, O, N extends Notification> extends AbstractMultipartService<I, MultipartReply> implements BackwardCompatibleAtomicService<I, O> {
  37
  38     private static final Logger LOG = LoggerFactory.getLogger(AbstractCompatibleStatService.class);
  39
  40     private final AtomicLong compatibilityXidSeed;
  41     private final OpenflowVersion ofVersion;
  42
  43     public AbstractCompatibleStatService(RequestContextStack requestContextStack, DeviceContext deviceContext, AtomicLong compatibilityXidSeed) {
  44         super(requestContextStack, deviceContext);
  45         this.compatibilityXidSeed = compatibilityXidSeed;
  46         ofVersion = OpenflowVersion.get(getVersion());
  47     }
  48
  49     public OpenflowVersion getOfVersion() {
  50         return ofVersion;
  51     }
  52
  53     @Override
  54     public ListenableFuture<RpcResult<O>> handleAndNotify(final I input, final NotificationPublishService notificationPublishService) {
  55         // prepare emulated xid
  56         final long emulatedXid = compatibilityXidSeed.incrementAndGet();
  57         final TransactionId emulatedTxId = new TransactionId(BigInteger.valueOf(emulatedXid));
  58
  59         // do real processing
  60         final ListenableFuture<RpcResult<List<MultipartReply>>> rpcResultListenableFuture = handleServiceCall(input);
  61
  62         // hook notification publishing
  63         Futures.addCallback(rpcResultListenableFuture, new FutureCallback<RpcResult<List<MultipartReply>>>() {
  64             @Override
  65             public void onSuccess(@Nullable RpcResult<List<MultipartReply>> result) {
  66                 if (result != null && result.isSuccessful()) {
  67                     // transform rpc result (raw multipart) to notification
  68                     final N flowNotification = transformToNotification(result.getResult(), emulatedTxId);
  69                     notificationPublishService.offerNotification(flowNotification);
  70                 } else {
  71                     LOG.debug("compatibility callback failed - NOT emitting notification: {}", input.getClass().getSimpleName());
  72                 }
  73             }
  74
  75             @Override
  76             public void onFailure(Throwable t) {
  77                 LOG.debug("compatibility callback crashed - NOT emitting notification: {}", input.getClass().getSimpleName(), t);
  78             }
  79         });
  80
  81         return RpcResultBuilder.<O>success(buildTxCapableResult(emulatedTxId)).buildFuture();
  82     }
  83
  84     public abstract O buildTxCapableResult(TransactionId emulatedTxId);
  85
  86     public abstract N transformToNotification(List<MultipartReply> result, TransactionId emulatedTxId);
  87 }