com.idrsolutions.microservice.storage.Storage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of base-microservice-example Show documentation

Provides the shared classes used by IDRsolutions microservice examples.

There is a newer version: 14.0.0

Show newest version

package com.idrsolutions.microservice.storage;

import java.io.File;
import java.io.InputStream;

public interface Storage {
    /**
     * Places the given data as a file inside the storage
     * @param fileToUpload The file in raw bytes to upload
     * @param fileName The name of the file being uploaded
     * @param uuid The UUID of the file being uploaded
     * @return A URI to access the uploaded file, or null if the upload was unsuccessful
     */
    String put(final byte[] fileToUpload, final String fileName, final String uuid);

    /**
     * Places the given file inside the storage
     * @param fileToUpload The file to upload
     * @param fileName The name of the file being uploaded
     * @param uuid The UUID of the file being uploaded
     * @return A URI to access the uploaded file, or null if the upload was unsuccessful
     */
    String put(final File fileToUpload, final String fileName, final String uuid);

    String put(final InputStream fileToUpload, long fileSize, final String fileName, final String uuid);
}