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 /**
  19  * Convert capabilities of netconfnode into internal format. Boron and Carbon are providing
  20  * different versions
  21  */
  22 package org.onap.ccsdk.features.sdnr.wt.netconfnodestateservice;
  23
  24 import java.lang.reflect.InvocationTargetException;
  25 import java.lang.reflect.Method;
  26 import java.text.DateFormat;
  27 import java.text.SimpleDateFormat;
  28 import java.util.ArrayList;
  29 import java.util.Arrays;
  30 import java.util.Date;
  31 import java.util.List;
  32 import java.util.Optional;
  33 import javax.annotation.Nullable;
  34 import org.eclipse.jdt.annotation.NonNull;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.AvailableCapabilities;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilities;
  38 import org.opendaylight.yangtools.yang.common.QName;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 /**
  43  * Wrapper class for capabilites for Boron and later releases. Uses generics because yang model was changed from Boron
  44  * to later version. Interface class:
  45  * org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability
  46  */
  47 public class Capabilities {
  48
  49     private static final Logger LOG = LoggerFactory.getLogger(Capabilities.class);
  50
  51     private static final String METHODNAME = "getCapability";
  52     private final List<String> capabilities = new ArrayList<>();
  53     private final DateFormat formatter = new SimpleDateFormat("yyyy-MM-dd");
  54
  55     private Capabilities() {}
  56
  57     @SuppressWarnings("null")
  58     public static Capabilities getAvailableCapabilities(@Nullable NetconfNode nnode) {
  59         LOG.info("GetAvailableCapabilities for node");
  60         Capabilities capabilities = new Capabilities();
  61         if (nnode != null) {
  62             AvailableCapabilities availableCapabilites = nnode.getAvailableCapabilities();
  63             if (availableCapabilites != null) {
  64                 capabilities.constructor(availableCapabilites.getAvailableCapability());
  65             } else {
  66                 LOG.debug("empty capabilites");
  67             }
  68         } else {
  69             LOG.debug("No node provided");
  70         }
  71         return capabilities;
  72     }
  73
  74     @SuppressWarnings("null")
  75     public static Capabilities getUnavailableCapabilities(NetconfNode nnode) {
  76         LOG.info("GetAvailableCapabilities for node");
  77         Capabilities capabilities = new Capabilities();
  78         if (nnode != null) {
  79             UnavailableCapabilities availableCapabilites = nnode.getUnavailableCapabilities();
  80             if (availableCapabilites != null) {
  81                 capabilities.constructor(availableCapabilites.getUnavailableCapability());
  82             } else {
  83                 LOG.debug("empty capabilites");
  84             }
  85         } else {
  86             LOG.debug("No node provided");
  87         }
  88         return capabilities;
  89     }
  90
  91
  92     /**
  93      * Does all construction steps
  94      *
  95      * @param pcapabilities with a list of capabilities. <br>
  96      *        Type could be <br>
  97      *        - Boron: List<code><String></code> <br>
  98      *        - Carbon: List<AvailableCapability>
  99      */
 100     private void constructor(List<@NonNull ?> pcapabilities) {
 101         if (pcapabilities != null) {
 102             Method methodGetCapability;
 103
 104             for (Object capability : pcapabilities) {
 105                 if (capability instanceof String) { // ODL Boron specific
 106                     this.capabilities.add((String) capability);
 107                 } else { // Carbon specific part .. handled via generics
 108                     try {
 109                         methodGetCapability = capability.getClass().getDeclaredMethod(METHODNAME);
 110                         methodGetCapability.setAccessible(true);
 111                         this.capabilities.add(methodGetCapability.invoke(capability).toString());
 112                     } catch (NoSuchMethodException | SecurityException | IllegalAccessException
 113                             | IllegalArgumentException | InvocationTargetException e) {
 114                         LOG.warn("Capability class with missing interface method {}: {} {} {}", METHODNAME,
 115                                 e.getMessage(), capability.getClass(),
 116                                 Arrays.toString(capability.getClass().getInterfaces()));
 117                     }
 118                 }
 119             }
 120         }
 121     }
 122
 123     /**
 124      * Get Capabilites
 125      *
 126      * @return List<String> with capabilites
 127      */
 128     public List<String> getCapabilities() {
 129         return capabilities;
 130     }
 131
 132     /**
 133      * Verify if the namespace is supported
 134      *
 135      * @param qCapability from model
 136      * @return true if namespace is supported
 137      */
 138     public boolean isSupportingNamespace(QName qCapability) {
 139
 140         String namespace = qCapability.getNamespace().toString();
 141
 142         return isSupportingNamespaceAndRevision(namespace, null);
 143
 144     }
 145
 146     /**
 147      * check if the namespace and its revision are supported by the given capabilities
 148      *
 149      * @param qCapability capability from the model
 150      * @return true if supporting the model AND revision<br>
 151      *         false if revision not available or both not found.
 152      */
 153     public boolean isSupportingNamespaceAndRevision(QName qCapability) {
 154
 155         String namespace = qCapability.getNamespace().toString();
 156         String revision = getRevisionString(qCapability);
 157         return revision == null ? false : isSupportingNamespaceAndRevision(namespace, revision);
 158     }
 159
 160     /**
 161      *
 162      * @param namespace requested
 163      * @param revision request or null for any revision
 164      * @return true if existing
 165      */
 166     private boolean isSupportingNamespaceAndRevision(String namespace, @Nullable String revision) {
 167         LOG.trace("isSupportingNamespaceAndRevision: Model namespace {}?[revision {}]", namespace, revision);
 168         for (String capability : capabilities) {
 169             if (capability.contains(namespace) && (revision == null || capability.contains(revision))) {
 170                 LOG.trace("Verify true with: {}", capability);
 171                 return true;
 172             } else {
 173                 LOG.trace("Verify false with: {}", capability);
 174             }
 175         }
 176         return false;
 177     }
 178
 179     /**
 180      * Provide revision as String from QName, considering older formats.
 181      *
 182      * @param qCapability that specifies the revision
 183      * @return String with revisiondate or null
 184      */
 185     private String getRevisionString(QName qCapability) {
 186         Object revisionObject = qCapability.getRevision();
 187         String revision = null;
 188         if (revisionObject instanceof Optional) {
 189             if (((Optional<?>) revisionObject).isPresent()) {
 190                 revisionObject = ((Optional<?>) revisionObject).get();
 191                 LOG.info("Unwrapp Optional: {}", revisionObject != null ? revisionObject.getClass() : null);
 192             }
 193         }
 194         if (revisionObject == null) {
 195             // Cover null case
 196         } else if (revisionObject instanceof String) {
 197             revision = (String) revisionObject;
 198         } else if (revisionObject instanceof Date) {
 199             revision = formatter.format((Date) revisionObject);
 200         } else {
 201             revision = revisionObject.toString();
 202             LOG.debug("Revision number type not supported. Use toString().String:{} Class:{} ", revisionObject,
 203                     revisionObject.getClass().getName());
 204         }
 205         return revision;
 206     }
 207
 208     /**
 209      * Get revision of first entry of related capability
 210      *
 211      * @param qCapability that specifies the namespace
 212      * @return String with date or
 213      */
 214     public String getRevisionForNamespace(QName qCapability) {
 215         String namespace = qCapability.getNamespace().toString();
 216         for (String capability : capabilities) {
 217             if (capability.contains(namespace)) {
 218                 return QName.create(capability).getRevision().get().toString();
 219             }
 220         }
 221         return "Unsupported";
 222     }
 223
 224
 225     @Override
 226     public String toString() {
 227         return "Capabilities [capabilities=" + capabilities + "]";
 228     }
 229
 230 }