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
|
/*-
* ============LICENSE_START=======================================================
* sdc-distribution-client
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.openecomp.sdc.tosca.parser.api;
import java.util.List;
import java.util.Map;
import org.apache.commons.lang3.tuple.Pair;
import org.openecomp.sdc.toscaparser.api.Group;
import org.openecomp.sdc.toscaparser.api.NodeTemplate;
public interface ISdcCsarHelper {
/**
* Get all node templates by node_type for this CSAR service.
*
* @param nodeType - the TOSCA type of the node.
* @return service node templates of this type.
*/
public List<NodeTemplate> getServiceNodeTemplatesByType(String nodeType);
/**
* Get groups of a VF with type "org.openecomp.groups.VfModule".
*
* @param vfCustomizationUuid - customizationUuid of VF instance.
* @return list of vfModule groups.
*/
public List<Group> getVfModulesByVf(String vfCustomizationUuid);
/**
* Get any property leaf value for node template by full path separated by #.<br>
* For example, for node template with this property:<br><br>
* network_assignments:<br>
ecomp_generated_network_assignment: true<br>
is_shared_network: false<br>
is_external_network: false<br>
ipv4_subnet_default_assignments:<br>
use_ipv4: true<br>
ip_network_address_plan: 1.2.3.4<br>
dhcp_enabled: true<br>
ip_version: 4<br>
cidr_mask: 24<br>
min_subnets_count: 1<br>
ipv6_subnet_default_assignments:<br>
use_ipv6: false<br><br>
* calling<br>
* getNodeTemplatePropertyLeafValue(nodeTemplate, "network_assignments#ipv6_subnet_default_assignments#use_ipv6")<br>
* will return "false".
* @param nodeTemplate - nodeTemplate where the property should be looked up.
* @param pathToPropertyLeafValue - the full path of the required property.
* @return the leaf value as String, or null if there's no such property, or it's not a leaf.
*/
public String getNodeTemplatePropertyLeafValue(NodeTemplate nodeTemplate, String pathToPropertyLeafValue);
/**
* Get any property leaf value for a group definition by full path separated by #.
* Same logic as in {@link #getNodeTemplatePropertyLeafValue(NodeTemplate, String) getNodeTemplatePropertyLeafValue}, only for a group.
* @param group - group where the property should be looked up.
* @param propertyName - the name of the required property.
* @return the leaf value as String, or null if there's no such property, or it's not a leaf.
*/
public String getGroupPropertyLeafValue(Group group, String propertyName);
/**
* Get all VL node templates of the CSAR service.
* @return - all VL node templates.
*/
public List<NodeTemplate> getServiceVlList();
/**
* Get all VF node templates of the CSAR service.
* @return - all VF node templates.
*/
public List<NodeTemplate> getServiceVfList();
/**
*
* Get a property from a metadata object.<br>
* This is just sugaring method, same as calling metadata.getMetadataPropertyValue(metadataPropertyName).<br>
*
* For metadata object representing the below: <br><br>
*
* metadata:<br>
invariantUUID: 4598a404-00e1-42a6-8767-0bda343e2066<br>
UUID: e17940d6-42f8-4989-bad0-31de5addc619<br>
customizationUUID: 83d086b2-a861-4d3b-aa84-3bfbb9b2ec20<br>
version: '0.1'<br>
name: vIPR_ATM<br>
description: vIPR_ATM<br>
type: VF<br>
category: category1<br>
subcategory: subCategory1<br><br>
calling<br>
getMetadataPropertyValue(metadata,"invariantUUID")<br>
will return "4598a404-00e1-42a6-8767-0bda343e2066".
* @param metadata - metadata object.
* @param metadataPropertyName - the name of the metadata property.
* @return metadata property value
*//*
//public String getMetadataPropertyValue(Metadata metadata, String metadataPropertyName);
*/
/**
* Get input leaf value for the CSAR service, by full path separated by #.<br>
* Same logic as in {@link #getNodeTemplatePropertyLeafValue(NodeTemplate, String) getNodeTemplatePropertyLeafValue}, only for an input full path.
* @param inputLeafValuePath by full path separated by #.
* @return input leaf value for the service.
*/
public String getServiceInputLeafValue(String inputLeafValuePath);
/**
* Get the type name of the CSAR service's substitution mappings element.<br>
*
* For the below:<br><br>
*
* substitution_mappings:<br>
type: org.openecomp.services.ViprATM<br>
calling<br>
getServiceSubstitutionMappingsTypeName()<br>
will return "org.openecomp.services.ViprATM"
* @return - the type name of the CSAR service's substitution mappings element
*/
public String getServiceSubstitutionMappingsTypeName();
/**
* Get the CSAR service metadata
* @return - the service metadata object.
*/
public Map<String, String> getServiceMetadata();
/**
* Get all VFC node templates from a specified VF.
* @param vfCustomizationId - customizationUuid of the VF node template.
* @return all VFC node templates from a specified VF
*/
public List<NodeTemplate> getVfcListByVf(String vfCustomizationId);
/**
* Get all CP node templates from a specified VF.
* @param vfCustomizationId - customizationUuid of the VF node template.
* @return all CP node templates from a specified VF
*/
public List<NodeTemplate> getCpListByVf(String vfCustomizationId);
/**
* Get all members of this group definition.<br>
*
* For example, for this group definition:<br><br>
*
* ViprAtm..vIPR-ATM-Base..module-0:<br>
type: org.openecomp.groups.VfModule<br>
.................<br>
members: [vIPR_ATM_Ha_Two, vIPR_ATM_Ha_One, vIPR_ATM_OAM_SG, vIPR_ATM_HA_TWO_SG, vIPR_ATM_HA_ONE_SG]<br><br>
calling<br>
getMembersOfGroup(group)<br>
will return List of the following Strings: "vIPR_ATM_Ha_Two, vIPR_ATM_Ha_One, vIPR_ATM_OAM_SG, vIPR_ATM_HA_TWO_SG, vIPR_ATM_HA_ONE_SG"<br>
* @param group - group to return the members.
* @return names of all group members.
*
*/
public List<String> getMembersOfGroup(Group group);
/**
* Get list of node template pairs, where for each pair,<br>
* the left node template in pair has requirement with name reqName, <br>
* which should be satisfied with respective capability by the right node template in pair.<br>
*
* For example, if we have the below two node templates in the vIPR VF:<br><br>
*
* oam_extCP:<br>
type: org.openecomp.resources.cp.extCP<br>
requirements:<br>
- virtualBinding: vipr_atm_firewall<br><br>
*
* vipr_atm_firewall: <br>
type: org.openecomp.resources.vfc.ViprAtm.abstract.nodes.heat.vipr_atm<br>
........<br><br>
*
* calling<br>
* getNodeTemplatePairsByReqName(getCpListByVf(viprCustomUuid), getVfcListByVf(viprCustomUuid), "virtualBinding")<br>
* will return a list with one Pair - where left element of pair will be "oam_extCP" node template,<br>
* and right element will be "vipr_atm_firewall" node template.<br>
*
* @param listOfReqNodeTemplates - list of node templates in which the "reqName" requirement should be looked.
* @param listOfCapNodeTemplates - list of node templates in which the capability matching the "reqName" requirement should be looked.
* @param reqName - the name of a requirement definition to match by.
* @return
*/
public List<Pair<NodeTemplate,NodeTemplate>> getNodeTemplatePairsByReqName(List<NodeTemplate> listOfReqNodeTemplates, List<NodeTemplate> listOfCapNodeTemplates, String reqName);
/**
* Get all allotted node templates from this service.
* @return all allotted node templates from this service.
*/
public List<NodeTemplate> getAllottedResources();
/**
* Get node_type of a node template.<br>
*
* For this node template:<br>
*
* vipr_atm_firewall: <br>
type: org.openecomp.resources.vfc.ViprAtm.abstract.nodes.heat.vipr_atm<br>
........<br><br>
*
* the function will return "org.openecomp.resources.vfc.ViprAtm.abstract.nodes.heat.vipr_atm"
*
* @param nodeTemplate - node template object
* @return - node type string.
*/
public String getTypeOfNodeTemplate(NodeTemplate nodeTemplate);
}
|
