sirius.biz.jdbc.storage

Class BucketInfo

java.lang.Object

sirius.biz.jdbc.storage.BucketInfo

public class BucketInfo
extends Object

Represents metadata available for a bucket.

Most of this is taken from storage.buckets.[bucketName] from the system config.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BucketInfo(sirius.kernel.settings.Extension extension) Creates a new bucket info based on the given config section.

Method Summary

Modifier and Type	Method and Description
int	getDeleteFilesAfterDays() Determines the number of days after which objects are automatically deleted.
String	getDescription() Returns the description of the bucket.
PhysicalStorageEngine	getEngine() Determines the PhysicalStorageEngine used to store objects within this bucket.
String	getName() Returns the (technical) name of the bucket.
long	getNumberOfObjects() Counts the total number of objects in this bucket.
String	getPermission() Returns the permission required to access the contents of this bucket.
boolean	isAlwaysUseLikeSearch() Determines if searching in a bucket always uses a like on search.
boolean	isCanCreate() Determines if a user can create new objects in this bucket.
boolean	isCanDelete() Determines if a user can delete objects within this bucket.
boolean	isCanEdit() Determines if a user can edit objects within this bucket.
boolean	isShowPublicURLs() Determines if publicly accessible URLs should be displayed in the backend.

Methods inherited from class java.lang.Object

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

Constructor Detail

BucketInfo

protected BucketInfo(sirius.kernel.settings.Extension extension)

Creates a new bucket info based on the given config section.

Parameters:

extension - the config section holding the bucket infos

Method Detail

getNumberOfObjects

public long getNumberOfObjects()

Counts the total number of objects in this bucket.

Returns:

the total number of objects in this bucket

getName

public String getName()

Returns the (technical) name of the bucket.

Returns:

the name of the bucket

getDescription

public String getDescription()

Returns the description of the bucket.

Returns:

the description of the bucket

getPermission

public String getPermission()

Returns the permission required to access the contents of this bucket.

Returns:

the permission required to access this bucket or null if no special rights are needed

isCanCreate

public boolean isCanCreate()

Determines if a user can create new objects in this bucket.

Returns:

true if a user can create net objects, falefalse otherwise

isCanEdit

public boolean isCanEdit()

Determines if a user can edit objects within this bucket.

Returns:

true if a user can modify an object within this bucket, false otherwise

isCanDelete

public boolean isCanDelete()

Determines if a user can delete objects within this bucket.

Returns:

true if a user can delete an object within this bucket, false otherwise

isAlwaysUseLikeSearch

public boolean isAlwaysUseLikeSearch()

Determines if searching in a bucket always uses a like on search.

Returns:

true if a like on search is to be used, false otherwise

isShowPublicURLs

public boolean isShowPublicURLs()

Determines if publicly accessible URLs should be displayed in the backend.

Returns:

true if public URLs should be shown, false otherwise

getDeleteFilesAfterDays

public int getDeleteFilesAfterDays()

Determines the number of days after which objects are automatically deleted.

This is used for "self organizing" buckets, which automatically drain old data.

Returns:

the number of days after which objects are deleted or 0 to disable auto-deletion

getEngine

public PhysicalStorageEngine getEngine()

Determines the PhysicalStorageEngine used to store objects within this bucket.

Returns:

the storage engine used by this bucket