Merge "Bug 1699 - FRM: Change data change listener scope from BASE to SUBTREE"
[controller.git] / opendaylight / md-sal / forwardingrules-manager / src / main / java / org / opendaylight / controller / frm / impl / GroupForwarder.java
1 /**
2  * Copyright (c) 2014 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.controller.frm.impl;
9
10 import com.google.common.base.Preconditions;
11 import org.opendaylight.controller.frm.ForwardingRulesManager;
12 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
13 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
14 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.AddGroupInputBuilder;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.RemoveGroupInputBuilder;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.UpdateGroupInputBuilder;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.group.update.OriginalGroupBuilder;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.group.update.UpdatedGroupBuilder;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupRef;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
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.yangtools.concepts.ListenerRegistration;
29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
30 import org.slf4j.Logger;
31 import org.slf4j.LoggerFactory;
32
33 /**
34  * GroupForwarder
35  * It implements {@link org.opendaylight.controller.md.sal.binding.api.DataChangeListener}}
36  * for WildCardedPath to {@link Group} and ForwardingRulesCommiter interface for methods:
37  *  add, update and remove {@link Group} processing for
38  *  {@link org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent}.
39  *
40  * @author <a href="mailto:vdemcak@cisco.com">Vaclav Demcak</a>
41  *
42  */
43 public class GroupForwarder extends AbstractListeningCommiter<Group> {
44
45     private static final Logger LOG = LoggerFactory.getLogger(GroupForwarder.class);
46
47     private ListenerRegistration<DataChangeListener> listenerRegistration;
48
49     public GroupForwarder (final ForwardingRulesManager manager, final DataBroker db) {
50         super(manager, Group.class);
51         Preconditions.checkNotNull(db, "DataBroker can not be null!");
52         this.listenerRegistration = db.registerDataChangeListener(LogicalDatastoreType.CONFIGURATION,
53                 getWildCardPath(), GroupForwarder.this, DataChangeScope.SUBTREE);
54     }
55
56     @Override
57     public void close() {
58         if (listenerRegistration != null) {
59             try {
60                 listenerRegistration.close();
61             } catch (Exception e) {
62                 LOG.error("Error by stop FRM GroupChangeListener.", e);
63             }
64             listenerRegistration = null;
65         }
66     }
67
68     @Override
69     protected InstanceIdentifier<Group> getWildCardPath() {
70         return InstanceIdentifier.create(Nodes.class).child(Node.class)
71                 .augmentation(FlowCapableNode.class).child(Group.class);
72     }
73
74     @Override
75     public void remove(final InstanceIdentifier<Group> identifier, final Group removeDataObj,
76                        final InstanceIdentifier<FlowCapableNode> nodeIdent) {
77
78         final Group group = (removeDataObj);
79         final RemoveGroupInputBuilder builder = new RemoveGroupInputBuilder(group);
80
81         builder.setNode(new NodeRef(nodeIdent));
82         builder.setGroupRef(new GroupRef(identifier));
83         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
84         this.provider.getSalGroupService().removeGroup(builder.build());
85     }
86
87     @Override
88     public void update(final InstanceIdentifier<Group> identifier,
89                        final Group original, final Group update,
90                        final InstanceIdentifier<FlowCapableNode> nodeIdent) {
91
92         final Group originalGroup = (original);
93         final Group updatedGroup = (update);
94         final UpdateGroupInputBuilder builder = new UpdateGroupInputBuilder();
95
96         builder.setNode(new NodeRef(nodeIdent));
97         builder.setGroupRef(new GroupRef(identifier));
98         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
99         builder.setUpdatedGroup((new UpdatedGroupBuilder(updatedGroup)).build());
100         builder.setOriginalGroup((new OriginalGroupBuilder(originalGroup)).build());
101
102         this.provider.getSalGroupService().updateGroup(builder.build());
103     }
104
105     @Override
106     public void add(final InstanceIdentifier<Group> identifier, final Group addDataObj,
107                     final InstanceIdentifier<FlowCapableNode> nodeIdent) {
108
109         final Group group = (addDataObj);
110         final AddGroupInputBuilder builder = new AddGroupInputBuilder(group);
111
112         builder.setNode(new NodeRef(nodeIdent));
113         builder.setGroupRef(new GroupRef(identifier));
114         builder.setTransactionUri(new Uri(provider.getNewTransactionId()));
115         this.provider.getSalGroupService().addGroup(builder.build());
116     }
117 }
118