All Downloads are FREE. Search and download functionalities are using the official Maven repository.

co.mercenary.creators.minio.MinioOperations Maven / Gradle / Ivy

There is a newer version: 1.0.4-RELEASE
Show newest version
/*
 * Copyright (c) 2018, Mercenary Creators Company. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package co.mercenary.creators.minio;

import java.io.File;
import java.io.InputStream;
import java.nio.file.Path;
import java.time.Duration;
import java.util.Optional;
import java.util.concurrent.TimeUnit;
import java.util.function.Predicate;
import java.util.regex.Pattern;
import java.util.stream.Stream;

import org.springframework.core.io.Resource;
import org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;

import co.mercenary.creators.minio.data.MinioBucket;
import co.mercenary.creators.minio.data.MinioCopyConditions;
import co.mercenary.creators.minio.data.MinioItem;
import co.mercenary.creators.minio.data.MinioObjectStatus;
import co.mercenary.creators.minio.data.MinioUpload;
import co.mercenary.creators.minio.errors.MinioOperationException;
import co.mercenary.creators.minio.util.MinioUtils;
import io.minio.ServerSideEncryption;
import io.minio.http.Method;

public interface MinioOperations extends MinioManager
{
    @NonNull
    String getServerUrl();

    @NonNull
    Stream getBuckets() throws MinioOperationException;

    @NonNull
    Stream getBucketsNamed(@NonNull Predicate filter) throws MinioOperationException;

    @NonNull
    default Stream getBucketsNamed(@NonNull final Pattern regex) throws MinioOperationException
    {
        MinioUtils.testAllNonNull(regex);

        return getBucketsNamed(named -> regex.matcher(named).matches());
    }

    @NonNull
    default Stream getBucketsNamed(@NonNull final CharSequence regex) throws MinioOperationException
    {
        return getBucketsNamed(Pattern.compile(MinioUtils.requireToString(regex)));
    }

    @NonNull
    default Optional getBucket(@NonNull final CharSequence bucket) throws MinioOperationException
    {
        final String match = MinioUtils.requireToString(bucket);

        return getBucketsNamed(named -> match.equals(named)).findFirst();
    }

    boolean isBucket(@NonNull CharSequence bucket) throws MinioOperationException;

    boolean deleteBucket(@NonNull CharSequence bucket) throws MinioOperationException;

    boolean isObject(@NonNull CharSequence bucket, @NonNull CharSequence name) throws MinioOperationException;

    boolean deleteObject(@NonNull CharSequence bucket, @NonNull CharSequence name) throws MinioOperationException;

    void setBucketPolicy(@NonNull CharSequence bucket, @NonNull Object policy) throws MinioOperationException;

    @NonNull
    String getBucketPolicy(@NonNull CharSequence bucket) throws MinioOperationException;

    @NonNull
     T getBucketPolicy(@NonNull CharSequence bucket, @NonNull Class astype) throws MinioOperationException;

    @NonNull
    MinioBucket createOrGetBucket(@NonNull CharSequence bucket) throws MinioOperationException;

    @NonNull
    MinioObjectStatus getObjectStatus(@NonNull CharSequence bucket, @NonNull CharSequence name) throws MinioOperationException;

    @NonNull
    MinioObjectStatus getObjectStatus(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull ServerSideEncryption keys) throws MinioOperationException;

    @NonNull
    InputStream getObjectInputStream(@NonNull CharSequence bucket, @NonNull CharSequence name) throws MinioOperationException;

    @NonNull
    InputStream getObjectInputStream(@NonNull CharSequence bucket, @NonNull CharSequence name, long skip) throws MinioOperationException;

    @NonNull
    InputStream getObjectInputStream(@NonNull CharSequence bucket, @NonNull CharSequence name, long skip, long leng) throws MinioOperationException;

    @NonNull
    InputStream getObjectInputStream(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull ServerSideEncryption keys) throws MinioOperationException;

    @NonNull
    default String getSignedObjectUrl(@NonNull final CharSequence bucket, @NonNull final CharSequence name) throws MinioOperationException
    {
        return getSignedObjectUrl(Method.GET, MinioUtils.requireNonNull(bucket), MinioUtils.requireNonNull(name));
    }

    @NonNull
    default String getSignedObjectUrl(@NonNull final CharSequence bucket, @NonNull final CharSequence name, @NonNull final Long seconds) throws MinioOperationException
    {
        return getSignedObjectUrl(Method.GET, MinioUtils.requireNonNull(bucket), MinioUtils.requireNonNull(name), MinioUtils.requireNonNull(seconds));
    }

    @NonNull
    default String getSignedObjectUrl(@NonNull final CharSequence bucket, @NonNull final CharSequence name, @NonNull final Duration seconds) throws MinioOperationException
    {
        return getSignedObjectUrl(Method.GET, MinioUtils.requireNonNull(bucket), MinioUtils.requireNonNull(name), MinioUtils.requireNonNull(seconds));
    }

    @NonNull
    default String getSignedObjectUrl(@NonNull final CharSequence bucket, @NonNull final CharSequence name, @NonNull final Long time, @NonNull final TimeUnit unit) throws MinioOperationException
    {
        return getSignedObjectUrl(Method.GET, MinioUtils.requireNonNull(bucket), MinioUtils.requireNonNull(name), MinioUtils.requireNonNull(time), MinioUtils.requireNonNull(unit));
    }

    @NonNull
    String getSignedObjectUrl(@NonNull Method method, @NonNull CharSequence bucket, @NonNull CharSequence name) throws MinioOperationException;

    @NonNull
    String getSignedObjectUrl(@NonNull Method method, @NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull Long seconds) throws MinioOperationException;

    @NonNull
    String getSignedObjectUrl(@NonNull Method method, @NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull Duration seconds) throws MinioOperationException;

    @NonNull
    String getSignedObjectUrl(@NonNull Method method, @NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull Long time, @NonNull TimeUnit unit) throws MinioOperationException;

    void putObject(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull byte[] input, @Nullable CharSequence type) throws MinioOperationException;

    void putObject(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull InputStream input, @Nullable CharSequence type) throws MinioOperationException;

    void putObject(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull InputStream input, long size, @Nullable CharSequence type) throws MinioOperationException;

    void putObject(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull InputStream input, long size, @NonNull ServerSideEncryption keys) throws MinioOperationException;

    default void putObject(@NonNull final CharSequence bucket, @NonNull final CharSequence name, @NonNull final byte[] input) throws MinioOperationException
    {
        putObject(MinioUtils.requireNonNull(bucket), MinioUtils.requireNonNull(name), MinioUtils.requireNonNull(input), MinioUtils.NULL(CharSequence.class));
    }

    default void putObject(@NonNull final CharSequence bucket, @NonNull final CharSequence name, @NonNull final InputStream input) throws MinioOperationException
    {
        putObject(MinioUtils.requireNonNull(bucket), MinioUtils.requireNonNull(name), MinioUtils.requireNonNull(input), MinioUtils.NULL(CharSequence.class));
    }

    default void putObject(@NonNull final CharSequence bucket, @NonNull final CharSequence name, @NonNull final InputStream input, final long size) throws MinioOperationException
    {
        putObject(MinioUtils.requireNonNull(bucket), MinioUtils.requireNonNull(name), MinioUtils.requireNonNull(input), size, MinioUtils.NULL(CharSequence.class));
    }

    void putObject(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull Resource input, @Nullable CharSequence type) throws MinioOperationException;

    default void putObject(@NonNull final CharSequence bucket, @NonNull final CharSequence name, @NonNull final Resource input) throws MinioOperationException
    {
        putObject(MinioUtils.requireNonNull(bucket), MinioUtils.requireNonNull(name), MinioUtils.requireNonNull(input), MinioUtils.NULL(CharSequence.class));
    }

    void putObject(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull File input, @Nullable CharSequence type) throws MinioOperationException;

    default void putObject(@NonNull final CharSequence bucket, @NonNull final CharSequence name, @NonNull final File input) throws MinioOperationException
    {
        putObject(MinioUtils.requireNonNull(bucket), MinioUtils.requireNonNull(name), MinioUtils.requireNonNull(input), MinioUtils.NULL(CharSequence.class));
    }

    void putObject(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull File input, long size, @Nullable CharSequence type) throws MinioOperationException;

    default void putObject(@NonNull final CharSequence bucket, @NonNull final CharSequence name, @NonNull final File input, final long size) throws MinioOperationException
    {
        putObject(MinioUtils.requireNonNull(bucket), MinioUtils.requireNonNull(name), MinioUtils.requireNonNull(input), size, MinioUtils.NULL(CharSequence.class));
    }

    void putObject(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull Path input, @Nullable CharSequence type) throws MinioOperationException;

    void putObject(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull Path input, long size, @Nullable CharSequence type) throws MinioOperationException;

    default boolean copyObject(@NonNull final CharSequence bucket, @NonNull final CharSequence name, @NonNull final CharSequence target) throws MinioOperationException
    {
        return copyObject(MinioUtils.requireNonNull(bucket), MinioUtils.requireNonNull(name), MinioUtils.requireNonNull(target), MinioUtils.NULL(CharSequence.class), MinioUtils.NULL(MinioCopyConditions.class));
    }

    default boolean copyObject(@NonNull final CharSequence bucket, @NonNull final CharSequence name, @NonNull final CharSequence target, @Nullable final CharSequence object) throws MinioOperationException
    {
        return copyObject(MinioUtils.requireNonNull(bucket), MinioUtils.requireNonNull(name), MinioUtils.requireNonNull(target), object, MinioUtils.NULL(MinioCopyConditions.class));
    }

    boolean copyObject(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull CharSequence target, @Nullable MinioCopyConditions conditions) throws MinioOperationException;

    boolean copyObject(@NonNull CharSequence bucket, @NonNull CharSequence name, @NonNull CharSequence target, @Nullable CharSequence object, @Nullable MinioCopyConditions conditions) throws MinioOperationException;

    @NonNull
    Stream getItems(@NonNull CharSequence bucket, @Nullable CharSequence prefix, boolean recursive) throws MinioOperationException;

    @NonNull
    default Stream getItems(@NonNull final CharSequence bucket) throws MinioOperationException
    {
        return getItems(MinioUtils.requireNonNull(bucket), MinioUtils.NULL(CharSequence.class));
    }

    @NonNull
    default Stream getItems(@NonNull final CharSequence bucket, final boolean recursive) throws MinioOperationException
    {
        return getItems(MinioUtils.requireNonNull(bucket), MinioUtils.NULL(CharSequence.class), recursive);
    }

    @NonNull
    default Optional getItem(@NonNull final CharSequence bucket, @NonNull final CharSequence name) throws MinioOperationException
    {
        return getItems(MinioUtils.requireNonNull(bucket), MinioUtils.requireToString(name), false).findFirst();
    }

    @NonNull
    default Stream getItems(@NonNull final CharSequence bucket, @Nullable final CharSequence prefix) throws MinioOperationException
    {
        return getItems(MinioUtils.requireNonNull(bucket), prefix, false);
    }

    @NonNull
    default Stream getIncompleteUploads(@NonNull final CharSequence bucket) throws MinioOperationException
    {
        return getIncompleteUploads(MinioUtils.requireNonNull(bucket), MinioUtils.NULL(CharSequence.class), false);
    }

    @NonNull
    default Stream getIncompleteUploads(@NonNull final CharSequence bucket, final boolean recursive) throws MinioOperationException
    {
        return getIncompleteUploads(MinioUtils.requireNonNull(bucket), MinioUtils.NULL(CharSequence.class), recursive);
    }

    @NonNull
    default Stream getIncompleteUploads(@NonNull final CharSequence bucket, @Nullable final CharSequence prefix) throws MinioOperationException
    {
        return getIncompleteUploads(MinioUtils.requireNonNull(bucket), prefix, false);
    }

    @NonNull
    Stream getIncompleteUploads(@NonNull CharSequence bucket, @Nullable CharSequence prefix, boolean recursive) throws MinioOperationException;
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy