openecomp-be/lib/openecomp-tosca-lib/src/main/java/org/openecomp/sdc/tosca/services/ToscaAnalyzerService.java

   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.onap.sdc.tosca.datatypes.model.*;
  20 import org.openecomp.sdc.tosca.datatypes.ToscaElementTypes;
  21 import org.openecomp.sdc.tosca.datatypes.ToscaFlatData;
  22 import org.openecomp.sdc.tosca.datatypes.ToscaServiceModel;
  23
  24 import java.util.Collection;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.Optional;
  28
  29 public interface ToscaAnalyzerService {
  30
  31     /*
  32         node template with type equal to node type or derived from node type
  33          */
  34     Map<String, NodeTemplate> getNodeTemplatesByType(ServiceTemplate serviceTemplate, String nodeType,
  35                                                             ToscaServiceModel toscaServiceModel);
  36
  37     Optional<NodeType> fetchNodeType(String nodeTypeKey, Collection<ServiceTemplate> serviceTemplates);
  38
  39     boolean isTypeOf(NodeTemplate nodeTemplate, String nodeType, ServiceTemplate serviceTemplate,
  40                             ToscaServiceModel toscaServiceModel);
  41
  42     boolean isTypeOf(InterfaceDefinitionType interfaceDefinition, String interfaceType, ServiceTemplate serviceTemplate,
  43                             ToscaServiceModel toscaServiceModel);
  44
  45     boolean isTypeOf(DefinitionOfDataType parameterDefinition, String dataType, ServiceTemplate serviceTemplate,
  46                             ToscaServiceModel toscaServiceModel);
  47
  48     boolean isTypeOf(CapabilityDefinition capabilityDefinition, String capabilityType, ServiceTemplate serviceTemplate,
  49                             ToscaServiceModel toscaServiceModel);
  50
  51     List<RequirementAssignment> getRequirements(NodeTemplate nodeTemplate, String requirementId);
  52
  53     Optional<NodeTemplate> getNodeTemplateById(ServiceTemplate serviceTemplate, String nodeTemplateId);
  54
  55     Optional<String> getSubstituteServiceTemplateName(String substituteNodeTemplateId,
  56                                                              NodeTemplate substitutableNodeTemplate);
  57
  58     Map<String, NodeTemplate> getSubstitutableNodeTemplates(ServiceTemplate serviceTemplate);
  59
  60     Optional<Map.Entry<String, NodeTemplate>> getSubstitutionMappedNodeTemplateByExposedReq(String substituteServiceTemplateFileName,
  61                                                                                                    ServiceTemplate substituteServiceTemplate,
  62                                                                                                    String requirementId);
  63
  64     /*
  65         match only for the input which is not null
  66          */
  67     boolean isDesiredRequirementAssignment(RequirementAssignment requirementAssignment, String capability, String node,
  68                                                   String relationship);
  69
  70     ToscaFlatData getFlatEntity(ToscaElementTypes elementType, String type, ServiceTemplate serviceTemplate,
  71                                        ToscaServiceModel toscaModel);
  72
  73     boolean isSubstitutableNodeTemplate(NodeTemplate nodeTemplate);
  74
  75     NodeType createInitSubstitutionNodeType(ServiceTemplate substitutionServiceTemplate,
  76                                                    String nodeTypeDerivedFromValue);
  77
  78     boolean isRequirementExistInNodeTemplate(NodeTemplate nodeTemplate, String requirementId,
  79                                                     RequirementAssignment requirementAssignment);
  80
  81     Map<String, PropertyDefinition> manageSubstitutionNodeTypeProperties(ServiceTemplate substitutionServiceTemplate);
  82
  83     Map<String, CapabilityDefinition> calculateExposedCapabilities(Map<String, CapabilityDefinition> nodeTypeCapabilitiesDefinition,
  84                                                                           Map<String, Map<String, RequirementAssignment>> fullFilledRequirementsDefinitionMap);
  85
  86     List<Map<String, RequirementDefinition>> calculateExposedRequirements(List<Map<String, RequirementDefinition>> nodeTypeRequirementsDefinitionList,
  87                                                                                  Map<String, RequirementAssignment> nodeTemplateRequirementsAssignment);
  88 }