aboutsummaryrefslogtreecommitdiffstats
path: root/openecomp-be/lib/openecomp-tosca-lib/src/main/java/org/openecomp/sdc/tosca/services/ToscaAnalyzerService.java
blob: 97d2a7f8ff31b78d8875e5278487d5eb52d19b05 (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
/*
 * Copyright © 2016-2018 European Support Limited
 *
 * 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.
 */

package org.openecomp.sdc.tosca.services;

import org.openecomp.sdc.tosca.datatypes.ToscaElementTypes;
import org.openecomp.sdc.tosca.datatypes.ToscaFlatData;
import org.onap.sdc.tosca.datatypes.model.CapabilityDefinition;
import org.onap.sdc.tosca.datatypes.model.DefinitionOfDataType;
import org.onap.sdc.tosca.datatypes.model.InterfaceDefinitionType;
import org.onap.sdc.tosca.datatypes.model.NodeTemplate;
import org.onap.sdc.tosca.datatypes.model.NodeType;
import org.onap.sdc.tosca.datatypes.model.PropertyDefinition;
import org.onap.sdc.tosca.datatypes.model.RequirementAssignment;
import org.onap.sdc.tosca.datatypes.model.RequirementDefinition;
import org.onap.sdc.tosca.datatypes.model.ServiceTemplate;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Optional;

import org.openecomp.sdc.tosca.datatypes.ToscaServiceModel;

public interface ToscaAnalyzerService {

    /*
        node template with type equal to node type or derived from node type
         */
    Map<String, NodeTemplate> getNodeTemplatesByType(ServiceTemplate serviceTemplate, String nodeType,
                                                            ToscaServiceModel toscaServiceModel);

    Optional<NodeType> fetchNodeType(String nodeTypeKey, Collection<ServiceTemplate> serviceTemplates);

    boolean isTypeOf(NodeTemplate nodeTemplate, String nodeType, ServiceTemplate serviceTemplate,
                            ToscaServiceModel toscaServiceModel);

    boolean isTypeOf(InterfaceDefinitionType interfaceDefinition, String interfaceType, ServiceTemplate serviceTemplate,
                            ToscaServiceModel toscaServiceModel);

    boolean isTypeOf(DefinitionOfDataType parameterDefinition, String dataType, ServiceTemplate serviceTemplate,
                            ToscaServiceModel toscaServiceModel);

    boolean isTypeOf(CapabilityDefinition capabilityDefinition, String capabilityType, ServiceTemplate serviceTemplate,
                            ToscaServiceModel toscaServiceModel);

    List<RequirementAssignment> getRequirements(NodeTemplate nodeTemplate, String requirementId);

    Optional<NodeTemplate> getNodeTemplateById(ServiceTemplate serviceTemplate, String nodeTemplateId);

    Optional<String> getSubstituteServiceTemplateName(String substituteNodeTemplateId,
                                                             NodeTemplate substitutableNodeTemplate);

    Map<String, NodeTemplate> getSubstitutableNodeTemplates(ServiceTemplate serviceTemplate);

    Optional<Map.Entry<String, NodeTemplate>> getSubstitutionMappedNodeTemplateByExposedReq(String substituteServiceTemplateFileName,
                                                                                                   ServiceTemplate substituteServiceTemplate,
                                                                                                   String requirementId);

    /*
        match only for the input which is not null
         */
    boolean isDesiredRequirementAssignment(RequirementAssignment requirementAssignment, String capability, String node,
                                                  String relationship);

    ToscaFlatData getFlatEntity(ToscaElementTypes elementType, String type, ServiceTemplate serviceTemplate,
                                       ToscaServiceModel toscaModel);

    boolean isSubstitutableNodeTemplate(NodeTemplate nodeTemplate);

    NodeType createInitSubstitutionNodeType(ServiceTemplate substitutionServiceTemplate,
                                                   String nodeTypeDerivedFromValue);

    boolean isRequirementExistInNodeTemplate(NodeTemplate nodeTemplate, String requirementId,
                                                    RequirementAssignment requirementAssignment);

    Map<String, PropertyDefinition> manageSubstitutionNodeTypeProperties(ServiceTemplate substitutionServiceTemplate);

    Map<String, CapabilityDefinition> calculateExposedCapabilities(Map<String, CapabilityDefinition> nodeTypeCapabilitiesDefinition,
                                                                          Map<String, Map<String, RequirementAssignment>> fullFilledRequirementsDefinitionMap);

    List<Map<String, RequirementDefinition>> calculateExposedRequirements(List<Map<String, RequirementDefinition>> nodeTypeRequirementsDefinitionList,
                                                                                 Map<String, RequirementAssignment> nodeTemplateRequirementsAssignment);
}