Package org.alfresco.repo.content.caching

Class CachingContentStore

java.lang.Object

org.alfresco.repo.content.caching.CachingContentStore

All Implemented Interfaces:

ContentStore, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationEventPublisherAware

public class CachingContentStore
extends Object
implements ContentStore, org.springframework.context.ApplicationEventPublisherAware, org.springframework.beans.factory.BeanNameAware

Implementation of ContentStore that wraps any other ContentStore (the backing store) transparently providing caching of content in that backing store.

CachingContentStore should only be used to wrap content stores that are significantly slower that FileContentStore - otherwise performance may actually degrade from its use.

It is important that cacheOnInbound is set to true for exceptionally slow backing stores.

This store handles the FileContentStore.SPOOF_PROTOCOL and can be used to wrap stores that do not handle the protocol out of the box e.g. the S3 connector's store.

Author:

Matt Ward

Field Summary

Fields inherited from interface org.alfresco.repo.content.ContentStore

NEW_CONTENT_CONTEXT, PROTOCOL_DELIMITER

Constructor Summary

Constructors

Constructor	Description
CachingContentStore()
CachingContentStore(ContentStore backingStore, ContentCache cache, boolean cacheOnInbound)

Method Summary

Modifier and Type	Method	Description
boolean	delete(String contentUrl)
boolean	exists(String contentUrl)
String	getBackingStoreDescription()
String	getBackingStoreType()
String	getBeanName()
ContentCache	getCache()
int	getMaxCacheTries()
QuotaManagerStrategy	getQuota()
ContentReader	getReader(String contentUrl)
String	getRootLocation()
long	getSpaceFree()
long	getSpaceTotal()
Map<String,String>	getStorageProperties(String contentUrl)
ContentWriter	getWriter(ContentContext context)
void	init()	Initialisation method, should be called once the CachingContentStore has been constructed.
boolean	isCacheOnInbound()
boolean	isContentDirectUrlEnabled()
boolean	isContentDirectUrlEnabled(String contentUrl)
boolean	isContentUrlSupported(String contentUrl)
boolean	isWriteSupported()
ReentrantReadWriteLock	readWriteLock(String url)	Get a ReentrantReadWriteLock for a given URL.
DirectAccessUrl	requestContentDirectUrl(String contentUrl, boolean attachment, String fileName)
DirectAccessUrl	requestContentDirectUrl(String contentUrl, boolean attachment, String fileName, Long validFor)
DirectAccessUrl	requestContentDirectUrl(String contentUrl, boolean attachment, String fileName, String mimeType, Long validFor)
boolean	requestRestoreContentFromArchive(String contentUrl, Map<String,Serializable> restoreParams)
boolean	requestSendContentToArchive(String contentUrl, Map<String,Serializable> archiveParams)
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
void	setBackingStore(ContentStore backingStore)
void	setBeanName(String name)
void	setCache(ContentCache cache)
void	setCacheOnInbound(boolean cacheOnInbound)
void	setMaxCacheTries(int maxCacheTries)
void	setQuota(QuotaManagerStrategy quota)	Sets the QuotaManagerStrategy that will be used.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.repo.content.ContentStore

requestContentDirectUrl

Constructor Details

CachingContentStore

public CachingContentStore()

CachingContentStore

public CachingContentStore(ContentStore backingStore,
 ContentCache cache,
 boolean cacheOnInbound)

Method Details

init

public void init()

Initialisation method, should be called once the CachingContentStore has been constructed.

isContentUrlSupported

public boolean isContentUrlSupported(String contentUrl)

Specified by:

isContentUrlSupported in interface ContentStore

isWriteSupported

public boolean isWriteSupported()

Specified by:

isWriteSupported in interface ContentStore

getSpaceFree

public long getSpaceFree()

Specified by:

getSpaceFree in interface ContentStore

getSpaceTotal

public long getSpaceTotal()

Specified by:

getSpaceTotal in interface ContentStore

getRootLocation

public String getRootLocation()

Specified by:

getRootLocation in interface ContentStore

exists

public boolean exists(String contentUrl)

For spoofed URLs, the URL always exists.

Specified by:

exists in interface ContentStore

getReader

public ContentReader getReader(String contentUrl)

This store handles the FileContentStore.SPOOF_PROTOCOL so that underlying stores do not need to implement anything related to spoofing.

Specified by:

getReader in interface ContentStore

getWriter

public ContentWriter getWriter(ContentContext context)

Specified by:

getWriter in interface ContentStore

delete

public boolean delete(String contentUrl)

Specified by:

delete in interface ContentStore

getStorageProperties

public Map<String,String> getStorageProperties(String contentUrl)

Specified by:

getStorageProperties in interface ContentStore

requestSendContentToArchive

public boolean requestSendContentToArchive(String contentUrl,
 Map<String,Serializable> archiveParams)

Specified by:

requestSendContentToArchive in interface ContentStore

requestRestoreContentFromArchive

public boolean requestRestoreContentFromArchive(String contentUrl,
 Map<String,Serializable> restoreParams)

Specified by:

requestRestoreContentFromArchive in interface ContentStore

readWriteLock

public ReentrantReadWriteLock readWriteLock(String url)

Get a ReentrantReadWriteLock for a given URL. The lock is from a pool rather than per URL, so some contention is expected.

Parameters:

url - String

Returns:

ReentrantReadWriteLock

setBackingStore

public void setBackingStore(ContentStore backingStore)

getBackingStoreType

public String getBackingStoreType()

getBackingStoreDescription

public String getBackingStoreDescription()

setCache

public void setCache(ContentCache cache)

getCache

public ContentCache getCache()

setCacheOnInbound

public void setCacheOnInbound(boolean cacheOnInbound)

isCacheOnInbound

public boolean isCacheOnInbound()

getMaxCacheTries

public int getMaxCacheTries()

setMaxCacheTries

public void setMaxCacheTries(int maxCacheTries)

setQuota

public void setQuota(QuotaManagerStrategy quota)

Sets the QuotaManagerStrategy that will be used.

Parameters:

quota - QuotaManagerStrategy

getQuota

public QuotaManagerStrategy getQuota()

setApplicationEventPublisher

public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

getBeanName

public String getBeanName()

isContentDirectUrlEnabled

public boolean isContentDirectUrlEnabled()

Specified by:

isContentDirectUrlEnabled in interface ContentStore

isContentDirectUrlEnabled

public boolean isContentDirectUrlEnabled(String contentUrl)

Specified by:

isContentDirectUrlEnabled in interface ContentStore

requestContentDirectUrl

public DirectAccessUrl requestContentDirectUrl(String contentUrl,
 boolean attachment,
 String fileName)

Specified by:

requestContentDirectUrl in interface ContentStore

requestContentDirectUrl

public DirectAccessUrl requestContentDirectUrl(String contentUrl,
 boolean attachment,
 String fileName,
 Long validFor)

Specified by:

requestContentDirectUrl in interface ContentStore

requestContentDirectUrl

public DirectAccessUrl requestContentDirectUrl(String contentUrl,
 boolean attachment,
 String fileName,
 String mimeType,
 Long validFor)

Specified by:

requestContentDirectUrl in interface ContentStore