catalog-dao/src/main/java/org/openecomp/sdc/be/dao/api/ICatalogDAO.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.be.dao.api;
  22
  23 import fj.data.Either;
  24 import org.openecomp.sdc.be.resources.data.ESArtifactData;
  25 import org.openecomp.sdc.be.resources.exception.ResourceDAOException;
  26
  27 import java.util.List;
  28
  29 public interface ICatalogDAO {
  30
  31         public static final String TOSCA_ELEMENT_INDEX = "toscaelement";
  32         public static final String RESOURCES_INDEX = "resources";
  33         public final static String REF_NAME_FIELD = "refName";
  34         public final static String REF_VERSION_FIELD = "refVersion";
  35         public final static String ARTIFACT_NAME_FIELD = "artifactName";
  36
  37         void addToIndicesMap(String typeName, String indexName);
  38
  39         /**
  40          * Save an artifact in the DAO layer.
  41          *
  42          * @param imageData
  43          */
  44         void writeArtifact(ESArtifactData artifactData) throws ResourceDAOException;
  45
  46         /**
  47          * Get an artifact as a byte array based on the artifact id.
  48          *
  49          * @param id
  50          *            The id of the artifact to read.
  51          * @param id2
  52          * @return The artifact as a byte array.
  53          */
  54         Either<ESArtifactData, ResourceUploadStatus> getArtifact(String id);
  55
  56         Either<List<ESArtifactData>, ResourceUploadStatus> getArtifacts(String[] ids);
  57
  58         /**
  59          * Delete the given image.
  60          *
  61          * @param id
  62          *            Id of the image to delete.
  63          */
  64         void deleteArtifact(String id);
  65
  66         /**
  67          * delete all artifacts
  68          */
  69         void deleteAllArtifacts();
  70
  71 }