sdnr/wt/netconfnode-state-service/model/src/main/java/org/onap/ccsdk/features/sdnr/wt/netconfnodestateservice/NetconfNodeConnectListener.java

   1 /*******************************************************************************
   2  * ============LICENSE_START========================================================================
   3  * ONAP : ccsdk feature sdnr wt
   4  * =================================================================================================
   5  * Copyright (C) 2019 highstreet technologies GmbH Intellectual Property. All rights reserved.
   6  * =================================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
   8  * in compliance with the License. You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software distributed under the License
  13  * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
  14  * or implied. See the License for the specific language governing permissions and limitations under
  15  * the License.
  16  * ============LICENSE_END==========================================================================
  17  ******************************************************************************/
  18
  19 package org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice;
  20
  21 import java.util.EventListener;
  22
  23 import org.opendaylight.mdsal.binding.api.DataBroker;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  25 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  26
  27 /**
  28  *  Indicate if device is connected or not.
  29  *  A NetconfNode (Mountpoint) is providing the status.
  30  *  If this is Master and connected, this function is calles.
  31  */
  32
  33 public interface NetconfNodeConnectListener extends EventListener, AutoCloseable {
  34
  35         /**
  36          * Called if device state changes to "connected" for a netconf master node.
  37          * @param nNodeId name of mount point
  38          * @param netconfNode with related information
  39          * @param netconfNodeDataBroker to access connected netconf device
  40          */
  41         public void onEnterConnected(NodeId nNodeId, NetconfNode netconfNode, DataBroker netconfNodeDataBroker);
  42
  43         /**
  44          * Notify of device state change to "not connected" mount point supervision.
  45          * HINT: This callback could be called multiple times also the onEnterConnected state was not called.
  46          * @param nNodeId name of mount point
  47          */
  48         public void onLeaveConnected(NodeId nNodeId);
  49
  50 }