catalog-dao/src/main/java/org/openecomp/sdc/be/resources/api/IResourceUploader.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.resources.api;
  22
  23 import fj.data.Either;
  24 import org.openecomp.sdc.be.dao.api.ResourceUploadStatus;
  25 import org.openecomp.sdc.be.resources.data.ESArtifactData;
  26
  27 /**
  28  * DAO to manage image upload and retrieval.
  29  *
  30  * @author luc boutier
  31  */
  32 public interface IResourceUploader {
  33
  34         /**
  35          * Save an artifact in the DAO layer.
  36          *
  37          * @param imageData
  38          */
  39         ResourceUploadStatus saveArtifact(ESArtifactData artifactData, boolean isReload);
  40
  41         /**
  42          * Save an artifact in the DAO layer.
  43          *
  44          * @param imageData
  45          */
  46         ResourceUploadStatus updateArtifact(ESArtifactData artifactData);
  47
  48         /**
  49          * Get an artifact as a byte array based on the artifact id.
  50          *
  51          * @param id
  52          *            The id of the artifact to read.
  53          * @return The artifact as a byte array.
  54          */
  55         Either<ESArtifactData, ResourceUploadStatus> getArtifact(String id);
  56
  57         /**
  58          * Delete the given image.
  59          *
  60          * @param id
  61          *            Id of the image to delete.
  62          */
  63         void deleteArtifact(String id);
  64
  65         /**
  66          * delete all artifacts
  67          */
  68         public void deleteAllArtifacts();
  69
  70 }