openecomp-be/lib/openecomp-core-lib/openecomp-zusammen-lib/openecomp-zusammen-api/src/main/java/org/openecomp/core/zusammen/api/ZusammenAdaptor.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.core.zusammen.api;
  18
  19 import com.amdocs.zusammen.adaptor.inbound.api.types.item.*;
  20 import com.amdocs.zusammen.commons.health.data.HealthInfo;
  21 import com.amdocs.zusammen.datatypes.Id;
  22 import com.amdocs.zusammen.datatypes.SessionContext;
  23 import com.amdocs.zusammen.datatypes.item.*;
  24 import com.amdocs.zusammen.datatypes.itemversion.ItemVersionRevisions;
  25 import com.amdocs.zusammen.datatypes.itemversion.Tag;
  26
  27 import java.util.Collection;
  28 import java.util.Optional;
  29
  30 public interface ZusammenAdaptor {
  31
  32   Collection<Item> listItems(SessionContext context);
  33
  34   Item getItem(SessionContext context, Id itemId);
  35
  36   void deleteItem(SessionContext context, Id itemId);
  37
  38   Id createItem(SessionContext context, Info info);
  39
  40   void updateItem(SessionContext context, Id itemId, Info info);
  41
  42   Collection<ItemVersion> listPublicVersions(SessionContext context, Id itemId);
  43
  44   ItemVersion getPublicVersion(SessionContext context, Id itemId, Id versionId);
  45
  46   Id createVersion(SessionContext context, Id itemId, Id baseVersionId,
  47                    ItemVersionData itemVersionData);
  48
  49   void updateVersion(SessionContext context, Id itemId, Id versionId,
  50                      ItemVersionData itemVersionData);
  51
  52   ItemVersion getVersion(SessionContext context, Id itemId, Id versionId);
  53
  54   ItemVersionStatus getVersionStatus(SessionContext context, Id itemId, Id versionId);
  55
  56   ItemVersionConflict getVersionConflict(SessionContext context, Id itemId, Id versionId);
  57
  58   void tagVersion(SessionContext context, Id itemId, Id versionId, Tag tag);
  59
  60   void resetVersionHistory(SessionContext context, Id itemId, Id versionId, String version);
  61
  62   void publishVersion(SessionContext context, Id itemId, Id versionId, String message);
  63
  64   void syncVersion(SessionContext context, Id itemId, Id versionId);
  65
  66   void forceSyncVersion(SessionContext context, Id itemId, Id versionId);
  67
  68   void cleanVersion(SessionContext context, Id itemId, Id versionId);
  69
  70   Optional<ElementInfo> getElementInfo(SessionContext context, ElementContext elementContext,
  71                                        Id elementId);
  72
  73   Optional<Element> getElement(SessionContext context, ElementContext elementContext,
  74                                String elementId); // TODO: 4/3/2017 change to Id
  75
  76   Optional<Element> getElementByName(SessionContext context, ElementContext elementContext,
  77                                      Id parentElementId, String elementName);
  78
  79   Collection<ElementInfo> listElements(SessionContext context, ElementContext elementContext,
  80                                        Id parentElementId);
  81
  82   Collection<Element> listElementData(SessionContext context, ElementContext elementContext,
  83                                       Id parentElementId);
  84
  85   /**
  86    * Lists the sub elements of the element named elementName which is a sub element of
  87    * parentElementId
  88    */
  89   Collection<ElementInfo> listElementsByName(SessionContext context, ElementContext elementContext,
  90                                              Id parentElementId, String elementName);
  91
  92   Optional<ElementInfo> getElementInfoByName(SessionContext context, ElementContext elementContext,
  93                                              Id parentElementId, String elementName);
  94
  95   Optional<ElementConflict> getElementConflict(SessionContext context,
  96                                                ElementContext elementContext, Id elementId);
  97
  98   Element saveElement(SessionContext context, ElementContext elementContext,
  99                       ZusammenElement element, String message);
 100
 101   void resolveElementConflict(SessionContext context, ElementContext elementContext,
 102                               ZusammenElement element, Resolution resolution);
 103
 104   void revert(SessionContext context, Id itemId, Id versionId, Id revisionId);
 105
 106   ItemVersionRevisions listRevisions(SessionContext context, Id itemId, Id versionId);
 107
 108   Collection<HealthInfo> checkHealth(SessionContext context);
 109
 110   String getVersion(SessionContext context);
 111 }