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 static final String UNSUPPORTED = "Unsupported";
  53     private final List<String> capabilities = new ArrayList<>();
  54     private final DateFormat formatter = new SimpleDateFormat("yyyy-MM-dd");
  55
  56     private Capabilities() {}
  57
  58     @SuppressWarnings("null")
  59     public static Capabilities getAvailableCapabilities(@Nullable NetconfNode nnode) {
  60         LOG.info("GetAvailableCapabilities for node");
  61         Capabilities capabilities = new Capabilities();
  62         if (nnode != null) {
  63             AvailableCapabilities availableCapabilites = nnode.getAvailableCapabilities();
  64             if (availableCapabilites != null) {
  65                 capabilities.constructor(availableCapabilites.getAvailableCapability());
  66             } else {
  67                 LOG.debug("empty capabilites");
  68             }
  69         } else {
  70             LOG.debug("No node provided");
  71         }
  72         return capabilities;
  73     }
  74
  75     @SuppressWarnings("null")
  76     public static Capabilities getUnavailableCapabilities(NetconfNode nnode) {
  77         LOG.info("GetUnavailableCapabilities for node");
  78         Capabilities capabilities = new Capabilities();
  79         if (nnode != null) {
  80             UnavailableCapabilities availableCapabilites = nnode.getUnavailableCapabilities();
  81             if (availableCapabilites != null) {
  82                 capabilities.constructor(availableCapabilites.getUnavailableCapability());
  83             } else {
  84                 LOG.debug("empty capabilites");
  85             }
  86         } else {
  87             LOG.debug("No node provided");
  88         }
  89         return capabilities;
  90     }
  91
  92
  93     /**
  94      * Does all construction steps
  95      *
  96      * @param pcapabilities with a list of capabilities. <br>
  97      *        Type could be <br>
  98      *        - Boron: List<code><String></code> <br>
  99      *        - Carbon: List<AvailableCapability>
 100      */
 101     private void constructor(List<@NonNull ?> pcapabilities) {
 102         if (pcapabilities != null) {
 103             Method methodGetCapability;
 104
 105             for (Object capability : pcapabilities) {
 106                 if (capability instanceof String) { // ODL Boron specific
 107                     this.capabilities.add((String) capability);
 108                 } else { // Carbon specific part .. handled via generics
 109                     try {
 110                         methodGetCapability = capability.getClass().getDeclaredMethod(METHODNAME);
 111                         methodGetCapability.setAccessible(true);
 112                         this.capabilities.add(methodGetCapability.invoke(capability).toString());
 113                     } catch (NoSuchMethodException | SecurityException | IllegalAccessException
 114                             | IllegalArgumentException | InvocationTargetException e) {
 115                         LOG.warn("Capability class with missing interface method {}: {} {} {}", METHODNAME,
 116                                 e.getMessage(), capability.getClass(),
 117                                 Arrays.toString(capability.getClass().getInterfaces()));
 118                     }
 119                 }
 120             }
 121         }
 122     }
 123
 124     /**
 125      * Get Capabilites
 126      *
 127      * @return List<String> with capabilites
 128      */
 129     public List<String> getCapabilities() {
 130         return capabilities;
 131     }
 132
 133     /**
 134      * Verify if the namespace is supported
 135      *
 136      * @param qCapability from model
 137      * @return true if namespace is supported
 138      */
 139     public boolean isSupportingNamespace(QName qCapability) {
 140
 141         String namespace = qCapability.getNamespace().toString();
 142
 143         return isSupportingNamespaceAndRevision(namespace, null);
 144
 145     }
 146
 147     /**
 148      * check if the namespace and its revision are supported by the given capabilities
 149      *
 150      * @param qCapability capability from the model
 151      * @return true if supporting the model AND revision<br>
 152      *         false if revision not available or both not found.
 153      */
 154     public boolean isSupportingNamespaceAndRevision(QName qCapability) {
 155
 156         String namespace = qCapability.getNamespace().toString();
 157         String revision = getRevisionString(qCapability);
 158         return revision == null ? false : isSupportingNamespaceAndRevision(namespace, revision);
 159     }
 160
 161     /**
 162      *
 163      * @param namespace requested
 164      * @param revision request or null for any revision
 165      * @return true if existing
 166      */
 167     private boolean isSupportingNamespaceAndRevision(String namespace, @Nullable String revision) {
 168         LOG.trace("isSupportingNamespaceAndRevision: Model namespace {}?[revision {}]", namespace, revision);
 169         for (String capability : capabilities) {
 170             if (capability.contains(namespace) && (revision == null || capability.contains(revision))) {
 171                 LOG.trace("Verify true with: {}", capability);
 172                 return true;
 173             } else {
 174                 LOG.trace("Verify false with: {}", capability);
 175             }
 176         }
 177         return false;
 178     }
 179
 180     /**
 181      * Provide revision as String from QName, considering older formats.
 182      *
 183      * @param qCapability that specifies the revision
 184      * @return String with revisiondate or null
 185      */
 186     private String getRevisionString(QName qCapability) {
 187         Object revisionObject = qCapability.getRevision();
 188         String revision = null;
 189         if (revisionObject instanceof Optional) {
 190             if (((Optional<?>) revisionObject).isPresent()) {
 191                 revisionObject = ((Optional<?>) revisionObject).get();
 192                 LOG.info("Unwrapp Optional: {}", revisionObject != null ? revisionObject.getClass() : null);
 193             }
 194         }
 195         if (revisionObject == null) {
 196             // Cover null case
 197         } else if (revisionObject instanceof String) {
 198             revision = (String) revisionObject;
 199         } else if (revisionObject instanceof Date) {
 200             revision = formatter.format((Date) revisionObject);
 201         } else {
 202             revision = revisionObject.toString();
 203             LOG.debug("Revision number type not supported. Use toString().String:{} Class:{} ", revisionObject,
 204                     revisionObject.getClass().getName());
 205         }
 206         return revision;
 207     }
 208
 209     /**
 210      * Get revision of first entry of related capability
 211      *
 212      * @param qCapability that specifies the namespace
 213      * @return String with date or
 214      */
 215     public String getRevisionForNamespace(QName qCapability) {
 216         String namespace = qCapability.getNamespace().toString();
 217         for (String capability : capabilities) {
 218             if (capability.contains(namespace)) {
 219                 return QName.create(capability).getRevision().get().toString();
 220             }
 221         }
 222         return UNSUPPORTED;
 223     }
 224
 225     /**
 226      * Verify if QName namespace is supported by capabilities
 227      * @param revision result of getRevisionForNamespace()
 228      * @return true if namespace is supported.
 229      */
 230     static public boolean isNamespaceSupported(String revision) {
 231         return revision != UNSUPPORTED;
 232     }
 233
 234     @Override
 235     public String toString() {
 236         return "Capabilities [capabilities=" + capabilities + "]";
 237     }
 238
 239 }