io.nats.client

Interface ObjectStore

public interface ObjectStore

Object Store Management context for creation and access to key value buckets.

Method Summary

Modifier and Type	Method and Description
ObjectInfo	addBucketLink(java.lang.String objectName, ObjectStore toStore) Add a link to another object store (bucket).
ObjectInfo	addLink(java.lang.String objectName, ObjectInfo toInfo) Add a link to another object.
ObjectInfo	delete(java.lang.String objectName) Delete the object by name.
ObjectInfo	get(java.lang.String objectName, java.io.OutputStream outputStream) Get an object by name from the store, reading it into the output stream, if the object exists.
java.lang.String	getBucketName() Get the name of the object store's bucket.
ObjectInfo	getInfo(java.lang.String objectName) Get the info for an object if the object exists / is not deleted.
ObjectInfo	getInfo(java.lang.String objectName, boolean includingDeleted) Get the info for an object if the object exists, optionally including deleted.
java.util.List<ObjectInfo>	getList() Get a list of all object [infos] in the store.
ObjectStoreStatus	getStatus() Get the ObjectStoreStatus object.
ObjectInfo	put(java.io.File file) Place the contents of the file into a new object using the file name as the object name.
ObjectInfo	put(ObjectMeta meta, java.io.InputStream inputStream) Place the contents of the input stream into a new object.
ObjectInfo	put(java.lang.String objectName, byte[] input) Place the bytes into a new object.
ObjectInfo	put(java.lang.String objectName, java.io.InputStream inputStream) Place the contents of the input stream into a new object.
ObjectStoreStatus	seal() Close (seal) the bucket to changes.
ObjectInfo	updateMeta(java.lang.String objectName, ObjectMeta meta) Update the metadata of name, description or headers.
io.nats.client.impl.NatsObjectStoreWatchSubscription	watch(ObjectStoreWatcher watcher, ObjectStoreWatchOption... watchOptions) Create a watch on the store (bucket).

Method Detail

getBucketName

java.lang.String getBucketName()

Get the name of the object store's bucket.

Returns:

the name

put

ObjectInfo put(ObjectMeta meta,
               java.io.InputStream inputStream)
        throws java.io.IOException,
               JetStreamApiException,
               java.security.NoSuchAlgorithmException

Place the contents of the input stream into a new object.

Parameters:

meta - the metadata for the object

inputStream - the source input stream

Returns:

the ObjectInfo for the saved object

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

java.security.NoSuchAlgorithmException - if the Digest Algorithm is not known. Currently, the only supported algorithm is SHA-256

put

ObjectInfo put(java.lang.String objectName,
               java.io.InputStream inputStream)
        throws java.io.IOException,
               JetStreamApiException,
               java.security.NoSuchAlgorithmException

Place the contents of the input stream into a new object.

Parameters:

objectName - the name of the object

inputStream - the source input stream

Returns:

the ObjectInfo for the saved object

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

java.security.NoSuchAlgorithmException - if the Digest Algorithm is not known. Currently, the only supported algorithm is SHA-256

put

ObjectInfo put(java.lang.String objectName,
               byte[] input)
        throws java.io.IOException,
               JetStreamApiException,
               java.security.NoSuchAlgorithmException

Place the bytes into a new object.

Parameters:

objectName - the name of the object

input - the bytes to store

Returns:

the ObjectInfo for the saved object

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

java.security.NoSuchAlgorithmException - if the Digest Algorithm is not known. Currently, the only supported algorithm is SHA-256

put

ObjectInfo put(java.io.File file)
        throws java.io.IOException,
               JetStreamApiException,
               java.security.NoSuchAlgorithmException

Place the contents of the file into a new object using the file name as the object name.

Parameters:

file - the file to read

Returns:

the ObjectInfo for the saved object

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

java.security.NoSuchAlgorithmException - if the Digest Algorithm is not known. Currently, the only supported algorithm is SHA-256

get

