Package edu.ucsb.nceas.metacat.dataone.quota

Class QuotaServiceManager

java.lang.Object

edu.ucsb.nceas.metacat.dataone.quota.QuotaServiceManager

public class QuotaServiceManager
extends Object

A class manages the quota service for users

Author:

tao

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTIVE
static final String	ARCHIVEMETHOD
static final String	CREATEMETHOD
static final String	DELETED
static final String	DELETEMETHOD
static final String	INACTIVE
static final String	PROPERTYNAMEOFPORTALNAMESPACE
static final String	QUOTASUBJECTHEADER
static final String	UPDATEMETHOD
static final String	USAGE

Method Summary

Modifier and Type	Method	Description
protected static Date	combineDateAndGivenTime(Date now, String givenTime)	This method will combine a given date and given time string (in short format) to a new date.
void	enforce(String quotaSubject, org.dataone.service.types.v1.Subject requestor, org.dataone.service.types.v2.SystemMetadata sysmeta, String method)	Enforce quota service
static QuotaServiceManager	getInstance()	Get the singleton instance of the service
boolean	isEnabled()	Check if the quota service is enabled.
void	startDailyCheck()	Start a timer to check failed usage reporting and report them again in daily base.

Methods inherited from class java.lang.Object

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

Field Details

USAGE

public static final String USAGE

See Also:

• Constant Field Values

ACTIVE

public static final String ACTIVE

See Also:

• Constant Field Values

INACTIVE

public static final String INACTIVE

See Also:

• Constant Field Values

DELETED

public static final String DELETED

See Also:

• Constant Field Values

CREATEMETHOD

public static final String CREATEMETHOD

See Also:

• Constant Field Values

UPDATEMETHOD

public static final String UPDATEMETHOD

See Also:

• Constant Field Values

ARCHIVEMETHOD

public static final String ARCHIVEMETHOD

See Also:

• Constant Field Values

DELETEMETHOD

public static final String DELETEMETHOD

See Also:

• Constant Field Values

PROPERTYNAMEOFPORTALNAMESPACE

public static final String PROPERTYNAMEOFPORTALNAMESPACE

See Also:

• Constant Field Values

QUOTASUBJECTHEADER

public static final String QUOTASUBJECTHEADER

See Also:

• Constant Field Values

Method Details

getInstance

public static QuotaServiceManager getInstance()
                                       throws org.dataone.service.exceptions.ServiceFailure

Get the singleton instance of the service

Returns:

the quota service instance. The instance will have a bookeeperClient if the quota service is enabled.

Throws:

IOException

org.dataone.service.exceptions.ServiceFailure

isEnabled

public boolean isEnabled()

Check if the quota service is enabled.

Returns:

true if it is enabled; otherwise false.

startDailyCheck

public void startDailyCheck()

Start a timer to check failed usage reporting and report them again in daily base. Metacat only needs one timer, but this method will be called on four different servlet init methods. So the method has a indicator of already starting a timer and is synchronized to make sure only one timer will be started.

enforce

public void enforce(String quotaSubject,
 org.dataone.service.types.v1.Subject requestor,
 org.dataone.service.types.v2.SystemMetadata sysmeta,
 String method)
             throws org.dataone.service.exceptions.InsufficientResources,
org.dataone.service.exceptions.InvalidRequest,
org.dataone.service.exceptions.ServiceFailure,
org.dataone.service.exceptions.NotImplemented,
org.dataone.service.exceptions.NotFound

Enforce quota service

Parameters:

quotaSubject - the subject of the quota which will be used

requestor - the subject of the user who requests the usage

sysmeta - the system metadata of the object which will use the quota

method - the method name which will call the createUsage method (create or update

Throws:

org.dataone.service.exceptions.InsufficientResources

org.dataone.service.exceptions.InvalidRequest

org.dataone.service.exceptions.ServiceFailure

org.dataone.service.exceptions.NotFound

org.dataone.service.exceptions.NotImplemented

combineDateAndGivenTime

protected static Date combineDateAndGivenTime(Date now,
 String givenTime)
                                       throws HandlerException

This method will combine a given date and given time string (in short format) to a new date. If the given time (e.g 10:00 AM) is before the given date (e.g 2:00 PM Aug 21, 2005), then the time will set to the following day, 10:00 AM Aug 22, 2005. If the given time (e.g 10:00 AM) is after the given date (e.g 8:00 AM Aug 21, 2005), the time will set to be 10:00 AM Aug 21, 2005.

Parameters:

now - the date will be combine

givenTime - the format should be "10:00 AM " or "2:00 PM"

Returns:

the Date object

Throws:

HandlerException