rapture.common.api.BlobApi Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (C) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * This is an autogenerated file. You should not edit this file as any changes
 * will be overwritten.
 */

package rapture.common.api;
import rapture.common.exception.RaptureException;
import rapture.common.CallingContext;
import java.util.List;
import java.util.Map;
import rapture.common.BlobContainer;
import rapture.common.RaptureFolderInfo;
import rapture.common.model.BlobRepoConfig;


@SuppressWarnings("all")
public interface BlobApi {
     /**
     * Creates a repository for unstructured data.
     * 
     */
     void createBlobRepo(CallingContext context, String blobRepoUri, String config, String metaConfig);

     /**
     * Retrieves blob repository information
     * 
     */
     BlobRepoConfig getBlobRepoConfig(CallingContext context, String blobRepoUri);

     /**
     * Retrieves a collection of objects that contain the configuration information for
     * all the defined blob repositories.
     * 
     */
     List getBlobRepoConfigs(CallingContext context);

     /**
     * This method removes a blob Repository and its data from the Rapture system. There
     * is no undo.
     * 
     */
     void deleteBlobRepo(CallingContext context, String repoUri);

     /**
     * This api call can be used to determine whether a given repo exists.
     * 
     */
     Boolean blobRepoExists(CallingContext context, String repoUri);

     /**
     * This api call can be used to determine whether a given blob exists.
     * 
     */
     Boolean blobExists(CallingContext context, String blobUri);

     /**
     * Appends to a blob.
     * 
     */
     void addBlobContent(CallingContext context, String blobUri, byte[] content);

     /**
     * Stores a blob in one hit, assuming a String representation. If append, adds to any
     * content already existing
     * 
     */
     void putBlob(CallingContext context, String blobUri, byte[] content, String contentType);

     /**
     * Retrieves a blob and its metadata. The blob is represented as a byte array.
     * 
     */
     BlobContainer getBlob(CallingContext context, String blobUri);

     /**
     * Removes a blob from the backing store. There is no undo.
     * 
     */
     void deleteBlob(CallingContext context, String blobUri);

     /**
     * Retrieves the number of bytes in a blob.
     * 
     */
     Long getBlobSize(CallingContext context, String blobUri);

     /**
     * Store metadata associated with a blob
     * 
     */
     void putBlobMetaData(CallingContext context, String blobUri, Map metadata);

     /**
     * Retrieves all metadata associated with a blob.
     * 
     */
     Map getBlobMetaData(CallingContext context, String blobUri);

     /**
     * Returns full pathnames for an entire subtree as a map of the path to RFI.
     * 
     */
     Map listBlobsByUriPrefix(CallingContext context, String blobUri, int depth);

     /**
     * Removes a folder and its contents recursively, including empty subfolders. Validates
     * entitlement on individual blobs and folders. Returns a list of the blobs and folders
     * removed.
     * 
     */
     List deleteBlobsByUriPrefix(CallingContext context, String blobUri);

}