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 com.google.common.util.concurrent.ListenableFuture;
  21 import org.eclipse.jdt.annotation.NonNull;
  22 import org.opendaylight.mdsal.binding.api.DataBroker;
  23 import org.opendaylight.mdsal.binding.api.MountPoint;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionOutput;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  26 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  27 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  28 import org.opendaylight.yangtools.yang.binding.NotificationListener;
  29 import org.opendaylight.yangtools.yang.common.RpcResult;
  30
  31 /**
  32   * Interface handling netconf connection.
  33  */
  34 public interface NetconfAccessor {
  35
  36     static String DefaultNotificationsStream = "NETCONF";
  37
  38     /**
  39      * @return the nodeId
  40      */
  41     NodeId getNodeId();
  42
  43     /**
  44      * @return NetconfNode of this connection
  45      */
  46     NetconfNode getNetconfNode();
  47
  48     /**
  49      * @return Capabilites
  50      */
  51     Capabilities getCapabilites();
  52
  53     /**
  54      * @return the dataBroker
  55      */
  56     DataBroker getDataBroker();
  57
  58     /**
  59      * @return the MDSAL Mountpoint service
  60      **/
  61     MountPoint getMountpoint();
  62
  63     /**
  64      * @Return TransAction
  65      */
  66     TransactionUtils getTransactionUtils();
  67
  68
  69     /**
  70      * Register netconf notification listener for related mountpoint
  71      *
  72      * @param <T>        specific child class of NotificationListener
  73      * @param listener   listener to be called
  74      * @return handler to manager registration
  75      */
  76     <T extends NotificationListener> ListenerRegistration<NotificationListener> doRegisterNotificationListener(
  77             @NonNull T listener);
  78
  79     /**
  80      * Register notifications stream for the connection.
  81      * @param streamName that should be "NETCONF" as default.
  82      * @return progress indication
  83      */
  84     ListenableFuture<RpcResult<CreateSubscriptionOutput>> registerNotificationsStream(String streamName);
  85
  86
  87 }