applications/forwardingrules-manager/src/main/java/org/opendaylight/openflowplugin/applications/frm/impl/MeterForwarder.java

   1 /*
   2  * Copyright (c) 2014, 2017 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 package org.opendaylight.openflowplugin.applications.frm.impl;
   9
  10 import com.google.common.util.concurrent.FluentFuture;
  11 import com.google.common.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.MoreExecutors;
  13 import java.util.concurrent.Future;
  14 import org.opendaylight.infrautils.utils.concurrent.LoggingFutures;
  15 import org.opendaylight.mdsal.binding.api.DataBroker;
  16 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
  17 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  18 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  19 import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeter;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeterBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeterKey;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.AddMeterInputBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.AddMeterOutput;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.RemoveMeterInputBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.RemoveMeterOutput;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.UpdateMeterInputBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.OriginalMeterBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.UpdatedMeterBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterRef;
  38 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.common.RpcResult;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 /**
  45  * MeterForwarder It implements
  46  * {@link org.opendaylight.mdsal.binding.api.DataTreeChangeListener}
  47  * for WildCardedPath to {@link Meter} and ForwardingRulesCommiter interface for
  48  * methods: add, update and remove {@link Meter} processing for
  49  * {@link org.opendaylight.mdsal.binding.api.DataTreeModification}.
  50  *
  51  */
  52 public class MeterForwarder extends AbstractListeningCommiter<Meter> {
  53
  54     private static final Logger LOG = LoggerFactory.getLogger(MeterForwarder.class);
  55     private ListenerRegistration<MeterForwarder> listenerRegistration;
  56
  57     public MeterForwarder(final ForwardingRulesManager manager, final DataBroker db) {
  58         super(manager, db);
  59     }
  60
  61     @SuppressWarnings("IllegalCatch")
  62     @Override
  63     public void registerListener() {
  64         final DataTreeIdentifier<Meter> treeId = DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
  65                 getWildCardPath());
  66
  67         try {
  68             listenerRegistration = dataBroker.registerDataTreeChangeListener(treeId, MeterForwarder.this);
  69         } catch (final Exception e) {
  70             LOG.warn("FRM Meter DataTreeChange listener registration fail!");
  71             LOG.debug("FRM Meter DataTreeChange listener registration fail ..", e);
  72             throw new IllegalStateException("MeterForwarder startup fail! System needs restart.", e);
  73         }
  74     }
  75
  76     @Override
  77     public  void deregisterListener() {
  78         close();
  79     }
  80
  81     @Override
  82     public void close() {
  83         if (listenerRegistration != null) {
  84             listenerRegistration.close();
  85             listenerRegistration = null;
  86         }
  87     }
  88
  89     @Override
  90     protected InstanceIdentifier<Meter> getWildCardPath() {
  91         return InstanceIdentifier.create(Nodes.class).child(Node.class).augmentation(FlowCapableNode.class)
  92                 .child(Meter.class);
  93     }
  94
  95     @Override
  96     public void remove(final InstanceIdentifier<Meter> identifier, final Meter removeDataObj,
  97             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
  98
  99         final RemoveMeterInputBuilder builder = new RemoveMeterInputBuilder(removeDataObj);
 100
 101         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 102         builder.setMeterRef(new MeterRef(identifier));
 103         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 104
 105         LoggingFutures.addErrorLogging(this.provider.getSalMeterService().removeMeter(builder.build()), LOG,
 106             "removeMeter");
 107     }
 108
 109     @Override
 110     public Future<RpcResult<RemoveMeterOutput>> removeWithResult(final InstanceIdentifier<Meter> identifier,
 111             final Meter removeDataObj, final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 112
 113         final RemoveMeterInputBuilder builder = new RemoveMeterInputBuilder(removeDataObj);
 114
 115         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 116         builder.setMeterRef(new MeterRef(identifier));
 117         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 118         return this.provider.getSalMeterService().removeMeter(builder.build());
 119     }
 120
 121     @Override
 122     public void update(final InstanceIdentifier<Meter> identifier, final Meter original, final Meter update,
 123             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 124
 125         final UpdateMeterInputBuilder builder = new UpdateMeterInputBuilder();
 126
 127         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 128         builder.setMeterRef(new MeterRef(identifier));
 129         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 130         builder.setUpdatedMeter(new UpdatedMeterBuilder(update).build());
 131         builder.setOriginalMeter(new OriginalMeterBuilder(original).build());
 132
 133         LoggingFutures.addErrorLogging(this.provider.getSalMeterService().updateMeter(builder.build()), LOG,
 134             "updateMeter");
 135     }
 136
 137     @Override
 138     public Future<RpcResult<AddMeterOutput>> add(final InstanceIdentifier<Meter> identifier, final Meter addDataObj,
 139             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 140
 141         final AddMeterInputBuilder builder = new AddMeterInputBuilder(addDataObj);
 142
 143         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 144         builder.setMeterRef(new MeterRef(identifier));
 145         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 146         return this.provider.getSalMeterService().addMeter(builder.build());
 147     }
 148
 149     @Override
 150     public void createStaleMarkEntity(InstanceIdentifier<Meter> identifier, Meter del,
 151             InstanceIdentifier<FlowCapableNode> nodeIdent) {
 152         LOG.debug("Creating Stale-Mark entry for the switch {} for meter {} ", nodeIdent, del);
 153         StaleMeter staleMeter = makeStaleMeter(del);
 154         persistStaleMeter(staleMeter, nodeIdent);
 155     }
 156
 157     private StaleMeter makeStaleMeter(Meter del) {
 158         StaleMeterBuilder staleMeterBuilder = new StaleMeterBuilder(del);
 159         return staleMeterBuilder.setMeterId(del.getMeterId()).build();
 160     }
 161
 162     private void persistStaleMeter(StaleMeter staleMeter, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 163         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 164         writeTransaction.put(LogicalDatastoreType.CONFIGURATION, getStaleMeterInstanceIdentifier(staleMeter, nodeIdent),
 165                 staleMeter, false);
 166
 167         FluentFuture<?> submitFuture = writeTransaction.commit();
 168         handleStaleMeterResultFuture(submitFuture);
 169     }
 170
 171     private void handleStaleMeterResultFuture(FluentFuture<?> submitFuture) {
 172         submitFuture.addCallback(new FutureCallback<Object>() {
 173             @Override
 174             public void onSuccess(Object result) {
 175                 LOG.debug("Stale Meter creation success");
 176             }
 177
 178             @Override
 179             public void onFailure(Throwable throwable) {
 180                 LOG.error("Stale Meter creation failed", throwable);
 181             }
 182         }, MoreExecutors.directExecutor());
 183     }
 184
 185     private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819
 186         .meters.StaleMeter> getStaleMeterInstanceIdentifier(
 187             StaleMeter staleMeter, InstanceIdentifier<FlowCapableNode> nodeIdent) {
 188         return nodeIdent.child(StaleMeter.class, new StaleMeterKey(new MeterId(staleMeter.getMeterId())));
 189     }
 190 }