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