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