pcep/topology/topology-provider/src/main/java/org/opendaylight/bgpcep/pcep/topology/provider/TopologySessionStatsRegistry.java

   1 /*
   2  * Copyright (c) 2017 AT&T Intellectual Property. 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.bgpcep.pcep.topology.provider;
   9
  10 import org.eclipse.jdt.annotation.NonNull;
  11 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.PcepSessionState;
  12 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  13 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  14 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  15
  16 /**
  17  * Topology Node Sessions stats handler. Will store Session stats on DS per each Topology Node registered.
  18  */
  19 interface TopologySessionStatsRegistry {
  20     /**
  21      * Register session to Session stats Registry handler.
  22      *
  23      * @param nodeId       Identifier of the topology node where it will be stored session stats under DS
  24      * @param sessionState containing all Stats Session information
  25      */
  26     void bind(@NonNull KeyedInstanceIdentifier<Node, NodeKey> nodeId, @NonNull PcepSessionState sessionState);
  27
  28     /**
  29      * Unregister Node from Stats Registry handler.
  30      *
  31      * @param nodeId Identifier of the topology node to be removed from registry
  32      */
  33     void unbind(@NonNull KeyedInstanceIdentifier<Node, NodeKey> nodeId);
  34 }