0eb1982b28a2846bf20a8b15818cd62207cf6be3
[ccsdk/features.git] /
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 /**
19  *
20  */
21 package org.onap.ccsdk.features.sdnr.wt.devicemanager.onf.ne;
22
23 import java.util.Optional;
24 import javax.annotation.Nonnull;
25 import org.onap.ccsdk.features.sdnr.wt.devicemanager.onf.ONFCoreNetworkElementRepresentation;
26 import org.onap.ccsdk.features.sdnr.wt.devicemanager.types.InternalConnectionStatus;
27 import org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice.Capabilities;
28 import org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice.NetconfAccessor;
29 import org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice.TransactionUtils;
30 import org.opendaylight.mdsal.binding.api.DataBroker;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
33 import org.opendaylight.yang.gen.v1.urn.onf.params.xml.ns.yang.core.model.rev170320.NetworkElement;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.Credentials;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.credentials.credentials.LoginPassword;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev190801.ConnectionLogStatus;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev190801.NetworkElementConnectionBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev190801.NetworkElementConnectionEntity;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev190801.NetworkElementDeviceType;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev190801.network.element.connection.entity.NodeDetailsBuilder;
42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
45
46 /**
47  * @author herbert
48  *
49  */
50 @SuppressWarnings("deprecation")
51 public abstract class ONFCoreNetworkElementBase implements AutoCloseable, ONFCoreNetworkElementRepresentation {
52
53     private static final Logger LOG = LoggerFactory.getLogger(ONFCoreNetworkElementBase.class);
54
55     protected static final String EMPTY = "";
56
57     private final String mountPointNodeName;
58     private final NodeId nodeId;
59     private final DataBroker netconfNodeDataBroker;
60     private final Capabilities capabilities;
61     private final NetconfAccessor acessor;
62
63     protected ONFCoreNetworkElementBase(NetconfAccessor acessor) {
64         LOG.info("Create ONFCoreNetworkElementBase");
65         this.mountPointNodeName = acessor.getNodeId().getValue();
66         this.nodeId = acessor.getNodeId();
67         this.netconfNodeDataBroker = acessor.getDataBroker();
68         this.capabilities = acessor.getCapabilites();
69         this.acessor = acessor;
70
71     }
72
73     @Override
74     public Optional<NetconfAccessor> getAcessor() {
75         return Optional.of(acessor);
76     }
77
78     @Override
79     public String getMountPointNodeName() {
80         return mountPointNodeName;
81     }
82
83     /**
84      * @return the netconfNodeDataBroker
85      */
86     public DataBroker getNetconfNodeDataBroker() {
87         return netconfNodeDataBroker;
88     }
89
90     /**
91      * @return the capabilities
92      */
93     public Capabilities getCapabilities() {
94         return capabilities;
95     }
96
97     /**
98      * Update devicetype and let all other field empty
99      * @param deviceType that should be updated
100      * @return NetworkElementConnectionEntity with related parameter
101      */
102     public static NetworkElementConnectionEntity getNetworkConnectionDeviceTpe(NetworkElementDeviceType deviceType) {
103         NetworkElementConnectionBuilder eb = new NetworkElementConnectionBuilder();
104         eb.setDeviceType(deviceType);
105         return eb.build();
106     }
107
108     /**
109      * Provide device specific data
110      * @param nodeId mountpoint id
111      * @param nNode data
112      * @return NetworkElementConnectionEntity specific information
113      */
114     public static NetworkElementConnectionEntity getNetworkConnection(String nodeId, @Nonnull NetconfNode nNode) {
115
116         NetworkElementConnectionBuilder eb = new NetworkElementConnectionBuilder();
117         // -- basics
118         eb.setId(nodeId).setNodeId(nodeId).setDeviceType(NetworkElementDeviceType.Unknown).setIsRequired(false);
119
120         // -- connection status
121         ConnectionLogStatus status = InternalConnectionStatus.statusFromNodeStatus(nNode.getConnectionStatus());
122         eb.setStatus(status);
123
124         // -- capabilites
125         Capabilities availableCapabilities = Capabilities.getAvailableCapabilities(nNode);
126         Capabilities unAvailableCapabilities = Capabilities.getUnavailableCapabilities(nNode);
127         eb.setCoreModelCapability(availableCapabilities.getRevisionForNamespace(NetworkElement.QNAME));
128
129         NodeDetailsBuilder nodeDetails = new NodeDetailsBuilder()
130                 .setAvailableCapabilities(availableCapabilities.getCapabilities())
131                 .setUnavailableCapabilities(unAvailableCapabilities.getCapabilities());
132         eb.setNodeDetails(nodeDetails.build());
133         // -- host information
134         Host host = nNode.getHost();
135         PortNumber portNumber = nNode.getPort();
136         if (host != null && portNumber != null) {
137             eb.setHost(host.stringValue()).setPort(portNumber.getValue().longValue());
138         }
139
140         Credentials credentials = nNode.getCredentials();
141         if (credentials instanceof LoginPassword) {
142             LoginPassword loginPassword = (LoginPassword) credentials;
143             eb.setUsername(loginPassword.getUsername()).setPassword(loginPassword.getPassword());
144         }
145         return eb.build();
146     }
147
148
149     @Override
150     public void warmstart() {
151         int problems = removeAllCurrentProblemsOfNode();
152         LOG.debug("Removed all {} problems from database at deregistration for {}", problems, mountPointNodeName);
153     }
154
155     @Override
156     public NodeId getNodeId() {
157         return nodeId;
158     }
159
160     public TransactionUtils getGenericTransactionUtils() {
161         return acessor.getTransactionUtils();
162     }
163
164     /*---------------------------------------------------------------
165      * Getter/ Setter
166      */
167     @Override
168     public String getMountpoint() {
169         return mountPointNodeName;
170     }
171
172     @Override
173     public DataBroker getDataBroker() {
174         return netconfNodeDataBroker;
175     }
176
177 }