com.oracle.iot.client.device.util

Class StorageDispatcher

java.lang.Object

com.oracle.iot.client.device.util.StorageDispatcher

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public abstract class StorageDispatcher
extends java.lang.Object
implements java.io.Closeable

The StorageDispatcher queues content for automatic upload to, or download from, the Oracle Storage Cloud Service.

     
     // Upload example
     com.oracle.iot.client.device.DirectlyConnectedDevice dcd =
         new com.oracle.iot.client.device.DirectlyConnectedDevice(assetsFilePath, assetsFilePassword);
     StorageDispatcher storageDispatcher = StorageDispatcher.getStorageDispatcher(dcd);
     storageDispatcher.setProgressCallback(new ProgressCallback() {
          public void progress(Progress progress) {
              StorageObject storageObject = progress.getStorageObject();
              if (storageObject.getName().equals("lenna")) {
                  if (progress.getState() == State.COMPLETED) {
                      // Can now safely remove images/Lenna.jpg, if desired.
                  } else if (progress.getState() == State.IN_PROGRESS && takingTooLong) {
                      storageDispatcher.cancel(storageObject);
                  }
              }
          }
      });
     StorageObject lenna =  dcd.createStorageObject("lenna","image/jpeg");
     lenna.setInputStream(new FileInputStream("../images/Lenna.jpg"));
     storageDispatcher.queue(lenna);

     // Download example
     com.oracle.iot.client.device.DirectlyConnectedDevice dcd =
         new com.oracle.iot.client.device.DirectlyConnectedDevice(assetsFilePath, assetsFilePassword);
     StorageDispatcher storageDispatcher = StorageDispatcher.getStorageDispatcher(dcd);
     storageDispatcher.setProgressCallback(new ProgressCallback() {
         public void progress(Progress progress) {
             StorageObject storageObject = progress.getStorageObject();
             if (storageObject.getName().equals("lenna")) {
                 if (progress.getState == State.COMPLETED) {
                     // downloads/Lenna.jpg is ready
                 } else if (progress.getState() == State.IN_PROGRESS && takingTooLong) {
                     storageDispatcher.cancel(storageObject);
                 }
             }
         }
     });
     
     StorageObject lenna =  dcd.createStorageObject(uri);
     lenna.setOutputStream(new FileOutputStream("../images/Lenna.jpg"));
     storageDispatcher.queue(lenna);
     
     
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StorageDispatcher.Progress An object for receiving progress via the ProgressCallback.
static interface	StorageDispatcher.ProgressCallback A callback interface for monitoring progress of queued content.

Constructor Summary

Constructors

Constructor and Description
StorageDispatcher()

Method Summary

Modifier and Type	Method and Description
abstract void	cancel(StorageObject storageObject) Cancel the transfer of content to or from storage.
static StorageDispatcher	getStorageDispatcher(DirectlyConnectedDevice directlyConnectedDevice) Get the StorageDispatcher for the given DirectlyConnectedDevice.
abstract void	queue(StorageObject storageObject) Add a StorageObject to the queue to upload/download content to/from the Storage Cloud.
abstract void	setProgressCallback(StorageDispatcher.ProgressCallback callback) Set a callback to be notified as the transfer progresses.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

StorageDispatcher

public StorageDispatcher()

Method Detail

getStorageDispatcher

public static StorageDispatcher getStorageDispatcher(DirectlyConnectedDevice directlyConnectedDevice)

Get the StorageDispatcher for the given DirectlyConnectedDevice.

Parameters:

directlyConnectedDevice - the DirectlyConnectedDevice

Returns:

a StorageDispatcher

queue

public abstract void queue(StorageObject storageObject)

Add a StorageObject to the queue to upload/download content to/from the Storage Cloud.

Parameters:

storageObject - The content storageObject to be queued

Throws:

java.lang.IllegalArgumentException - if the storage object is null

java.lang.IllegalStateException - if the storage object is already queued or in progress

cancel

public abstract void cancel(StorageObject storageObject)

Cancel the transfer of content to or from storage. This call has no effect if the transfer is completed, already cancelled, has failed, or the storageObject is not queued.

Parameters:

storageObject - the content storageObject to be cancelled.

setProgressCallback

public abstract void setProgressCallback(StorageDispatcher.ProgressCallback callback)

Set a callback to be notified as the transfer progresses.

Parameters:

callback - callback to invoke, if null, the existing callback will be removed