97d2a7f8ff31b78d8875e5278487d5eb52d19b05
[sdc.git] /
1 /*
2  * Copyright © 2016-2018 European Support Limited
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package org.openecomp.sdc.tosca.services;
18
19 import org.openecomp.sdc.tosca.datatypes.ToscaElementTypes;
20 import org.openecomp.sdc.tosca.datatypes.ToscaFlatData;
21 import org.onap.sdc.tosca.datatypes.model.CapabilityDefinition;
22 import org.onap.sdc.tosca.datatypes.model.DefinitionOfDataType;
23 import org.onap.sdc.tosca.datatypes.model.InterfaceDefinitionType;
24 import org.onap.sdc.tosca.datatypes.model.NodeTemplate;
25 import org.onap.sdc.tosca.datatypes.model.NodeType;
26 import org.onap.sdc.tosca.datatypes.model.PropertyDefinition;
27 import org.onap.sdc.tosca.datatypes.model.RequirementAssignment;
28 import org.onap.sdc.tosca.datatypes.model.RequirementDefinition;
29 import org.onap.sdc.tosca.datatypes.model.ServiceTemplate;
30
31 import java.util.Collection;
32 import java.util.List;
33 import java.util.Map;
34 import java.util.Optional;
35
36 import org.openecomp.sdc.tosca.datatypes.ToscaServiceModel;
37
38 public interface ToscaAnalyzerService {
39
40     /*
41         node template with type equal to node type or derived from node type
42          */
43     Map<String, NodeTemplate> getNodeTemplatesByType(ServiceTemplate serviceTemplate, String nodeType,
44                                                             ToscaServiceModel toscaServiceModel);
45
46     Optional<NodeType> fetchNodeType(String nodeTypeKey, Collection<ServiceTemplate> serviceTemplates);
47
48     boolean isTypeOf(NodeTemplate nodeTemplate, String nodeType, ServiceTemplate serviceTemplate,
49                             ToscaServiceModel toscaServiceModel);
50
51     boolean isTypeOf(InterfaceDefinitionType interfaceDefinition, String interfaceType, ServiceTemplate serviceTemplate,
52                             ToscaServiceModel toscaServiceModel);
53
54     boolean isTypeOf(DefinitionOfDataType parameterDefinition, String dataType, ServiceTemplate serviceTemplate,
55                             ToscaServiceModel toscaServiceModel);
56
57     boolean isTypeOf(CapabilityDefinition capabilityDefinition, String capabilityType, ServiceTemplate serviceTemplate,
58                             ToscaServiceModel toscaServiceModel);
59
60     List<RequirementAssignment> getRequirements(NodeTemplate nodeTemplate, String requirementId);
61
62     Optional<NodeTemplate> getNodeTemplateById(ServiceTemplate serviceTemplate, String nodeTemplateId);
63
64     Optional<String> getSubstituteServiceTemplateName(String substituteNodeTemplateId,
65                                                              NodeTemplate substitutableNodeTemplate);
66
67     Map<String, NodeTemplate> getSubstitutableNodeTemplates(ServiceTemplate serviceTemplate);
68
69     Optional<Map.Entry<String, NodeTemplate>> getSubstitutionMappedNodeTemplateByExposedReq(String substituteServiceTemplateFileName,
70                                                                                                    ServiceTemplate substituteServiceTemplate,
71                                                                                                    String requirementId);
72
73     /*
74         match only for the input which is not null
75          */
76     boolean isDesiredRequirementAssignment(RequirementAssignment requirementAssignment, String capability, String node,
77                                                   String relationship);
78
79     ToscaFlatData getFlatEntity(ToscaElementTypes elementType, String type, ServiceTemplate serviceTemplate,
80                                        ToscaServiceModel toscaModel);
81
82     boolean isSubstitutableNodeTemplate(NodeTemplate nodeTemplate);
83
84     NodeType createInitSubstitutionNodeType(ServiceTemplate substitutionServiceTemplate,
85                                                    String nodeTypeDerivedFromValue);
86
87     boolean isRequirementExistInNodeTemplate(NodeTemplate nodeTemplate, String requirementId,
88                                                     RequirementAssignment requirementAssignment);
89
90     Map<String, PropertyDefinition> manageSubstitutionNodeTypeProperties(ServiceTemplate substitutionServiceTemplate);
91
92     Map<String, CapabilityDefinition> calculateExposedCapabilities(Map<String, CapabilityDefinition> nodeTypeCapabilitiesDefinition,
93                                                                           Map<String, Map<String, RequirementAssignment>> fullFilledRequirementsDefinitionMap);
94
95     List<Map<String, RequirementDefinition>> calculateExposedRequirements(List<Map<String, RequirementDefinition>> nodeTypeRequirementsDefinitionList,
96                                                                                  Map<String, RequirementAssignment> nodeTemplateRequirementsAssignment);
97 }