org.codice.ddf.persistence.attributes

Interface AttributesStore

All Known Implementing Classes:

AttributesStoreImpl

public interface AttributesStore

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_USAGE_KEY
static String	DATA_USAGE_LIMIT_KEY
static String	USER_KEY

Method Summary

Modifier and Type	Method and Description
List<Map<String,Object>>	getAllUsers() Gets a list of all users and their attributes
long	getCurrentDataUsageByUser(String username) Returns the user's current data usage from the persistent store
long	getDataLimitByUser(String username) Returns the user's current data limit from the persistent store
void	resetUserDataUsages() Resets all known user's data usages to 0.
void	setDataLimit(String username, long dataLimit) Resets the user's data limit in the persistent store to the size specified in bytes
void	setDataUsage(String username, long dataUsage) Resets the user's data usage in the persistent store to the usage specified in bytes
void	updateUserDataUsage(String username, long dataUsage) Adds the specified data usage in bytes to the user's data usage in the persistent store

Field Detail

DATA_USAGE_KEY

static final String DATA_USAGE_KEY

See Also:

Constant Field Values

DATA_USAGE_LIMIT_KEY

static final String DATA_USAGE_LIMIT_KEY

See Also:

Constant Field Values

USER_KEY

static final String USER_KEY

See Also:

Constant Field Values

Method Detail

getCurrentDataUsageByUser

long getCurrentDataUsageByUser(String username)
                        throws PersistenceException

Returns the user's current data usage from the persistent store

Parameters:

username -

Returns:

data usage

Throws:

PersistenceException

getDataLimitByUser

long getDataLimitByUser(String username)
                 throws PersistenceException

Returns the user's current data limit from the persistent store

Parameters:

username -

Returns:

Throws:

PersistenceException

updateUserDataUsage

void updateUserDataUsage(String username,
                         long dataUsage)
                  throws PersistenceException

Adds the specified data usage in bytes to the user's data usage in the persistent store

Parameters:

username -

dataUsage -

Throws:

PersistenceException

setDataUsage

void setDataUsage(String username,
                  long dataUsage)
           throws PersistenceException

Resets the user's data usage in the persistent store to the usage specified in bytes

Parameters:

username -

dataUsage -

Throws:

PersistenceException

setDataLimit

void setDataLimit(String username,
                  long dataLimit)
           throws PersistenceException

Resets the user's data limit in the persistent store to the size specified in bytes

Parameters:

username -

dataLimit -

Throws:

PersistenceException

getAllUsers

List<Map<String,Object>> getAllUsers()
                              throws PersistenceException

Gets a list of all users and their attributes

Returns:

a list of users and their data usage properties

Throws:

PersistenceException

resetUserDataUsages

void resetUserDataUsages()
                  throws PersistenceException

Resets all known user's data usages to 0.

Throws:

PersistenceException