applications/notification-supplier/src/main/java/org/opendaylight/openflowplugin/applications/notification/supplier/impl/AbstractNotificationSupplierBase.java

   1 /*
   2  * Copyright (c) 2015 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
   9 package org.opendaylight.openflowplugin.applications.notification.supplier.impl;
  10
  11 import com.google.common.base.Preconditions;
  12 import java.util.concurrent.Callable;
  13 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  14 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener;
  15 import org.opendaylight.controller.md.sal.binding.api.DataTreeIdentifier;
  16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  17 import org.opendaylight.openflowplugin.applications.notification.supplier.NotificationSupplierDefinition;
  18 import org.opendaylight.openflowplugin.common.wait.SimpleTaskRetryLooper;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  24 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  25 import org.opendaylight.yangtools.yang.binding.DataObject;
  26 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  27 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 /**
  32  * Public abstract basic Supplier implementation contains code for a make Supplier instance,
  33  * registration Supplier like {@link org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener}
  34  * and close method. In additional case, it contains help methods for all Supplier implementations.
  35  *
  36  * @param <O> - data tree item Object extends {@link DataObject}
  37  */
  38 public abstract class AbstractNotificationSupplierBase<O extends DataObject> implements
  39         NotificationSupplierDefinition<O> {
  40
  41     private static final Logger LOG = LoggerFactory.getLogger(AbstractNotificationSupplierBase.class);
  42
  43     protected final Class<O> clazz;
  44     private ListenerRegistration<DataTreeChangeListener<O>> listenerRegistration;
  45     private static final int STARTUP_LOOP_TICK = 500;
  46     private static final int STARTUP_LOOP_MAX_RETRIES = 8;
  47
  48
  49     final DataTreeIdentifier<O> treeId =
  50             new DataTreeIdentifier<>(LogicalDatastoreType.OPERATIONAL, getWildCardPath());
  51     /**
  52      * Default constructor for all Notification Supplier implementation
  53      *
  54      * @param db    - {@link DataBroker}
  55      * @param clazz - API contract class extended {@link DataObject}
  56      */
  57     public AbstractNotificationSupplierBase(final DataBroker db, final Class<O> clazz) {
  58         Preconditions.checkArgument(db != null, "DataBroker can not be null!");
  59         this.clazz = clazz;
  60
  61         SimpleTaskRetryLooper looper = new SimpleTaskRetryLooper(STARTUP_LOOP_TICK, STARTUP_LOOP_MAX_RETRIES);
  62         try {
  63             listenerRegistration =  looper.loopUntilNoException(new Callable<ListenerRegistration<DataTreeChangeListener<O>>>() {
  64                 @Override
  65                 public ListenerRegistration<DataTreeChangeListener<O>> call() throws Exception {
  66                     return db.registerDataTreeChangeListener(treeId, AbstractNotificationSupplierBase.this);
  67                 }
  68             });
  69         }catch(final Exception ex){
  70             LOG.debug("AbstractNotificationSupplierBase DataTreeChange listener registration fail ..{}", ex.getMessage());
  71             throw new IllegalStateException("Notification supplier startup fail! System needs restart.", ex);
  72         }
  73     }
  74
  75     @Override
  76     public void close() throws Exception {
  77         if (listenerRegistration != null) {
  78             listenerRegistration.close();
  79             listenerRegistration = null;
  80         }
  81     }
  82
  83     /**
  84      * Method returns a wildCard {@link InstanceIdentifier} for {@link Node} from inventory
  85      * because this path is a base for every OF paths.
  86      *
  87      * @return WildCarded InstanceIdentifier for Node
  88      */
  89     protected static InstanceIdentifier<Node> getNodeWildII() {
  90         return InstanceIdentifier.create(Nodes.class).child(Node.class);
  91     }
  92
  93     /**
  94      * Method returns a keyed {@link InstanceIdentifier} for {@link Node} from inventory
  95      * because this path is a base for every OF paths.
  96      *
  97      * @param ii - key for keyed {@link Node} {@link InstanceIdentifier}
  98      * @return Keyed InstanceIdentifier for Node
  99      */
 100     protected static KeyedInstanceIdentifier<Node, NodeKey> getNodeII(final InstanceIdentifier<?> ii) {
 101         final NodeKey key = ii.firstKeyOf(Node.class, NodeKey.class);
 102         Preconditions.checkArgument(key != null);
 103         return InstanceIdentifier.create(Nodes.class).child(Node.class, key);
 104     }
 105
 106     /**
 107      * @param path pointer to element
 108      * @return extracted {@link NodeKey} and wrapped in {@link NodeRef}
 109      */
 110     public static NodeRef createNodeRef(InstanceIdentifier<?> path) {
 111         final InstanceIdentifier<Node> nodePath = Preconditions.checkNotNull(path.firstIdentifierOf(Node.class));
 112         return new NodeRef(nodePath);
 113     }
 114
 115     /**
 116      * @param path pointer to element
 117      * @return extracted {@link NodeId}
 118      */
 119     public static NodeId getNodeId(InstanceIdentifier<?> path) {
 120         final NodeKey nodeKey = Preconditions.checkNotNull(path.firstKeyOf(Node.class, NodeKey.class));
 121         return nodeKey.getId();
 122     }
 123
 124 }