ninja

Class Bucket

java.lang.Object

ninja.Bucket

public class Bucket
extends Object

Represents a bucket.

Internally a bucket is just a directory within the base directory.

Constructor Summary

Constructors

Constructor and Description
Bucket(File file) Creates a new bucket based on the given directory.

Method Summary

Modifier and Type	Method and Description
void	create() Creates the bucket.
void	delete() Deletes the bucket and all of its contents.
boolean	exists() Determines if the bucket exists.
File	getFile() Returns the underlying directory as File.
String	getName() Returns the name of the bucket.
StoredObject	getObject(String id) Returns the child object with the given id.
List<StoredObject>	getObjects() Returns a list of all stored objects
boolean	isPrivate() Determines if the bucket is private or public accessible
void	makePrivate() Marks the bucket as private accessible.
void	makePublic() Marks the bucket as public accessible.
void	outputObjects(XMLStructuredOutput output, int limit, String marker, String prefix) Returns a list of at most the provided number of stored objects

Methods inherited from class java.lang.Object

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

Constructor Detail

Bucket

public Bucket(File file)

Creates a new bucket based on the given directory.

Parameters:

file - the directory which stores the contents of the bucket.

Method Detail

getName

public String getName()

Returns the name of the bucket.

Returns:

the name of the bucket

delete

public void delete()

Deletes the bucket and all of its contents.

create

public void create()

Creates the bucket.

If the underlying directory already exists, nothing happens.

getObjects

public List<StoredObject> getObjects()

Returns a list of all stored objects

Returns:

a list of all objects in the bucket.

outputObjects

public void outputObjects(XMLStructuredOutput output,
                          int limit,
                          @Nullable
                          String marker,
                          @Nullable
                          String prefix)

Returns a list of at most the provided number of stored objects

Parameters:

output - the xml structured output the list of objects should be written to

limit - controls the maximum number of objects returned

marker - the key to start with when listing objects in a bucket

prefix - limits the response to keys that begin with the specified prefix

isPrivate

public boolean isPrivate()

Determines if the bucket is private or public accessible

Returns:

true if the bucket is public accessible, false otherwise

makePrivate

public void makePrivate()

Marks the bucket as private accessible.

makePublic

public void makePublic()

Marks the bucket as public accessible.

getFile

public File getFile()

Returns the underlying directory as File.

Returns:

a File representing the underlying directory

exists

public boolean exists()

Determines if the bucket exists.

Returns:

true if the bucket exists, false otherwise

getObject

public StoredObject getObject(String id)

Returns the child object with the given id.

Parameters:

id - the name of the requested child object. Must not contain .. / or \

Returns:

the object with the given id, might not exist, but is always non null