ObjectInfo get(java.lang.String objectName,
               java.io.OutputStream outputStream)
        throws java.io.IOException,
               JetStreamApiException,
               java.lang.InterruptedException,
               java.security.NoSuchAlgorithmException

Get an object by name from the store, reading it into the output stream, if the object exists.

Parameters:

objectName - The name of the object

outputStream - the destination stream.

Returns:

the ObjectInfo for the object name or throw an exception if it does not exist or is deleted.

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

java.lang.InterruptedException - if the thread is interrupted

java.security.NoSuchAlgorithmException - if the Digest Algorithm is not known. Currently, the only supported algorithm is SHA-256

getInfo

ObjectInfo getInfo(java.lang.String objectName)
            throws java.io.IOException,
                   JetStreamApiException

Get the info for an object if the object exists / is not deleted.

Parameters:

objectName - The name of the object

Returns:

the ObjectInfo for the object name or throw an exception if it does not exist.

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

getInfo

ObjectInfo getInfo(java.lang.String objectName,
                   boolean includingDeleted)
            throws java.io.IOException,
                   JetStreamApiException

Get the info for an object if the object exists, optionally including deleted.

Parameters:

objectName - The name of the object

includingDeleted - whether to return info for deleted objects

Returns:

the ObjectInfo for the object name or throw an exception if it does not exist.

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

updateMeta

ObjectInfo updateMeta(java.lang.String objectName,
                      ObjectMeta meta)
               throws java.io.IOException,
                      JetStreamApiException

Update the metadata of name, description or headers. All other changes are ignored.

Parameters:

objectName - The name of the object

meta - the metadata with the new or unchanged name, description and headers.

Returns:

the ObjectInfo after update

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

delete

ObjectInfo delete(java.lang.String objectName)
           throws java.io.IOException,
                  JetStreamApiException

Delete the object by name. A No-op if the object is already deleted.

Parameters:

objectName - The name of the object

Returns:

the ObjectInfo after delete or throw an exception if it does not exist.

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

addLink

ObjectInfo addLink(java.lang.String objectName,
                   ObjectInfo toInfo)
            throws java.io.IOException,
                   JetStreamApiException

Add a link to another object. A link cannot be for another link.

Parameters:

objectName - The name of the object

toInfo - the info object of the object to link to

Returns:

the ObjectInfo for the link as saved or throws an exception

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

addBucketLink

ObjectInfo addBucketLink(java.lang.String objectName,
                         ObjectStore toStore)
                  throws java.io.IOException,
                         JetStreamApiException

Add a link to another object store (bucket).

Parameters:

objectName - The name of the object

toStore - the store object to link to

Returns:

the ObjectInfo for the link as saved or throws an exception

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

seal

ObjectStoreStatus seal()
                throws java.io.IOException,
                       JetStreamApiException

Close (seal) the bucket to changes. The store (bucket) will be read only.

Returns:

the status object

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

getList

java.util.List<ObjectInfo> getList()
                            throws java.io.IOException,
                                   JetStreamApiException,
                                   java.lang.InterruptedException

Get a list of all object [infos] in the store.

Returns:

the list of objects

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

java.lang.InterruptedException - if the thread is interrupted

watch

io.nats.client.impl.NatsObjectStoreWatchSubscription watch(ObjectStoreWatcher watcher,
                                                           ObjectStoreWatchOption... watchOptions)
                                                    throws java.io.IOException,
                                                           JetStreamApiException,
                                                           java.lang.InterruptedException

Create a watch on the store (bucket).

Parameters:

watcher - the implementation to receive changes.

watchOptions - the watch options to apply. If multiple conflicting options are supplied, the last options wins.

Returns:

the NatsObjectStoreWatchSubscription

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

java.lang.InterruptedException - if the thread is interrupted

getStatus

ObjectStoreStatus getStatus()
                     throws java.io.IOException,
                            JetStreamApiException

Get the ObjectStoreStatus object.

Returns:

the status object

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data the request had an error related to the data