aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/aai/babel/xml/generator/model/Model.java
blob: 0ee08380586ea42d8f66529f918d9152dfd9ace4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
 * Copyright © 2017-2018 European Software Marketing Ltd.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */
package org.onap.aai.babel.xml.generator.model;

import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import org.onap.aai.babel.xml.generator.error.IllegalAccessException;
import org.onap.aai.babel.xml.generator.types.Cardinality;
import org.onap.aai.babel.xml.generator.types.ModelType;

public abstract class Model {
    public static final String GENERATOR_AAI_ERROR_UNSUPPORTED_WIDGET_OPERATION = "Operation Not Supported for Widgets";

    protected Set<Resource> resources = new HashSet<>();
    protected Set<Widget> widgets = new HashSet<>();
    private String modelId;
    private String modelName;
    private String modelVersion;
    private String modelNameVersionId;
    private String modelDescription;

    /**
     * Gets the object (model) corresponding to the supplied TOSCA type.
     *
     * @param toscaType the tosca type
     * @return the model for the type, or null
     */
    public static Model getModelFor(String toscaType) {
        Model modelToBeReturned = null;
        String typePrefix = toscaType;
        while (modelToBeReturned == null && typePrefix != null && typePrefix.lastIndexOf('.') != -1) {
            switch (typePrefix) {
                case "org.openecomp.resource.vf.allottedResource":
                    modelToBeReturned = new AllotedResource();
                    break;
                case "org.openecomp.resource.vfc.AllottedResource":
                    modelToBeReturned = new ProvidingService();
                    break;
                case "org.openecomp.resource.vfc":
                    modelToBeReturned = new VServerWidget();
                    break;
                case "org.openecomp.resource.cp":
                case "org.openecomp.cp":
                    modelToBeReturned = new LIntfWidget();
                    break;
                case "org.openecomp.resource.vl":
                    modelToBeReturned = new L3Network();
                    break;
                case "org.openecomp.resource.vf":
                    modelToBeReturned = new VirtualFunction();
                    break;
                case "org.openecomp.groups.vfmodule":
                case "org.openecomp.groups.VfModule":
                    modelToBeReturned = new VfModule();
                    break;
                case "org.openecomp.resource.vfc.nodes.heat.cinder":
                    modelToBeReturned = new VolumeWidget();
                    break;
                default:
                    modelToBeReturned = null;
                    break;
            }
            typePrefix = typePrefix.substring(0, typePrefix.lastIndexOf('.'));
        }

        return modelToBeReturned;
    }

    public abstract boolean addResource(Resource resource);

    public abstract boolean addWidget(Widget resource);

    /**
     * Gets widget version id.
     *
     * @return the widget version id
     */
    public String getWidgetId() {
        org.onap.aai.babel.xml.generator.types.Model model =
                this.getClass().getAnnotation(org.onap.aai.babel.xml.generator.types.Model.class);
        return Widget.getWidget(model.widget()).getId();
    }

    /**
     * Gets invariant id.
     *
     * @return the invariant id
     */
    public String getWidgetInvariantId() {
        org.onap.aai.babel.xml.generator.types.Model model =
                this.getClass().getAnnotation(org.onap.aai.babel.xml.generator.types.Model.class);
        return Widget.getWidget(model.widget()).getWidgetId();
    }

    /**
     * Gets delete flag.
     *
     * @return the delete flag
     */
    public boolean getDeleteFlag() {
        org.onap.aai.babel.xml.generator.types.Model model =
                this.getClass().getAnnotation(org.onap.aai.babel.xml.generator.types.Model.class);
        return model.dataDeleteFlag();
    }

    /**
     * Gets cardinality.
     *
     * @return the cardinality
     */
    public Cardinality getCardinality() {
        org.onap.aai.babel.xml.generator.types.Model model =
                this.getClass().getAnnotation(org.onap.aai.babel.xml.generator.types.Model.class);
        return model.cardinality();
    }

    public abstract Widget.Type getWidgetType();

    public String getModelId() {
        checkSupported();
        return modelId;
    }

    /**
     * Gets model type.
     *
     * @return the model type
     */
    public ModelType getModelType() {
        if (this instanceof Service) {
            return ModelType.SERVICE;
        } else if (this instanceof Resource) {
            return ModelType.RESOURCE;
        } else if (this instanceof Widget) {
            return ModelType.WIDGET;
        } else {
            return null;
        }
    }

    public String getModelName() {
        return modelName;
    }

    public String getModelVersion() {
        return modelVersion;
    }

    public String getModelNameVersionId() {
        checkSupported();
        return modelNameVersionId;
    }

    public String getModelDescription() {
        return modelDescription;
    }

    /**
     * Populate model identification information.
     *
     * @param modelIdentInfo the model ident info
     */
    public void populateModelIdentificationInformation(Map<String, String> modelIdentInfo) {
        Iterator<String> iter = modelIdentInfo.keySet().iterator();
        String property;
        while (iter.hasNext()) {
            property = iter.next();
            switch (property) {
                case "vfModuleModelInvariantUUID":
                case "serviceInvariantUUID":
                case "resourceInvariantUUID":
                case "invariantUUID":
                case "providing_service_invariant_uuid":
                    modelId = modelIdentInfo.get(property);
                    break;
                case "vfModuleModelUUID":
                case "resourceUUID":
                case "serviceUUID":
                case "UUID":
                case "providing_service_uuid":
                    modelNameVersionId = modelIdentInfo.get(property);
                    break;
                case "vfModuleModelVersion":
                case "serviceVersion":
                case "resourceversion":
                case "version":
                    modelVersion = modelIdentInfo.get(property);
                    break;
                case "vfModuleModelName":
                case "serviceName":
                case "resourceName":
                case "name":
                    modelName = modelIdentInfo.get(property);
                    break;
                case "serviceDescription":
                case "resourceDescription":
                case "vf_module_description":
                case "description":
                    modelDescription = modelIdentInfo.get(property);
                    break;
                case "providing_service_name":
                    modelName = modelIdentInfo.get(property);
                    modelDescription = modelIdentInfo.get(property);
                    break;
                default:
                    break;
            }
        }
    }

    public void setModelVersion(String modelVersion) {
        this.modelVersion = modelVersion;
    }

    public Set<Resource> getResources() {
        return resources;
    }

    public Set<Widget> getWidgets() {
        return widgets;
    }

    private void checkSupported() {
        if (this instanceof Widget) {
            throw new IllegalAccessException(GENERATOR_AAI_ERROR_UNSUPPORTED_WIDGET_OPERATION);
        }
    }
}