sdnr/wt/netconfnode-state-service/model/src/main/java/org/onap/ccsdk/features/sdnr/wt/netconfnodestateservice/NetconfBindingAccessor.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 com.google.common.util.concurrent.ListenableFuture;
  21 import java.util.List;
  22 import org.eclipse.jdt.annotation.NonNull;
  23 import org.opendaylight.mdsal.binding.api.DataBroker;
  24 import org.opendaylight.mdsal.binding.api.MountPoint;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionOutput;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.streams.Stream;
  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 NetconfBindingAccessor extends NetconfAccessor {
  35
  36     /**
  37      * @return the dataBroker
  38      */
  39     DataBroker getDataBroker();
  40
  41     /**
  42      * @return the MDSAL Mountpoint service
  43      **/
  44     MountPoint getMountpoint();
  45
  46     /**
  47      * Get handler for read/write
  48      * @Return Transaction
  49      */
  50     TransactionUtils getTransactionUtils();
  51
  52     /**
  53      * Get all notification streams
  54      * @return stream list
  55      */
  56     List<Stream> getNotificationStreams();
  57
  58     /**
  59      * Register notifications stream for the connection
  60      *
  61      * @param streamList that contains a list of streams to be subscribed for notifications
  62      * @return progress indication
  63      */
  64     void registerNotificationsStream(List<Stream> streamList);
  65
  66     /**
  67      * Register default notifications stream for the connection.
  68      * @See <a href="https://tools.ietf.org/html/rfc5277">https://tools.ietf.org/html/rfc5277</a>
  69      *
  70      * @return progress indication
  71      */
  72     ListenableFuture<RpcResult<CreateSubscriptionOutput>> registerNotificationsStream();
  73
  74     /**
  75      * Register specific notifications stream for the connection.
  76      * @See <a href="https://tools.ietf.org/html/rfc5277">https://tools.ietf.org/html/rfc5277</a>
  77      *
  78      * @param streamName that should be "NETCONF" as default.
  79      * @return progress indication
  80      */
  81     ListenableFuture<RpcResult<CreateSubscriptionOutput>> registerNotificationsStream(String streamName);
  82
  83     /**
  84      * Register netconf notification listener for related mountpoint
  85      *
  86      * @param <T> specific child class of NotificationListener
  87      * @param listener listener to be called
  88      * @return handler to manager registration
  89      */
  90     <T extends NotificationListener> ListenerRegistration<NotificationListener> doRegisterNotificationListener(
  91             @NonNull T listener);
  92
  93
  94 }