2 * Copyright (c) 2014, 2017 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
8 package org.opendaylight.openflowplugin.applications.frm.impl;
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.JdkFutures;
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.UpdateMeterOutput;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.OriginalMeterBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.UpdatedMeterBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterRef;
39 import org.opendaylight.yangtools.concepts.ListenerRegistration;
40 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
41 import org.opendaylight.yangtools.yang.common.RpcResult;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
46 * MeterForwarder It implements
47 * {@link org.opendaylight.mdsal.binding.api.DataTreeChangeListener}
48 * for WildCardedPath to {@link Meter} and ForwardingRulesCommiter interface for
49 * methods: add, update and remove {@link Meter} processing for
50 * {@link org.opendaylight.mdsal.binding.api.DataTreeModification}.
53 public class MeterForwarder extends AbstractListeningCommiter<Meter> {
55 private static final Logger LOG = LoggerFactory.getLogger(MeterForwarder.class);
56 private ListenerRegistration<MeterForwarder> listenerRegistration;
58 public MeterForwarder(final ForwardingRulesManager manager, final DataBroker db) {
62 @SuppressWarnings("IllegalCatch")
64 public void registerListener() {
65 final DataTreeIdentifier<Meter> treeId = DataTreeIdentifier.create(LogicalDatastoreType.CONFIGURATION,
69 listenerRegistration = dataBroker.registerDataTreeChangeListener(treeId, MeterForwarder.this);
70 } catch (final Exception e) {
71 LOG.warn("FRM Meter DataTreeChange listener registration fail!");
72 LOG.debug("FRM Meter DataTreeChange listener registration fail ..", e);
73 throw new IllegalStateException("MeterForwarder startup fail! System needs restart.", e);
78 public void deregisterListener() {
84 if (listenerRegistration != null) {
85 listenerRegistration.close();
86 listenerRegistration = null;
91 protected InstanceIdentifier<Meter> getWildCardPath() {
92 return InstanceIdentifier.create(Nodes.class).child(Node.class).augmentation(FlowCapableNode.class)
97 public void remove(final InstanceIdentifier<Meter> identifier, final Meter removeDataObj,
98 final InstanceIdentifier<FlowCapableNode> nodeIdent) {
100 final RemoveMeterInputBuilder builder = new RemoveMeterInputBuilder(removeDataObj);
102 builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
103 builder.setMeterRef(new MeterRef(identifier));
104 builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
106 final Future<RpcResult<RemoveMeterOutput>> resultFuture =
107 this.provider.getSalMeterService().removeMeter(builder.build());
108 JdkFutures.addErrorLogging(resultFuture, LOG, "removeMeter");
112 public Future<RpcResult<RemoveMeterOutput>> removeWithResult(final InstanceIdentifier<Meter> identifier,
113 final Meter removeDataObj, final InstanceIdentifier<FlowCapableNode> nodeIdent) {
115 final RemoveMeterInputBuilder builder = new RemoveMeterInputBuilder(removeDataObj);
117 builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
118 builder.setMeterRef(new MeterRef(identifier));
119 builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
120 return this.provider.getSalMeterService().removeMeter(builder.build());
124 public void update(final InstanceIdentifier<Meter> identifier, final Meter original, final Meter update,
125 final InstanceIdentifier<FlowCapableNode> nodeIdent) {
127 final UpdateMeterInputBuilder builder = new UpdateMeterInputBuilder();
129 builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
130 builder.setMeterRef(new MeterRef(identifier));
131 builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
132 builder.setUpdatedMeter(new UpdatedMeterBuilder(update).build());
133 builder.setOriginalMeter(new OriginalMeterBuilder(original).build());
135 final Future<RpcResult<UpdateMeterOutput>> resultFuture =
136 this.provider.getSalMeterService().updateMeter(builder.build());
137 JdkFutures.addErrorLogging(resultFuture, LOG, "updateMeter");
141 public Future<RpcResult<AddMeterOutput>> add(final InstanceIdentifier<Meter> identifier, final Meter addDataObj,
142 final InstanceIdentifier<FlowCapableNode> nodeIdent) {
144 final AddMeterInputBuilder builder = new AddMeterInputBuilder(addDataObj);
146 builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
147 builder.setMeterRef(new MeterRef(identifier));
148 builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
149 return this.provider.getSalMeterService().addMeter(builder.build());
153 public void createStaleMarkEntity(InstanceIdentifier<Meter> identifier, Meter del,
154 InstanceIdentifier<FlowCapableNode> nodeIdent) {
155 LOG.debug("Creating Stale-Mark entry for the switch {} for meter {} ", nodeIdent.toString(), del.toString());
156 StaleMeter staleMeter = makeStaleMeter(del);
157 persistStaleMeter(staleMeter, nodeIdent);
160 private StaleMeter makeStaleMeter(Meter del) {
161 StaleMeterBuilder staleMeterBuilder = new StaleMeterBuilder(del);
162 return staleMeterBuilder.setMeterId(del.getMeterId()).build();
165 private void persistStaleMeter(StaleMeter staleMeter, InstanceIdentifier<FlowCapableNode> nodeIdent) {
166 WriteTransaction writeTransaction = dataBroker.newWriteOnlyTransaction();
167 writeTransaction.put(LogicalDatastoreType.CONFIGURATION, getStaleMeterInstanceIdentifier(staleMeter, nodeIdent),
170 FluentFuture<?> submitFuture = writeTransaction.commit();
171 handleStaleMeterResultFuture(submitFuture);
174 private void handleStaleMeterResultFuture(FluentFuture<?> submitFuture) {
175 submitFuture.addCallback(new FutureCallback<Object>() {
177 public void onSuccess(Object result) {
178 LOG.debug("Stale Meter creation success");
182 public void onFailure(Throwable throwable) {
183 LOG.error("Stale Meter creation failed {}", throwable);
185 }, MoreExecutors.directExecutor());
188 private InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819
189 .meters.StaleMeter> getStaleMeterInstanceIdentifier(
190 StaleMeter staleMeter, InstanceIdentifier<FlowCapableNode> nodeIdent) {
191 return nodeIdent.child(StaleMeter.class, new StaleMeterKey(new MeterId(staleMeter.getMeterId())));