2 * Copyright (c) 2014 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.controller.frm.impl;
10 import org.opendaylight.controller.frm.ForwardingRulesManager;
11 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
12 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
13 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
14 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
16 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInputBuilder;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowTableRef;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.UpdateFlowInputBuilder;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.OriginalFlowBuilder;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.UpdatedFlowBuilder;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowRef;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
30 import org.opendaylight.yangtools.concepts.ListenerRegistration;
31 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
35 import com.google.common.base.Preconditions;
39 * It implements {@link org.opendaylight.controller.md.sal.binding.api.DataChangeListener}}
40 * for WildCardedPath to {@link Flow} and ForwardingRulesCommiter interface for methods:
41 * add, update and remove {@link Flow} processing for
42 * {@link org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent}.
44 * @author <a href="mailto:vdemcak@cisco.com">Vaclav Demcak</a>
47 public class FlowForwarder extends AbstractListeningCommiter<Flow> {
49 private static final Logger LOG = LoggerFactory.getLogger(FlowForwarder.class);
51 private ListenerRegistration<DataChangeListener> listenerRegistration;
53 public FlowForwarder (final ForwardingRulesManager manager, final DataBroker db) {
54 super(manager, Flow.class);
55 Preconditions.checkNotNull(db, "DataBroker can not be null!");
56 registrationListener(db, 5);
59 private void registrationListener(final DataBroker db, int i) {
61 listenerRegistration = db.registerDataChangeListener(LogicalDatastoreType.CONFIGURATION,
62 getWildCardPath(), FlowForwarder.this, DataChangeScope.SUBTREE);
63 } catch (final Exception e) {
67 } catch (InterruptedException e1) {
68 LOG.error("Thread interrupted '{}'", e1);
69 Thread.currentThread().interrupt();
71 registrationListener(db, --i);
73 LOG.error("FRM Flow DataChange listener registration fail!", e);
74 throw new IllegalStateException("FlowForwarder registration Listener fail! System needs restart.", e);
81 if (listenerRegistration != null) {
83 listenerRegistration.close();
84 } catch (final Exception e) {
85 LOG.error("Error by stop FRM FlowChangeListener.", e);
87 listenerRegistration = null;
92 public void remove(final InstanceIdentifier<Flow> identifier,
93 final Flow removeDataObj,
94 final InstanceIdentifier<FlowCapableNode> nodeIdent) {
96 final TableKey tableKey = identifier.firstKeyOf(Table.class, TableKey.class);
97 if (tableIdValidationPrecondition(tableKey, removeDataObj)) {
98 final RemoveFlowInputBuilder builder = new RemoveFlowInputBuilder(removeDataObj);
99 builder.setFlowRef(new FlowRef(identifier));
100 builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
101 builder.setFlowTable(new FlowTableRef(nodeIdent.child(Table.class, tableKey)));
102 builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
103 provider.getSalFlowService().removeFlow(builder.build());
108 public void update(final InstanceIdentifier<Flow> identifier,
109 final Flow original, final Flow update,
110 final InstanceIdentifier<FlowCapableNode> nodeIdent) {
112 final TableKey tableKey = identifier.firstKeyOf(Table.class, TableKey.class);
113 if (tableIdValidationPrecondition(tableKey, update)) {
114 final UpdateFlowInputBuilder builder = new UpdateFlowInputBuilder();
116 builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
117 builder.setFlowRef(new FlowRef(identifier));
118 builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
119 builder.setUpdatedFlow((new UpdatedFlowBuilder(update)).build());
120 builder.setOriginalFlow((new OriginalFlowBuilder(original)).build());
122 provider.getSalFlowService().updateFlow(builder.build());
127 public void add(final InstanceIdentifier<Flow> identifier,
128 final Flow addDataObj,
129 final InstanceIdentifier<FlowCapableNode> nodeIdent) {
131 final TableKey tableKey = identifier.firstKeyOf(Table.class, TableKey.class);
132 if (tableIdValidationPrecondition(tableKey, addDataObj)) {
133 final AddFlowInputBuilder builder = new AddFlowInputBuilder(addDataObj);
135 builder.setNode(new NodeRef(nodeIdent.firstIdentifierOf(Node.class)));
136 builder.setFlowRef(new FlowRef(identifier));
137 builder.setFlowTable(new FlowTableRef(nodeIdent.child(Table.class, tableKey)));
138 builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
139 provider.getSalFlowService().addFlow(builder.build());
144 protected InstanceIdentifier<Flow> getWildCardPath() {
145 return InstanceIdentifier.create(Nodes.class).child(Node.class)
146 .augmentation(FlowCapableNode.class).child(Table.class).child(Flow.class);
149 private boolean tableIdValidationPrecondition (final TableKey tableKey, final Flow flow) {
150 Preconditions.checkNotNull(tableKey, "TableKey can not be null or empty!");
151 Preconditions.checkNotNull(flow, "Flow can not be null or empty!");
152 if (! tableKey.getId().equals(flow.getTableId())) {
153 LOG.error("TableID in URI tableId={} and in palyload tableId={} is not same.",
154 flow.getTableId(), tableKey.getId());