com.objectplanet.survey.plugin.interfaces

Interface IUserDiskUsage

public interface IUserDiskUsage

Interface for disk usage limit check. Only one plugin implementing this interface will be used. If multiple plugins are installed of this type, it is unknown which one will be used (most likely the first loaded by the class loader).

Author:

Torgeir Lund

Method Summary

Modifier and Type	Method and Description
long	getCurrentDiskUsage(long userId) Gets the current disk usage, in bytes
long	getDiskUsageLimit(long userId) Gets the disk usage limit, in bytes
boolean	isMaxDiskUsageReached(long userId) Checks if maximum disk usage is reached.
boolean	setDiskUsageLimit(long userId, long maxDiskUsageBytes) Sets the disk usage limit, in bytes

Method Detail

isMaxDiskUsageReached

boolean isMaxDiskUsageReached(long userId)
                       throws SurveySystemException

Checks if maximum disk usage is reached.

Parameters:

userId - User who is being checked

Returns:

True if maximum allowed disk usage is reached for this user. If user is not found, false should be returned.

Throws:

SurveySystemException

getCurrentDiskUsage

long getCurrentDiskUsage(long userId)
                  throws SurveySystemException

Gets the current disk usage, in bytes

Parameters:

userId - id of user to get the disk usage for.

Returns:

The current disk usage in bytes

Throws:

SurveySystemException

setDiskUsageLimit

boolean setDiskUsageLimit(long userId,
                          long maxDiskUsageBytes)
                   throws SurveySystemException

Sets the disk usage limit, in bytes

Parameters:

userId - The user to set the new usage limit for

maxDiskUsageBytes - The new disk usage limit, in bytes. If value is 0 or less, the value will be ignored and the current default will be used instead.

Returns:

True if value is set, false otherwise (user may not exist)

Throws:

SurveySystemException

getDiskUsageLimit

long getDiskUsageLimit(long userId)
                throws SurveySystemException

Gets the disk usage limit, in bytes

Parameters:

userId - The id of user to get disk usage limit.

Returns:

The disk usage limit, in bytes. -1 if user is not found. 0 if limit is not set.

Throws:

SurveySystemException