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