Package org.alfresco.filesys.repo

Class UserQuotaDetails

java.lang.Object

org.alfresco.filesys.repo.UserQuotaDetails

public class UserQuotaDetails
extends Object

User Quota Details Class

Used to track the live usage of a user as files are being written.

Author:

gkspencer

Constructor Summary

Constructors

Constructor	Description
UserQuotaDetails(String userName, long quota)	Class constructor

Method Summary

Modifier and Type	Method	Description
long	addToCurrentUsage(long usage)	Add to the current live usage
long	getAvailableSpace()	Return the available space for this user, -1 is unlimited
long	getCurrentUsage()	Return the current live usage, in bytes
long	getLastUpdated()	Return the time the live usage value was last updated
String	getUserName()	Return the user name
long	getUserQuota()	Return the user quota, in bytes
boolean	hasUserQuota()	Check if the user has a usage quota
void	setCurrentUsage(long usage)	Update the current live usage
void	setUserQuota(long quota)	Set the user quota, in bytes
long	subtractFromCurrentUsage(long usage)	Subtract from the current live usage
String	toString()	Return the user quota details as a string

Methods inherited from class java.lang.Object

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

Constructor Detail

UserQuotaDetails

public UserQuotaDetails(String userName,
                        long quota)

Class constructor

Parameters:

userName - String

quota - long

Method Detail

getUserName

public final String getUserName()

Return the user name

Returns:

String

hasUserQuota

public final boolean hasUserQuota()

Check if the user has a usage quota

Returns:

boolean

getUserQuota

public final long getUserQuota()

Return the user quota, in bytes

Returns:

long

getCurrentUsage

public final long getCurrentUsage()

Return the current live usage, in bytes

Returns:

long

getLastUpdated

public final long getLastUpdated()

Return the time the live usage value was last updated

Returns:

long

getAvailableSpace

public final long getAvailableSpace()

Return the available space for this user, -1 is unlimited

Returns:

long

setUserQuota

public final void setUserQuota(long quota)

Set the user quota, in bytes

Parameters:

quota - long

setCurrentUsage

public final void setCurrentUsage(long usage)

Update the current live usage

Parameters:

usage - long

addToCurrentUsage

public final long addToCurrentUsage(long usage)

Add to the current live usage

Parameters:

usage - long

Returns:

long

subtractFromCurrentUsage

public final long subtractFromCurrentUsage(long usage)

Subtract from the current live usage

Parameters:

usage - long

Returns:

long

toString

public String toString()

Return the user quota details as a string

Overrides:

toString in class Object

Returns:

String