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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdc.tosca.services;
  22
  23 import org.openecomp.sdc.tosca.datatypes.ToscaElementTypes;
  24 import org.openecomp.sdc.tosca.datatypes.ToscaServiceModel;
  25 import org.openecomp.sdc.tosca.datatypes.model.CapabilityDefinition;
  26 import org.openecomp.sdc.tosca.datatypes.model.NodeTemplate;
  27 import org.openecomp.sdc.tosca.datatypes.model.NodeType;
  28 import org.openecomp.sdc.tosca.datatypes.model.PropertyDefinition;
  29 import org.openecomp.sdc.tosca.datatypes.model.RequirementAssignment;
  30 import org.openecomp.sdc.tosca.datatypes.model.RequirementDefinition;
  31 import org.openecomp.sdc.tosca.datatypes.model.ServiceTemplate;
  32
  33 import java.util.Collection;
  34 import java.util.List;
  35 import java.util.Map;
  36 import java.util.Optional;
  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   List<RequirementAssignment> getRequirements(NodeTemplate nodeTemplate, String requirementId);
  52
  53   Optional<NodeTemplate> getNodeTemplateById(ServiceTemplate serviceTemplate,
  54                                              String nodeTemplateId);
  55
  56   Optional<String> getSubstituteServiceTemplateName(String substituteNodeTemplateId,
  57                                                     NodeTemplate substitutableNodeTemplate);
  58
  59   Map<String, NodeTemplate> getSubstitutableNodeTemplates(ServiceTemplate serviceTemplate);
  60
  61   Optional<Map.Entry<String, NodeTemplate>> getSubstitutionMappedNodeTemplateByExposedReq(
  62       String substituteServiceTemplateFileName, ServiceTemplate substituteServiceTemplate,
  63       String requirementId);
  64
  65   /*
  66       match only for the input which is not null
  67        */
  68   boolean isDesiredRequirementAssignment(RequirementAssignment requirementAssignment,
  69                                          String capability, String node, String relationship);
  70
  71   Object getFlatEntity(ToscaElementTypes elementType, String type, ServiceTemplate serviceTemplate,
  72                        ToscaServiceModel toscaModel);
  73
  74   boolean isSubstitutableNodeTemplate(NodeTemplate nodeTemplate);
  75
  76   NodeType createInitSubstitutionNodeType(ServiceTemplate substitutionServiceTemplate,
  77                                           String nodeTypeDerivedFromValue);
  78
  79   boolean isRequirementExistInNodeTemplate(NodeTemplate nodeTemplate,
  80                                            String requirementId,
  81                                            RequirementAssignment requirementAssignment);
  82
  83   public Map<String, PropertyDefinition> manageSubstitutionNodeTypeProperties(
  84       ServiceTemplate substitutionServiceTemplate);
  85
  86   public Map<String, CapabilityDefinition> calculateExposedCapabilities(
  87       Map<String, CapabilityDefinition> nodeTypeCapabilitiesDefinition,
  88       Map<String, Map<String, RequirementAssignment>> fullFilledRequirementsDefinitionMap);
  89
  90   public List<Map<String, RequirementDefinition>> calculateExposedRequirements(
  91       List<Map<String, RequirementDefinition>> nodeTypeRequirementsDefinitionList,
  92       Map<String, RequirementAssignment> nodeTemplateRequirementsAssignment);
  93 }