io.storj

Class Project

java.lang.Object

io.storj.Project

All Implemented Interfaces:

java.lang.AutoCloseable

public class Project
extends java.lang.Object
implements java.lang.AutoCloseable

Represents a stateful resource to a project. It allows executing operations like creating, listing, deleting buckets or uploading, downloading, listing, deleting objects.

Make sure to always close the Project object after completing work with it. The Project class implements the AutoCloseable interface, so it is best to use Project objects in try-with-resource blocks:

  try (Project project = uplink.openProject(access)) {
       Bucket bucket = project.createBucket("my-bucket")) {
      ...
  }
 }
 
 

Method Summary

Modifier and Type	Method and Description
void	close()
BucketInfo	createBucket(java.lang.String bucket) Creates a bucket in this project.
BucketInfo	deleteBucket(java.lang.String bucket) Deletes an bucket from this project.
ObjectInfo	deleteObject(java.lang.String bucket, java.lang.String key) Deletes an object from this bucket.
ObjectInputStream	downloadObject(java.lang.String bucket, java.lang.String key, ObjectDownloadOption... options) Starts a download from the specific key.
BucketInfo	ensureBucket(java.lang.String bucket) Ensures that a bucket exists in this project.
BucketIterator	listBuckets(BucketListOption... options)
ObjectIterator	listObjects(java.lang.String bucket, ObjectListOption... options) Lists the objects in this bucket.
BucketInfo	statBucket(java.lang.String bucket) Returns bucket metadata.
ObjectInfo	statObject(java.lang.String bucket, java.lang.String key) Returns object metadata.
ObjectOutputStream	uploadObject(java.lang.String bucket, java.lang.String key, ObjectUploadOption... options) Uploads the content to a new object in this bucket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

statBucket

public BucketInfo statBucket(java.lang.String bucket)
                      throws StorjException

Returns bucket metadata.

Parameters:

bucket - the bucket name

Returns:

the bucket info

Throws:

StorjException - if an error occurs during the deletion

createBucket

public BucketInfo createBucket(java.lang.String bucket)
                        throws StorjException

Creates a bucket in this project.

Parameters:

bucket - the bucket name

Returns:

the bucket info

Throws:

StorjException - if an error occurs during the deletion

ensureBucket

public BucketInfo ensureBucket(java.lang.String bucket)
                        throws StorjException

Ensures that a bucket exists in this project.

Parameters:

bucket - the bucket name

Returns:

the bucket info

Throws:

StorjException - if an error occurs during the deletion

listBuckets

public BucketIterator listBuckets(BucketListOption... options)

deleteBucket

public BucketInfo deleteBucket(java.lang.String bucket)
                        throws StorjException

Deletes an bucket from this project.

Parameters:

bucket - the bucket name

Returns:

the bucket info

Throws:

StorjException - if an error occurs during the deletion

statObject

public ObjectInfo statObject(java.lang.String bucket,
                             java.lang.String key)
                      throws StorjException

Returns object metadata.

Parameters:

bucket - the bucket name

key - the key of the object to delete

Returns:

the object info

Throws:

StorjException - if an error occurs during the deletion

deleteObject

public ObjectInfo deleteObject(java.lang.String bucket,
                               java.lang.String key)
                        throws StorjException

Deletes an object from this bucket.

Parameters:

bucket - the bucket name

key - the key of the object to delete

Returns:

the object info

Throws:

StorjException - if an error occurs during the deletion

uploadObject

public ObjectOutputStream uploadObject(java.lang.String bucket,
                                       java.lang.String key,
                                       ObjectUploadOption... options)
                                throws StorjException

Uploads the content to a new object in this bucket.

Parameters:

bucket - the bucket name

key - an object key

options - options to apply on the new object

Returns:

output stream which can be used for upload

Throws:

StorjException - if an error occurs during the upload

downloadObject

public ObjectInputStream downloadObject(java.lang.String bucket,
                                        java.lang.String key,
                                        ObjectDownloadOption... options)
                                 throws StorjException

Starts a download from the specific key.

Parameters:

bucket - the bucket name

key - an object key

options - options to apply while downloading

Returns:

input stream which can be used to download object

Throws:

StorjException - if an error occurs during the download

listObjects

public ObjectIterator listObjects(java.lang.String bucket,
                                  ObjectListOption... options)

Lists the objects in this bucket.

Parameters:

bucket - the bucket name

options - an optional list of ObjectListOption

Returns:

an Iterable<ObjectInfo>

close

public void close()
           throws StorjException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

StorjException