org.jimmutable.aws.simple_object_store

Class SimpleObjectStore

java.lang.Object

org.jimmutable.aws.environment.CloudResource

org.jimmutable.aws.simple_object_store.SimpleObjectStore

public class SimpleObjectStore
extends CloudResource

Constructor Summary

Constructors

Constructor and Description
SimpleObjectStore(ApplicationEnvironment env, SimpleStoreName store_name, boolean is_read_only)

Method Summary

Modifier and Type	Method and Description
boolean	delete(S3Path path) Delete an object from the simple object store
org.jimmutable.core.objects.StandardObject	get(S3Path path, org.jimmutable.core.objects.StandardObject default_value) Get an object from the datastore
com.amazonaws.services.s3.AmazonS3	getSimpleAmazonS3()
S3BucketName	getSimpleS3BucketName()
String	getSimpleS3BucketNameString()
SimpleStoreName	getSimpleStoreName()
boolean	isReadOnly()
boolean	objectExists(S3Path path, boolean default_value) Check to see if a given object exists in the datastore
org.jimmutable.core.threading.OperationRunnable.Result	scan(S3Path path, ScanListener listener, int processing_threads) Scan all objects in a given path This function blocks until all objects are scanned
void	startScanAsycn(S3Path path, ScanListener listener, int processing_threads) Scan all objects in a given path This function blocks until all objects are scanned
boolean	upsert(SimpleObjectStorable obj) Upload an object into the datastore NOTE: Objects are assumed to be relatively small (less than 10MB Serialized).

Methods inherited from class org.jimmutable.aws.environment.CloudResource

getSimpleCloudName

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleObjectStore

public SimpleObjectStore(ApplicationEnvironment env,
                         SimpleStoreName store_name,
                         boolean is_read_only)

Method Detail

getSimpleStoreName

public SimpleStoreName getSimpleStoreName()

isReadOnly

public boolean isReadOnly()

getSimpleAmazonS3

public com.amazonaws.services.s3.AmazonS3 getSimpleAmazonS3()

getSimpleS3BucketName

public S3BucketName getSimpleS3BucketName()

getSimpleS3BucketNameString

public String getSimpleS3BucketNameString()

upsert

public boolean upsert(SimpleObjectStorable obj)

Upload an object into the datastore NOTE: Objects are assumed to be relatively small (less than 10MB Serialized). As a result, the implementation of this method does everything in RAM (as opposed to on disk). If you are working with extremely large objects, this implementation may need to be revisited.

Parameters:

obj - The object to upsert

Returns:

True if the upsert was a success, false otherwise

get

public org.jimmutable.core.objects.StandardObject get(S3Path path,
                                                      org.jimmutable.core.objects.StandardObject default_value)

Get an object from the datastore

Parameters:

path - The path to read from

default_value - The value to return if the object can not be read (for any reason)

Returns:

The standard object read from the specified path

objectExists

public boolean objectExists(S3Path path,
                            boolean default_value)

Check to see if a given object exists in the datastore

Parameters:

path - The path of the object

default_value - The value to return if any sort of error occours

Returns:

true if the object exists, false if it does not, and default_value if an error occours while checking

delete

public boolean delete(S3Path path)

Delete an object from the simple object store

Parameters:

path - The path of the object to delete

Returns:

true if the object was deleted, false otherwise

scan

public org.jimmutable.core.threading.OperationRunnable.Result scan(S3Path path,
                                                                   ScanListener listener,
                                                                   int processing_threads)

Scan all objects in a given path This function blocks until all objects are scanned

Parameters:

path - The root path of the scan (to scan the whole bucket use S3Path.PATH_BUCKET_ROOT, null is not allowed)

listener - The scan listener

processing_threads - The number of object processign threads to use

Returns:

The result of the scan operation

startScanAsycn

public void startScanAsycn(S3Path path,
                           ScanListener listener,
                           int processing_threads)

Scan all objects in a given path This function blocks until all objects are scanned

Parameters:

path - The root path of the scan (to scan the whole bucket use S3Path.PATH_BUCKET_ROOT, null is not allowed)

listener - The scan listener

processing_threads - The number of object processign threads to use