aboutsummaryrefslogtreecommitdiffstats
path: root/sdnr/wt/netconfnode-state-service/model/src/main/java/org/onap/ccsdk/features/sdnr/wt/netconfnodestateservice/NetconfAccessor.java
blob: 377438f58e94e30751d7aeea7bb0f5b975aaaab5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
/*
 * ============LICENSE_START========================================================================
 * ONAP : ccsdk feature sdnr wt
 * =================================================================================================
 * Copyright (C) 2019 highstreet technologies GmbH Intellectual Property. All rights reserved.
 * =================================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 * ============LICENSE_END==========================================================================
 */
package org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice;

import java.util.Optional;
import org.opendaylight.mdsal.binding.api.DataBroker;
import org.opendaylight.mdsal.dom.api.DOMDataBroker;
import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;

/**
 * Interface handling netconf connection.
 */
public interface NetconfAccessor {

    static String DefaultNotificationsStream = "NETCONF";

    /**
     * @return the Controller DataBroker
     */
    DataBroker getControllerBindingDataBroker();

    /**
     * @return the Controller DOMDataBroker
     */
    DOMDataBroker getControllerDOMDataBroker();

    /**
     * @return the nodeId
     */
    NodeId getNodeId();

    /**
     * @return NetconfNode of this connection
     */
    NetconfNode getNetconfNode();

    /**
     * @return Capabilites
     */
    Capabilities getCapabilites();

    /**
     * check if the device supports RFC5277  {@code urn:ietf:params:netconf:capability:notification:1.0}
     * @see <a href="https://tools.ietf.org/html/rfc5277">https://tools.ietf.org/html/rfc5277#page-5</a>
     * @return true notifications is supported in the capabilities
     */
    boolean isNotificationsRFC5277Supported();

    /**
     * Get extended accessor using MDSAL Binding API
     * @return binding Accessor
     */
    Optional<NetconfBindingAccessor> getNetconfBindingAccessor();

    /**
     * Get extended accessor using MDSAL DOM API
     *
     * @return DOM Accessor
     */
    Optional<NetconfDomAccessor> getNetconfDomAccessor();
}