org.nuxeo.ecm.quota.size

Class QuotaAwareDocument

java.lang.Object

org.nuxeo.ecm.quota.size.QuotaAwareDocument

All Implemented Interfaces:

QuotaAware

public class QuotaAwareDocument
extends Object
implements QuotaAware

Adapter to manage a DocumentModel that supports Quotas

Since:

5.6

Author:

Tiry

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentModel	doc
static String	DOCUMENTS_SIZE_INNER_SIZE_PROPERTY
static String	DOCUMENTS_SIZE_MAX_SIZE_PROPERTY
static String	DOCUMENTS_SIZE_STATISTICS_FACET
static String	DOCUMENTS_SIZE_TOTAL_SIZE_PROPERTY
static String	DOCUMENTS_SIZE_TRASH_SIZE_PROPERTY
static String	DOCUMENTS_SIZE_VERSIONS_SIZE_PROPERTY
protected static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
QuotaAwareDocument(DocumentModel doc)

Method Summary

Modifier and Type	Method and Description
protected Number	addDelta(String property, long delta)
void	addInnerSize(long delta)
void	addTotalSize(long delta)
void	addTrashSize(long delta)
void	addVersionsSize(long delta)
void	clearInfos() Resets quota info but keeps the user-specified max quota size, if present.
protected void	clearMaxSize()
DocumentModel	getDoc()
long	getInnerSize()
long	getMaxQuota()
QuotaInfo	getQuotaInfo()
long	getTotalSize()
long	getTrashSize()
long	getVersionsSize()
void	resetInfos()
void	save()
void	setAll(long innerSize, long totalSize, long trashSize, long versionsSize) Set all quota info.
void	setMaxQuota(long maxSize)
void	setMaxQuota(long maxSize, boolean skipValidation)

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENTS_SIZE_STATISTICS_FACET

public static final String DOCUMENTS_SIZE_STATISTICS_FACET

See Also:

Constant Field Values

DOCUMENTS_SIZE_INNER_SIZE_PROPERTY

public static final String DOCUMENTS_SIZE_INNER_SIZE_PROPERTY

See Also:

Constant Field Values

DOCUMENTS_SIZE_TOTAL_SIZE_PROPERTY

public static final String DOCUMENTS_SIZE_TOTAL_SIZE_PROPERTY

See Also:

Constant Field Values

DOCUMENTS_SIZE_TRASH_SIZE_PROPERTY

public static final String DOCUMENTS_SIZE_TRASH_SIZE_PROPERTY

See Also:

Constant Field Values

DOCUMENTS_SIZE_VERSIONS_SIZE_PROPERTY

public static final String DOCUMENTS_SIZE_VERSIONS_SIZE_PROPERTY

See Also:

Constant Field Values

DOCUMENTS_SIZE_MAX_SIZE_PROPERTY

public static final String DOCUMENTS_SIZE_MAX_SIZE_PROPERTY

See Also:

Constant Field Values

doc

protected DocumentModel doc

log

protected static final org.apache.commons.logging.Log log

Constructor Detail

QuotaAwareDocument

public QuotaAwareDocument(DocumentModel doc)

Method Detail

getDoc

public DocumentModel getDoc()

Specified by:

getDoc in interface QuotaAware

getInnerSize

public long getInnerSize()

Specified by:

getInnerSize in interface QuotaAware

getTotalSize

public long getTotalSize()

Specified by:

getTotalSize in interface QuotaAware

getTrashSize

public long getTrashSize()

Specified by:

getTrashSize in interface QuotaAware

getVersionsSize

public long getVersionsSize()

Specified by:

getVersionsSize in interface QuotaAware

addDelta

protected Number addDelta(String property,
                          long delta)

addInnerSize

public void addInnerSize(long delta)

Specified by:

addInnerSize in interface QuotaAware

addTotalSize

public void addTotalSize(long delta)

Specified by:

addTotalSize in interface QuotaAware

addTrashSize

public void addTrashSize(long delta)

Specified by:

addTrashSize in interface QuotaAware

addVersionsSize

public void addVersionsSize(long delta)

Specified by:

addVersionsSize in interface QuotaAware

setAll

public void setAll(long innerSize,
                   long totalSize,
                   long trashSize,
                   long versionsSize)

Description copied from interface: QuotaAware

Set all quota info.

Specified by:

setAll in interface QuotaAware

save

public void save()

Specified by:

save in interface QuotaAware

getMaxQuota

public long getMaxQuota()

Specified by:

getMaxQuota in interface QuotaAware

setMaxQuota

public void setMaxQuota(long maxSize)

Specified by:

setMaxQuota in interface QuotaAware

setMaxQuota

public void setMaxQuota(long maxSize,
                        boolean skipValidation)

Specified by:

setMaxQuota in interface QuotaAware

getQuotaInfo

public QuotaInfo getQuotaInfo()

Specified by:

getQuotaInfo in interface QuotaAware

resetInfos

public void resetInfos()

Specified by:

resetInfos in interface QuotaAware

Since:

5.7

clearInfos

public void clearInfos()

Description copied from interface: QuotaAware

Resets quota info but keeps the user-specified max quota size, if present.

Specified by:

clearInfos in interface QuotaAware

clearMaxSize

protected void clearMaxSize()