sdnr/wt/netconfnode-state-service/model/src/main/java/org/onap/ccsdk/features/sdnr/wt/netconfnodestateservice/NetconfAccessor.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 package org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice;
  19
  20 import java.util.Optional;
  21 import org.opendaylight.mdsal.binding.api.DataBroker;
  22 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
  24 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  25
  26 /**
  27  * Interface handling netconf connection.
  28  */
  29 public interface NetconfAccessor {
  30
  31     static String DefaultNotificationsStream = "NETCONF";
  32
  33     /**
  34      * @return the Controller DataBroker
  35      */
  36     DataBroker getControllerBindingDataBroker();
  37
  38     /**
  39      * @return the Controller DOMDataBroker
  40      */
  41     DOMDataBroker getControllerDOMDataBroker();
  42
  43     /**
  44      * @return the nodeId
  45      */
  46     NodeId getNodeId();
  47
  48     /**
  49      * @return NetconfNode of this connection
  50      */
  51     NetconfNode getNetconfNode();
  52
  53     /**
  54      * @return Capabilites
  55      */
  56     Capabilities getCapabilites();
  57
  58     /**
  59      * check if the device supports RFC5277  {@code urn:ietf:params:netconf:capability:notification:1.0}
  60      * @see <a href="https://tools.ietf.org/html/rfc5277">https://tools.ietf.org/html/rfc5277#page-5</a>
  61      * @return true notifications is supported in the capabilities
  62      */
  63     boolean isNotificationsRFC5277Supported();
  64
  65     /**
  66      * Get extended accessor using MDSAL Binding API
  67      * @return binding Accessor
  68      */
  69     Optional<NetconfBindingAccessor> getNetconfBindingAccessor();
  70
  71     /**
  72      * Get extended accessor using MDSAL DOM API
  73      *
  74      * @return DOM Accessor
  75      */
  76     Optional<NetconfDomAccessor> getNetconfDomAccessor();
  77 }