PrivateDatastore

Type Members

class AccessDeniedException extends DsException

Exception indicating that we tried to access a datastore that we don't have access to.
Exception indicating that we tried to access a datastore that we don't have access to.

Definition Classes
Datastore
class AlreadyExistsException extends DsException

Exception indicating that we tried to upload an item to the datastore that already exists.
Exception indicating that we tried to upload an item to the datastore that already exists.
Data in the datastore is (mostly) immutable. Replacing an item is possible, but you have to set a flag. If you don't set the flag, and you're replacing something, this exception gets thrown.

Definition Classes
Datastore
class DoesNotExistException extends DsException

Exception indicating that we tried to access an item in the datastore that wasn't there.
Exception indicating that we tried to access an item in the datastore that wasn't there.

Definition Classes
Datastore
class DsException extends Exception

Common base class for all datastore exceptions, so they can be caught together
Common base class for all datastore exceptions, so they can be caught together

Definition Classes
Datastore
case class Locator(group: String, name: String, version: Int, directory: Boolean) extends Product with Serializable

Identifies a single version of a file or directory in the datastore
Identifies a single version of a file or directory in the datastore

Definition Classes
Datastore

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object Locator extends Serializable

Definition Classes
Datastore
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bucketName: String

Returns the name of the bucket backing this datastore
Returns the name of the bucket backing this datastore

Definition Classes
Datastore
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def createBucketIfNotExists(): Unit

Creates the bucket backing this datastore if necessary
Creates the bucket backing this datastore if necessary
You only need to call this if you're setting up a new datastore.

Definition Classes
Datastore
def directoryExists(group: String, name: String, version: Int): Boolean

Checks whether a directory exists in the datastore
Checks whether a directory exists in the datastore
group
group of the directory in the datastore
name
name of the directory in the datastore
version
version of the directory in the datastore
returns
true if the directory exists, false otherwise

Definition Classes
Datastore
def directoryPath(group: String, name: String, version: Int): Path

Gets a local path for a directory in the datastore
Gets a local path for a directory in the datastore
Downloads the directory from S3 if necessary
group
the group of the directory
name
the name of the directory
version
the version of the directory
returns
path to the directory on the local filesystem

Definition Classes
Datastore
def directoryUrl(group: String, name: String, version: Int): URL

Gets a URL for a directory in the datastore
Gets a URL for a directory in the datastore
group
group of the directory
name
name of the directory
version
version of the directory
returns
URL pointing to the directory. This URL will always point to a zip file containing the directory's contents.

Definition Classes
Datastore
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def exists(locator: Locator): Boolean

Checks whether an item exists in the datastore
Checks whether an item exists in the datastore
locator
locator of the item in the datastore
returns
true if the item exists, false otherwise

Definition Classes
Datastore
def fileExists(group: String, name: String, version: Int): Boolean

Checks whether a file exists in the datastore
Checks whether a file exists in the datastore
group
group of the file in the datastore
name
name of the file in the datastore
version
version of the file in the datastore
returns
true if the file exists, false otherwise

Definition Classes
Datastore
def filePath(group: String, name: String, version: Int): Path

Gets a local path for a file in the datastore
Gets a local path for a file in the datastore
Downloads the file from S3 if necessary
group
the group of the file
name
the name of the file
version
the version of the file
returns
path to the file on the local filesystem

Definition Classes
Datastore
def fileUrl(group: String, name: String, version: Int): URL

Gets a URL for a file in the datastore
Gets a URL for a file in the datastore
group
group of the file
name
name of the file
version
version of the file
returns
URL pointing to the file

Definition Classes
Datastore
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
val internalLogger: Logger

Definition Classes
Logging
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def listGroupContents(group: String): SortedSet[Locator]

Lists all items in a group
Lists all items in a group
group
group to search over
returns
a set of locators, one for each item in the group. Multiple versions are multiple locators.

Definition Classes
Datastore
def listGroups: SortedSet[String]

Lists all groups in the datastore
Lists all groups in the datastore
returns
a set of all groups in the datastore

Definition Classes
Datastore
object logger

Definition Classes
Logging
val name: String

