README.md

Minio Java SDK for Amazon S3 Compatible Cloud Storage

The Minio Java Client SDK provides simple APIs to access any Amazon S3 compatible object storage server.

This quickstart guide will show you how to install the client SDK and execute an example java program. For a complete list of APIs and examples, please take a look at the Java Client API Reference documentation.

Minimum Requirements

Java 1.7 or above, with one of the following environments:

• OracleJDK 8.0
• OpenJDK8.0

Download from maven

<dependency>
    <groupId>io.minio</groupId>
    <artifactId>minio</artifactId>
    <version>3.0.6</version>
</dependency>

Download from gradle

dependencies {
    compile 'io.minio:minio:3.0.6'
}

Download from JAR

You can download the latest JAR directly from maven.

Quick Start Example - File Uploader

This example program connects to an object storage server, makes a bucket on the server and then uploads a file to the bucket.

You need three items in order to connect to an object storage server.

Params	Description
Endpoint	URL to object storage service.
Access Key	Access key is like user ID that uniquely identifies your account.
Secret Key	Secret key is the password to your account.

For the following example, we will use a freely hosted Minio server running at https://play.minio.io:9000. Feel free to use this service for test and development. Access credentials shown in this example are open to the public.

FileUploader.java

import java.io.IOException;
import java.security.NoSuchAlgorithmException;
import java.security.InvalidKeyException;

import org.xmlpull.v1.XmlPullParserException;

import io.minio.MinioClient;
import io.minio.errors.MinioException;

public class FileUploader {
  public static void main(String[] args) throws NoSuchAlgorithmException, IOException, InvalidKeyException, XmlPullParserException {
    try {
      // Create a minioClient with the Minio Server name, Port, Access key and Secret key.
      MinioClient minioClient = new MinioClient("https://play.minio.io:9000", "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG");

      // Check if the bucket already exists.
      boolean isExist = minioClient.bucketExists("asiatrip");
      if(isExist) {
        System.out.println("Bucket already exists.");
      } else {
        // Make a new bucket called asiatrip to hold a zip file of photos.
        minioClient.makeBucket("asiatrip");
      }

      // Upload the zip file to the bucket with putObject
      minioClient.putObject("asiatrip","asiaphotos.zip", "/home/user/Photos/asiaphotos.zip");
      System.out.println("/home/user/Photos/asiaphotos.zip is successfully uploaded as asiaphotos.zip to `asiatrip` bucket.");
    } catch(MinioException e) {
      System.out.println("Error occurred: " + e);
    }
  }
}

Compile FileUploader

javac -cp "minio-3.0.6-all.jar"  FileUploader.java

Run FileUploader

java -cp "minio-3.0.6-all.jar:." FileUploader
/home/user/Photos/asiaphotos.zip is successfully uploaded as asiaphotos.zip to `asiatrip` bucket.

mc ls play/asiatrip/
[2016-06-02 18:10:29 PDT]  82KiB asiaphotos.zip

API Reference

The full API Reference is available here.

• Complete API Reference

API Reference: Bucket Operations

• makeBucket
• listBuckets
• bucketExists
• removeBucket
• listObjects
• listIncompleteUploads

API Reference: Object Operations

• getObject
• putObject
• copyObject
• statObject
• removeObject
• removeIncompleteUpload

API Reference: Presigned Operations

• presignedGetObject
• presignedPutObject
• presignedPostPolicy

API Reference: Bucket Policy Operations

• getBucketPolicy
• setBucketPolicy

Full Examples

Full Examples: Bucket Operations

• ListBuckets.java
• ListObjects.java
• BucketExists.java
• MakeBucket.java
• RemoveBucket.java
• ListIncompleteUploads.java

Full Examples: Object Operations

• PutObject.java
• PutObjectEncrypted.java
• GetObject.Java
• GetObjectEncrypted.Java
• GetPartialObject.java
• RemoveObject.java
• RemoveObjects.java
• StatObject.java

Full Examples: Presigned Operations

• PresignedGetObject.java
• PresignedPutObject.java
• PresignedPostPolicy.java

Full Examples: Bucket Policy Operations

• SetBucketPolicy.java
• GetBucketPolicy.Java

Explore Further

• Complete Documentation
• Minio Java Client SDK API Reference
• Build your own Photo API Service - Full Application Example

Contribute

Contributors Guide