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

Fields inherited from interface org.nuxeo.ecm.quota.size.QuotaAware

QUOTA_TOTALSIZE_CACHE_NAME

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 additionalSize, boolean save)
void	addTotalSize(long additionalSize, boolean save)
void	addTrashSize(long additionalSize, boolean save)
void	addVersionsSize(long additionalSize, boolean save)
protected Cache	getCache(String cacheName)
protected String	getCacheEntry(String... params)
DocumentModel	getDoc()
long	getInnerSize()
long	getMaxQuota()
QuotaInfo	getQuotaInfo()
protected Long	getSizeInCache(String cacheName)
long	getTotalSize()
Long	getTotalSizeCache() Returns value of "total size" cache of document OR null if cache does not exist or key does not exist in cache.
long	getTrashSize()
long	getVersionsSize()
protected void	invalidateCache(String cacheName)
void	invalidateTotalSizeCache() Invalidates "total size" key-value in cache if exists.
protected void	putSizeInCache(String cacheName, long size)
void	putTotalSizeCache(long size) Stores "total size" value in cache if it exists.
void	resetInfos(boolean save)
void	save()
void	save(boolean disableNotifications)
void	setInnerSize(long size, boolean save)
void	setMaxQuota(long maxSize, boolean save)
void	setMaxQuota(long maxSize, boolean save, boolean skipValidation)
boolean	totalSizeCacheExists()

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

setInnerSize

public void setInnerSize(long size,
                         boolean save)

Specified by:

setInnerSize in interface QuotaAware

addDelta

protected Number addDelta(String property,
                          long delta)

addInnerSize

public void addInnerSize(long additionalSize,
                         boolean save)

Specified by:

addInnerSize in interface QuotaAware

addTotalSize

public void addTotalSize(long additionalSize,
                         boolean save)

Specified by:

addTotalSize in interface QuotaAware

addTrashSize

public void addTrashSize(long additionalSize,
                         boolean save)

Specified by:

addTrashSize in interface QuotaAware

addVersionsSize

public void addVersionsSize(long additionalSize,
                            boolean save)

Specified by:

addVersionsSize in interface QuotaAware

save

public void save()

Specified by:

save in interface QuotaAware

save

public void save(boolean disableNotifications)

Specified by:

save in interface QuotaAware

getMaxQuota

public long getMaxQuota()

Specified by:

getMaxQuota in interface QuotaAware

setMaxQuota

public void setMaxQuota(long maxSize,
                        boolean save,
                        boolean skipValidation)

Specified by:

setMaxQuota in interface QuotaAware

setMaxQuota

public void setMaxQuota(long maxSize,
                        boolean save)

Specified by:

setMaxQuota in interface QuotaAware

getQuotaInfo

public QuotaInfo getQuotaInfo()

Specified by:

getQuotaInfo in interface QuotaAware

resetInfos

public void resetInfos(boolean save)

Specified by:

resetInfos in interface QuotaAware

Since:

5.7

invalidateTotalSizeCache

public void invalidateTotalSizeCache()
                              throws IOException

Description copied from interface: QuotaAware

Invalidates "total size" key-value in cache if exists.

Specified by:

invalidateTotalSizeCache in interface QuotaAware

Throws:

IOException - when unable to invalidate key-value

getCache

protected Cache getCache(String cacheName)

invalidateCache

protected void invalidateCache(String cacheName)
                        throws IOException

Throws:

IOException

getTotalSizeCache

public Long getTotalSizeCache()
                       throws IOException

Description copied from interface: QuotaAware

Returns value of "total size" cache of document OR null if cache does not exist or key does not exist in cache.

Specified by:

getTotalSizeCache in interface QuotaAware

Returns:

Long object or null

Throws:

IOException

getSizeInCache

protected Long getSizeInCache(String cacheName)
                       throws IOException

Throws:

IOException

putTotalSizeCache

public void putTotalSizeCache(long size)
                       throws IOException

Description copied from interface: QuotaAware

Stores "total size" value in cache if it exists.

Specified by:

putTotalSizeCache in interface QuotaAware

Throws:

IOException - if unable to store value

putSizeInCache

protected void putSizeInCache(String cacheName,
                              long size)
                       throws IOException

Throws:

IOException

totalSizeCacheExists

public boolean totalSizeCacheExists()

Specified by:

totalSizeCacheExists in interface QuotaAware

Returns:

true if "total size" cache exists otherwise false.

getCacheEntry

protected String getCacheEntry(String... params)