name of the datastore.
name of the datastore. Corresponds to the name of the bucket in S3. Currently we have "public" and "private".

Definition Classes
Datastore
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def path(locator: Locator): Path

Gets a local path for an item in the datastore
Gets a local path for an item in the datastore
Downloads the item from S3 if necessary
locator
locator for the item in the datastore
returns
path to the item on the local filesystem

Definition Classes
Datastore
def publish(path: Path, locator: Locator, overwrite: Boolean): Unit

Publishes an item to the datastore
Publishes an item to the datastore
path
path to the item to be published
locator
locator to publish the item under
overwrite
if true, overwrites possible existing items in the datastore

Definition Classes
Datastore
def publishDirectory(path: Path, group: String, name: String, version: Int, overwrite: Boolean): Unit

Publishes a directory to the datastore
Publishes a directory to the datastore
path
path to the directory to be published
group
group to publish the directory under
name
name to publish the directory under
version
version to publish the directory under
overwrite
if true, overwrites possible existing items in the datastore

Definition Classes
Datastore
def publishDirectory(path: String, group: String, name: String, version: Int, overwrite: Boolean): Unit

Publishes a directory to the datastore
Publishes a directory to the datastore
path
name of the directory to be published
group
group to publish the directory under
name
name to publish the directory under
version
version to publish the directory under
overwrite
if true, overwrites possible existing items in the datastore

Definition Classes
Datastore
def publishFile(file: Path, group: String, name: String, version: Int, overwrite: Boolean): Unit

Publishes a file to the datastore
Publishes a file to the datastore
file
path to the file to be published
group
group to publish the file under
name
name to publish the file under
version
version to publish the file under
overwrite
if true, overwrites possible existing items in the datastore

Definition Classes
Datastore
def publishFile(file: String, group: String, name: String, version: Int, overwrite: Boolean): Unit

Publishes a file to the datastore
Publishes a file to the datastore
file
name of the file to be published
group
group to publish the file under
name
name to publish the file under
version
version to publish the file under
overwrite
if true, overwrites possible existing items in the datastore

Definition Classes
Datastore
val s3: AmazonS3Client

properly authenticated S3 client.
properly authenticated S3 client.

Definition Classes
Datastore
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def url(locator: Locator): URL

Gets the URL for an item in the datastore
Gets the URL for an item in the datastore
locator
locator of the item
returns
URL pointing to the locator

Definition Classes
Datastore
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def wipeCache(): Unit

Wipes the cache for this datastore
Wipes the cache for this datastore

Definition Classes
Datastore

Related Doc: package datastore

object PrivateDatastore extends Datastore

Type Members

class AccessDeniedException extends DsException

class AlreadyExistsException extends DsException

class DoesNotExistException extends DsException

class DsException extends Exception

case class Locator(group: String, name: String, version: Int, directory: Boolean) extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Locator extends Serializable

final def asInstanceOf[T0]: T0

def bucketName: String

def clone(): AnyRef

def createBucketIfNotExists(): Unit

def directoryExists(group: String, name: String, version: Int): Boolean

def directoryPath(group: String, name: String, version: Int): Path

def directoryUrl(group: String, name: String, version: Int): URL

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exists(locator: Locator): Boolean

def fileExists(group: String, name: String, version: Int): Boolean

def filePath(group: String, name: String, version: Int): Path

def fileUrl(group: String, name: String, version: Int): URL

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

val internalLogger: Logger

final def isInstanceOf[T0]: Boolean

def listGroupContents(group: String): SortedSet[Locator]

def listGroups: SortedSet[String]

object logger

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def path(locator: Locator): Path

def publish(path: Path, locator: Locator, overwrite: Boolean): Unit

def publishDirectory(path: Path, group: String, name: String, version: Int, overwrite: Boolean): Unit

def publishDirectory(path: String, group: String, name: String, version: Int, overwrite: Boolean): Unit

def publishFile(file: Path, group: String, name: String, version: Int, overwrite: Boolean): Unit

def publishFile(file: String, group: String, name: String, version: Int, overwrite: Boolean): Unit

val s3: AmazonS3Client

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def url(locator: Locator): URL

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def wipeCache(): Unit

Inherited from Datastore

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped