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

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2019 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2019 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.util.Collection;
  24 import java.util.Collections;
  25 import java.util.HashSet;
  26 import java.util.Map;
  27 import java.util.Properties;
  28 import java.util.Set;
  29 import org.onap.aai.babel.xml.generator.XmlArtifactGenerationException;
  30 import org.onap.aai.babel.xml.generator.data.ArtifactType;
  31 import org.onap.aai.babel.xml.generator.data.WidgetConfigurationUtil;
  32 import org.onap.aai.babel.xml.generator.error.IllegalAccessException;
  33 import org.onap.aai.babel.xml.generator.types.ModelType;
  34
  35 public class Widget extends Model {
  36
  37     public static final String GENERATOR_AAI_CONFIGLPROP_NOT_FOUND =
  38             "Cannot generate artifacts. Widget configuration not found for %s";
  39
  40     public enum Type {
  41         SERVICE, VF, VFC, VSERVER, VOLUME, FLAVOR, TENANT, VOLUME_GROUP, LINT, L3_NET, VFMODULE, IMAGE, OAM_NETWORK, ALLOTTED_RESOURCE, TUNNEL_XCONNECT, CONFIGURATION, CR, INSTANCE_GROUP;
  42     }
  43
  44     private Set<String> keys = new HashSet<>();
  45
  46     protected String name;
  47     protected Type type;
  48     protected boolean deleteFlag = false;
  49
  50     public Widget(Type widgetType, String name, boolean deleteFlag) {
  51         type = widgetType;
  52         this.name = name;
  53         this.deleteFlag = deleteFlag;
  54     }
  55
  56     /**
  57      * Copy Constructor
  58      *
  59      * @param baseWidget
  60      * @throws XmlArtifactGenerationException
  61      */
  62     public Widget(Widget baseWidget) throws XmlArtifactGenerationException {
  63         this(baseWidget.getWidgetType(), baseWidget.getName(), baseWidget.getDeleteFlag());
  64         if (type == Type.VSERVER) {
  65             widgets.add(getWidget(Type.FLAVOR));
  66             widgets.add(getWidget(Type.IMAGE));
  67             widgets.add(getWidget(Type.TENANT));
  68             widgets.add(getWidget(Type.VFC));
  69         }
  70     }
  71
  72     /**
  73      * Gets widget.
  74      *
  75      * @param type
  76      *            the type
  77      * @return a new widget of the specified type
  78      * @throws XmlArtifactGenerationException
  79      *             if there is no configuration defined for the specified type
  80      */
  81     public static Widget getWidget(Type type) throws XmlArtifactGenerationException {
  82         Widget widget = WidgetConfigurationUtil.createWidgetFromType(type);
  83         if (widget == null) {
  84             throw new XmlArtifactGenerationException("No widget type is defined for " + type);
  85         }
  86         return widget;
  87     }
  88
  89     @Override
  90     public boolean isResource() {
  91         return false;
  92     }
  93
  94     public String getId() {
  95         String id = WidgetConfigurationUtil.getConfig()
  96                 .getProperty(ArtifactType.AAI.name() + ".model-version-id." + getName());
  97         if (id == null) {
  98             throw new IllegalArgumentException(String.format(GENERATOR_AAI_CONFIGLPROP_NOT_FOUND,
  99                     ArtifactType.AAI.name() + ".model-version-id." + getName()));
 100         }
 101         return id;
 102     }
 103
 104     public ModelType getType() {
 105         return ModelType.WIDGET;
 106     }
 107
 108     public String getName() {
 109         return name;
 110     }
 111
 112     /**
 113      * Get Widget Id from properties file.
 114      *
 115      * @return - Widget Id
 116      */
 117     @Override
 118     public String getWidgetId() {
 119         Properties properties = WidgetConfigurationUtil.getConfig();
 120         String id = properties.getProperty(ArtifactType.AAI.name() + ".model-invariant-id." + getName());
 121         if (id == null) {
 122             throw new IllegalArgumentException(String.format(GENERATOR_AAI_CONFIGLPROP_NOT_FOUND,
 123                     ArtifactType.AAI.name() + ".model-invariant-id." + getName()));
 124         }
 125         return id;
 126     }
 127
 128     @Override
 129     public int hashCode() {
 130         return getId().hashCode();
 131     }
 132
 133     @Override
 134     public Type getWidgetType() {
 135         return type;
 136     }
 137
 138     /**
 139      * Equals method that compares Widget IDs.
 140      *
 141      * @param obj
 142      *            the Widget object to compare
 143      * @return whether or not obj is equal to this Widget
 144      */
 145     @Override
 146     public boolean equals(Object obj) {
 147         boolean isEqual = false;
 148         if (obj instanceof Widget) {
 149             Widget other = (Widget) obj;
 150             if (getId().equals(other.getId())) {
 151                 other.keys.addAll(this.keys);
 152                 isEqual = true;
 153             }
 154         }
 155         return isEqual;
 156     }
 157
 158     public void addKey(String key) {
 159         this.keys.add(key);
 160     }
 161
 162     /**
 163      * Determine whether one or more keys belonging to this Widget appear in the specified Collection.
 164      *
 165      * @param keys
 166      *            the keys
 167      * @return the boolean
 168      */
 169     public boolean memberOf(Collection<String> keys) {
 170         if (keys == null) {
 171             return false;
 172         }
 173         return !Collections.disjoint(this.keys, keys);
 174     }
 175
 176     @Override
 177     public boolean addResource(Resource resource) {
 178         throw new IllegalAccessException(Model.GENERATOR_AAI_ERROR_UNSUPPORTED_WIDGET_OPERATION);
 179     }
 180
 181     @Override
 182     public boolean addWidget(Widget widget) {
 183         if (getWidgetType() == Type.VSERVER) {
 184             return widgets.add(widget);
 185         }
 186         return true;
 187     }
 188
 189     @Override
 190     public Map<String, Object> getProperties() {
 191         return Collections.emptyMap();
 192     }
 193
 194     @Override
 195     public String toString() {
 196         return getName() + " Widget keys=" + keys + ", resources=" + resources + ", widgets=" + widgets;
 197     }
 198
 199     @Override
 200     public boolean getDeleteFlag() {
 201         return deleteFlag;
 202     }
 203 }