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.WriteTransaction;
  17 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  18 import org.opendaylight.openflowplugin.applications.frm.ForwardingRulesManager;
  19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.Meter;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeter;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeterBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.StaleMeterKey;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.AddMeterInputBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.AddMeterOutput;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.RemoveMeterInputBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.RemoveMeterOutput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.UpdateMeterInputBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.OriginalMeterBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.UpdatedMeterBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterRef;
  37 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.common.RpcResult;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 /**
  43  * MeterForwarder It implements
  44  * {@link org.opendaylight.mdsal.binding.api.DataTreeChangeListener}
  45  * for WildCardedPath to {@link Meter} and ForwardingRulesCommiter interface for
  46  * methods: add, update and remove {@link Meter} processing for
  47  * {@link org.opendaylight.mdsal.binding.api.DataTreeModification}.
  48  *
  49  */
  50 public class MeterForwarder extends AbstractListeningCommiter<Meter> {
  51     private static final Logger LOG = LoggerFactory.getLogger(MeterForwarder.class);
  52
  53     public MeterForwarder(final ForwardingRulesManager manager, final DataBroker db,
  54                           final ListenerRegistrationHelper listenerRegistrationHelper) {
  55         super(manager, db, listenerRegistrationHelper);
  56     }
  57
  58     @Override
  59     protected InstanceIdentifier<Meter> getWildCardPath() {
  60         return InstanceIdentifier.create(Nodes.class).child(Node.class).augmentation(FlowCapableNode.class)
  61                 .child(Meter.class);
  62     }
  63
  64     @Override
  65     public void remove(final InstanceIdentifier<Meter> identifier, final Meter removeDataObj,
  66             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
  67
  68         final RemoveMeterInputBuilder builder = new RemoveMeterInputBuilder(removeDataObj);
  69
  70         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
  71         builder.setMeterRef(new MeterRef(identifier));
  72         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
  73
  74         LoggingFutures.addErrorLogging(provider.getSalMeterService().removeMeter(builder.build()), LOG,
  75             "removeMeter");
  76     }
  77
  78     @Override
  79     public Future<RpcResult<RemoveMeterOutput>> removeWithResult(final InstanceIdentifier<Meter> identifier,
  80             final Meter removeDataObj, final InstanceIdentifier<FlowCapableNode> nodeIdent) {
  81
  82         final RemoveMeterInputBuilder builder = new RemoveMeterInputBuilder(removeDataObj);
  83
  84         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
  85         builder.setMeterRef(new MeterRef(identifier));
  86         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
  87         return provider.getSalMeterService().removeMeter(builder.build());
  88     }
  89
  90     @Override
  91     public void update(final InstanceIdentifier<Meter> identifier, final Meter original, final Meter update,
  92             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
  93
  94         final UpdateMeterInputBuilder builder = new UpdateMeterInputBuilder();
  95
  96         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
  97         builder.setMeterRef(new MeterRef(identifier));
  98         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
  99         builder.setUpdatedMeter(new UpdatedMeterBuilder(update).build());
 100         builder.setOriginalMeter(new OriginalMeterBuilder(original).build());
 101
 102         LoggingFutures.addErrorLogging(provider.getSalMeterService().updateMeter(builder.build()), LOG,
 103             "updateMeter");
 104     }
 105
 106     @Override
 107     public Future<RpcResult<AddMeterOutput>> add(final InstanceIdentifier<Meter> identifier, final Meter addDataObj,
 108             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 109
 110         final AddMeterInputBuilder builder = new AddMeterInputBuilder(addDataObj);
 111
 112         builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
 113         builder.setMeterRef(new MeterRef(identifier));
 114         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
 115         return provider.getSalMeterService().addMeter(builder.build());
 116     }
 117
 118     @Override
 119     public void createStaleMarkEntity(final InstanceIdentifier<Meter> identifier, final Meter del,
 120             final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 121         LOG.debug("Creating Stale-Mark entry for the switch {} for meter {} ", nodeIdent, del);
 122         StaleMeter staleMeter = makeStaleMeter(del);
 123         persistStaleMeter(staleMeter, nodeIdent);
 124     }
 125
 126     private static StaleMeter makeStaleMeter(final Meter del) {
 127         StaleMeterBuilder staleMeterBuilder = new StaleMeterBuilder(del);
 128         return staleMeterBuilder.setMeterId(del.getMeterId()).build();
 129     }
 130
 131     private void persistStaleMeter(final StaleMeter staleMeter, final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 132         WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
 133         writeTransaction.put(LogicalDatastoreType.CONFIGURATION, getStaleMeterInstanceIdentifier(staleMeter, nodeIdent),
 134                 staleMeter);
 135
 136         FluentFuture<?> submitFuture = writeTransaction.commit();
 137         handleStaleMeterResultFuture(submitFuture);
 138     }
 139
 140     private static void handleStaleMeterResultFuture(final FluentFuture<?> submitFuture) {
 141         submitFuture.addCallback(new FutureCallback<Object>() {
 142             @Override
 143             public void onSuccess(final Object result) {
 144                 LOG.debug("Stale Meter creation success");
 145             }
 146
 147             @Override
 148             public void onFailure(final Throwable throwable) {
 149                 LOG.error("Stale Meter creation failed", throwable);
 150             }
 151         }, MoreExecutors.directExecutor());
 152     }
 153
 154     private static InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819
 155         .meters.StaleMeter> getStaleMeterInstanceIdentifier(
 156             final StaleMeter staleMeter, final InstanceIdentifier<FlowCapableNode> nodeIdent) {
 157         return nodeIdent.child(StaleMeter.class, new StaleMeterKey(new MeterId(staleMeter.getMeterId())));
 158     }
 159 }