src/main/java/org/onap/aai/babel/xml/generator/model/Widget.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2018 European Software Marketing Ltd.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21 package org.onap.aai.babel.xml.generator.model;
  22
  23 import java.lang.reflect.InvocationTargetException;
  24 import java.util.Collection;
  25 import java.util.Collections;
  26 import java.util.EnumMap;
  27 import java.util.HashSet;
  28 import java.util.Properties;
  29 import java.util.Set;
  30 import org.onap.aai.babel.logging.ApplicationMsgs;
  31 import org.onap.aai.babel.logging.LogHelper;
  32 import org.onap.aai.babel.xml.generator.data.ArtifactType;
  33 import org.onap.aai.babel.xml.generator.data.WidgetConfigurationUtil;
  34 import org.onap.aai.babel.xml.generator.error.IllegalAccessException;
  35 import org.onap.aai.babel.xml.generator.types.ModelType;
  36 import org.onap.aai.babel.xml.generator.types.ModelWidget;
  37 import org.onap.aai.cl.api.Logger;
  38
  39 public abstract class Widget extends Model {
  40
  41     public static final String GENERATOR_AAI_CONFIGLPROP_NOT_FOUND = "Cannot generate artifacts. Widget configuration not found for %s";
  42
  43     public enum Type {
  44         SERVICE, VF, VFC, VSERVER, VOLUME, FLAVOR, TENANT, VOLUME_GROUP, LINT, L3_NET, VFMODULE, IMAGE, OAM_NETWORK, ALLOTTED_RESOURCE, TUNNEL_XCONNECT, CONFIGURATION, CR;
  45     }
  46
  47     private static Logger log = LogHelper.INSTANCE;
  48
  49     private Set<String> keys = new HashSet<>();
  50
  51     private static EnumMap<Widget.Type, Class<? extends Widget>> typeToWidget = new EnumMap<>(Widget.Type.class);
  52     static {
  53         typeToWidget.put(Type.SERVICE, ServiceWidget.class);
  54         typeToWidget.put(Type.VF, VfWidget.class);
  55         typeToWidget.put(Type.VFC, VfcWidget.class);
  56         typeToWidget.put(Type.VSERVER, VServerWidget.class);
  57         typeToWidget.put(Type.VOLUME, VolumeWidget.class);
  58         typeToWidget.put(Type.FLAVOR, FlavorWidget.class);
  59         typeToWidget.put(Type.TENANT, TenantWidget.class);
  60         typeToWidget.put(Type.VOLUME_GROUP, VolumeGroupWidget.class);
  61         typeToWidget.put(Type.LINT, LIntfWidget.class);
  62         typeToWidget.put(Type.L3_NET, L3NetworkWidget.class);
  63         typeToWidget.put(Type.VFMODULE, VfModuleWidget.class);
  64         typeToWidget.put(Type.IMAGE, ImageWidget.class);
  65         typeToWidget.put(Type.OAM_NETWORK, OamNetwork.class);
  66         typeToWidget.put(Type.ALLOTTED_RESOURCE, AllotedResourceWidget.class);
  67         typeToWidget.put(Type.TUNNEL_XCONNECT, TunnelXconnectWidget.class);
  68         typeToWidget.put(Type.CONFIGURATION, ConfigurationWidget.class);
  69         typeToWidget.put(Type.CR, CRWidget.class);
  70     }
  71
  72     /**
  73      * Gets widget.
  74      *
  75      * @param type
  76      *            the type
  77      * @return the widget
  78      */
  79     public static Widget getWidget(Type type) {
  80         Widget widget = null;
  81         Class<? extends Widget> clazz = typeToWidget.get(type);
  82         if (clazz != null) {
  83             try {
  84                 widget = clazz.getConstructor().newInstance();
  85             } catch (InstantiationException | java.lang.IllegalAccessException | IllegalArgumentException
  86                     | InvocationTargetException | NoSuchMethodException | SecurityException e) {
  87                 log.error(ApplicationMsgs.INVALID_CSAR_FILE, e);
  88             }
  89         }
  90         return widget;
  91     }
  92
  93     public String getId() {
  94         Properties properties = WidgetConfigurationUtil.getConfig();
  95         String id = properties.getProperty(ArtifactType.AAI.name() + ".model-version-id." + getName());
  96         if (id == null) {
  97             throw new IllegalArgumentException(String.format(GENERATOR_AAI_CONFIGLPROP_NOT_FOUND,
  98                     ArtifactType.AAI.name() + ".model-version-id." + getName()));
  99         }
 100         return id;
 101     }
 102
 103     public ModelType getType() {
 104         ModelWidget widgetModel = this.getClass().getAnnotation(ModelWidget.class);
 105         return widgetModel.type();
 106     }
 107
 108     public String getName() {
 109         ModelWidget widgetModel = this.getClass().getAnnotation(ModelWidget.class);
 110         return widgetModel.name();
 111     }
 112
 113     /**
 114      * Get Widget Id from properties file.
 115      *
 116      * @return - Widget Id
 117      */
 118     @Override
 119     public String getWidgetId() {
 120         Properties properties = WidgetConfigurationUtil.getConfig();
 121         String id = properties.getProperty(ArtifactType.AAI.name() + ".model-invariant-id." + getName());
 122         if (id == null) {
 123             throw new IllegalArgumentException(String.format(GENERATOR_AAI_CONFIGLPROP_NOT_FOUND,
 124                     ArtifactType.AAI.name() + ".model-invariant-id." + getName()));
 125         }
 126         return id;
 127     }
 128
 129     @Override
 130     public int hashCode() {
 131         return getId().hashCode();
 132     }
 133
 134     @Override
 135     public Type getWidgetType() {
 136         return null;
 137     }
 138
 139     /**
 140      * Equals method that compares Widget IDs.
 141      *
 142      * @param obj
 143      *            the Widget object to compare
 144      * @return whether or not obj is equal to this Widget
 145      */
 146     @Override
 147     public boolean equals(Object obj) {
 148         boolean isEqual = false;
 149         if (obj instanceof Widget) {
 150             Widget other = (Widget) obj;
 151             if (getId().equals(other.getId())) {
 152                 other.keys.addAll(this.keys);
 153                 isEqual = true;
 154             }
 155         }
 156         return isEqual;
 157     }
 158
 159     public void addKey(String key) {
 160         this.keys.add(key);
 161     }
 162
 163     /**
 164      * Determine whether one or more keys belonging to this Widget appear in the specified Collection.
 165      *
 166      * @param keys
 167      *            the keys
 168      * @return the boolean
 169      */
 170     public boolean memberOf(Collection<String> keys) {
 171         if (keys == null) {
 172             return false;
 173         }
 174         return !Collections.disjoint(this.keys, keys);
 175     }
 176
 177     @Override
 178     public boolean addResource(Resource resource) {
 179         throw new IllegalAccessException(Model.GENERATOR_AAI_ERROR_UNSUPPORTED_WIDGET_OPERATION);
 180     }
 181
 182     @Override
 183     public boolean addWidget(Widget widget) {
 184         return true;
 185     }
 186
 187 }