S3Bucket

Instance Constructors

new S3Bucket(bucketName: String, credentialsFactory: () ⇒ AWSCredentials = ...)

bucketName
the name of the bucket
credentialsFactory
optional AWS credentials factory to use (since AWSCredentials are not serializable). If the parameter is not supplied, they will be retrieved from the eu.shiftforward.apso.aws.CredentialStore.

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def backup(key: String): Boolean

Backups a remote file with the given key.
Backups a remote file with the given key. A backup consists in copying the supplied file to a backup folder under the same bucket and folder the file is currently in.
key
the remote pathname to backup
returns
true if the backup was successful, false otherwise.
val bucketName: String

the name of the bucket
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def createDirectory(key: String): Boolean

Creates an empty directory at the given key location
Creates an empty directory at the given key location
key
the remote pathname to the directory
returns
true if the directory was created successfully, false otherwise.
def delete(key: String): Boolean

Deletes the file in the location specified by key in the bucket.
Deletes the file in the location specified by key in the bucket.
key
the remote pathname for the file
returns
true if the deletion was successful, false otherwise.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
S3Bucket → AnyRef → Any
def exists(key: String): Boolean

Checks if the file in the location specified by key in the bucket exists.
Checks if the file in the location specified by key in the bucket exists.
key
the remote pathname for the file
returns
true if the file exists, false otherwise.
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 getFilesWithMatchingPrefix(prefix: String, includeDirectories: Boolean = false): Iterator[String]

Returns a list of filenames and directories in a bucket matching a given prefix.
Returns a list of filenames and directories in a bucket matching a given prefix.
prefix
the prefix to match
returns
a list of filenames in a bucket matching a given prefix.
def getObjectsWithMatchingPrefix(prefix: String, includeDirectories: Boolean = false): Iterator[S3ObjectSummary]

Returns a list of objects in a bucket matching a given prefix.
Returns a list of objects in a bucket matching a given prefix.
prefix
the prefix to match
returns
a list of objects in a bucket matching a given prefix.
def hashCode(): Int

Definition Classes
AnyRef → Any
def isDirectory(key: String): Boolean

Checks if the location specified by key is a directory.
Checks if the location specified by key is a directory.
key
the remote pathname to the directory
returns
true if the path is a directory, false otherwise.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
lazy val log: Logger

The Logger object.
The Logger object. This logger will have the same name as the concrete class into which this trait is mixed-in.

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pull(key: String, destination: String): Boolean

Pulls a remote file with the given key, to the local storage in the pathname provided by destination.
Pulls a remote file with the given key, to the local storage in the pathname provided by destination.
key
the remote pathname to pull from
destination
the local pathname to pull to
returns
true if the pull was successful, false otherwise
def push(key: String, inputStream: InputStream, length: Option[Long]): Boolean

Pushes a given InputStream to the location specified by key in the bucket.
Pushes a given InputStream to the location specified by key in the bucket.
key
the remote pathname for the file
inputStream
the InputStream to push
length
the content lenght (setting this to None can impact performance
returns
true if the push was successful, false otherwise.
def push(key: String, file: File): Boolean

Pushes a given local File to the location specified by key in the bucket.
Pushes a given local File to the location specified by key in the bucket.
key
the remote pathname for the file
file
the local File to push
returns
true if the push was successful, false otherwise.
def setAcl(key: String, acl: CannedAccessControlList): Unit

Sets an access control list on a given Amazon S3 object.
Sets an access control list on a given Amazon S3 object.
key
the remote pathname for the file
acl
the CannedAccessControlList to be applied to the Amazon S3 object
def size(key: String): Long

Returns size of the file in the location specified by key in the bucket.
Returns size of the file in the location specified by key in the bucket. If the file doesn't exist the return value is 0.
key
the remote pathname for the file
returns
the size of the file in the location specified by key in the bucket if the exists, 0 otherwise.
def stream(key: String): InputStream
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

Related Doc: package aws

class S3Bucket extends Logging with Serializable

Instance Constructors

new S3Bucket(bucketName: String, credentialsFactory: () ⇒ AWSCredentials = ...)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def backup(key: String): Boolean

val bucketName: String

def clone(): AnyRef

def createDirectory(key: String): Boolean

def delete(key: String): Boolean

final def eq(arg0: AnyRef): Boolean

def equals(obj: Any): Boolean

def exists(key: String): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getFilesWithMatchingPrefix(prefix: String, includeDirectories: Boolean = false): Iterator[String]

def getObjectsWithMatchingPrefix(prefix: String, includeDirectories: Boolean = false): Iterator[S3ObjectSummary]

def hashCode(): Int

def isDirectory(key: String): Boolean

final def isInstanceOf[T0]: Boolean

lazy val log: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def pull(key: String, destination: String): Boolean

def push(key: String, inputStream: InputStream, length: Option[Long]): Boolean

def push(key: String, file: File): Boolean

def setAcl(key: String, acl: CannedAccessControlList): Unit

def size(key: String): Long

def stream(key: String): InputStream

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped