gerrit.onap Code Review - ccsdk/features.git/blob

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