org.ctoolkit.services.storage.StorageService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ctoolkit-services-api Show documentation
CtoolkiT Services API
There is a newer version: 0.6
Show newest version
/*
 * Copyright (c) 2017 Comvai, s.r.o. All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

package org.ctoolkit.services.storage;

import javax.annotation.Nonnull;

/**
 * The service API to store and manage large objects (blobs) up to TBs in size.
 *
 * @author Jozef Pohorelec
 * @author Aurel Medvegy
 */
public interface StorageService
{
    /**
     * Store data into storage and return related metadata.
     * The file name will be generated and stored within default bucket container.
     *
     * @param data     the array of bytes of the file (document) to be stored
     * @param mimeType the media type of the data representation
     * @return the file record metadata
     */
    BlobInfo store( @Nonnull byte[] data, @Nonnull String mimeType );

    /**
     * Store data into storage and return related metadata.
     *
     * @param data       the array of bytes of the file (document) to be stored
     * @param mimeType   the media type of the data representation
     * @param fileName   the intended name of the file in storage
     * @param bucketName the name of the bucket, the specified or default container to hold given data
     * @return the file record metadata
     */
    BlobInfo store( @Nonnull byte[] data,
                    @Nonnull String mimeType,
                    @Nonnull String fileName,
                    @Nonnull String bucketName );

    /**
     * Return the file (document) from default bucket container.
     *
     * @param fileName the name of the file (document) in storage to get
     * @return the array of bytes of the file
     */
    byte[] serve( @Nonnull String fileName );

    /**
     * Return the file (document).
     *
     * @param fileName   the name of the file (document) in storage to get
     * @param bucketName the name of the bucket container
     * @return the array of bytes of the file
     */
    byte[] serve( @Nonnull String fileName, @Nonnull String bucketName );

    /**
     * Delete the file (document) from default bucket container.
     *
     * @param fileName the name of the file (document) in storage to delete
     * @return true if file (document) has been deleted, false if not found
     */
    boolean delete( @Nonnull String fileName );

    /**
     * Delete the file (document).
     *
     * @param fileName   the name of the file (document) in storage to delete
     * @param bucketName the name of the bucket container
     * @return true if file (document) has been deleted, false if not found
     */
    boolean delete( @Nonnull String fileName, @Nonnull String bucketName );

    /**
     * Return the file (document) record metadata for default bucket container.
     *
     * @param fileName the name of the file (document) in storage to read the metadata of
     * @return the file record metadata
     */
    BlobInfo getBlobInfo( @Nonnull String fileName );

    /**
     * Return the file (document) record metadata.
     *
     * @param fileName   the name of the file (document) in storage to read the metadata of
     * @param bucketName the name of the bucket container
     * @return the file record metadata
     */
    BlobInfo getBlobInfo( @Nonnull String fileName, @Nonnull String bucketName );
}