Package org.alfresco.repo.content

Class AbstractRoutingContentStore

java.lang.Object

org.alfresco.repo.content.AbstractRoutingContentStore

All Implemented Interfaces:

ContentStore

Direct Known Subclasses:

AbstractTenantRoutingContentStore

public abstract class AbstractRoutingContentStore
extends Object
implements ContentStore

A store providing support for content store implementations that provide routing of content read and write requests based on context.

Since:

2.1

Author:

Derek Hulley

See Also:

• ContentContext

Field Summary

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

NEW_CONTENT_CONTEXT, PROTOCOL_DELIMITER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRoutingContentStore()

Method Summary

Modifier and Type	Method	Description
boolean	delete(String contentUrl)	This operation has to be performed on all the stores in order to maintain the ContentStore.exists(String) contract.
boolean	exists(String contentUrl)
protected abstract List<ContentStore>	getAllStores()
ContentReader	getReader(String contentUrl)
String	getRootLocation()
long	getSpaceFree()
long	getSpaceTotal()
Map<String,String>	getStorageProperties(String contentUrl)
ContentWriter	getWriter(ContentContext context)	Selects a store for the given context and caches store that was used.
ContentWriter	getWriter(ContentReader existingContentReader, String newContentUrl)
boolean	isContentUrlSupported(String contentUrl)
boolean	isWriteSupported()
boolean	requestRestoreContentFromArchive(String contentUrl, Map<String,Serializable> restoreParams)
boolean	requestSendContentToArchive(String contentUrl, Map<String,Serializable> archiveParams)
protected abstract ContentStore	selectWriteStore(ContentContext ctx)	Get a content store based on the context provided.
void	setStoresCache(SimpleCache<Pair<String,String>,ContentStore> storesCache)

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

isContentDirectUrlEnabled, isContentDirectUrlEnabled, requestContentDirectUrl, requestContentDirectUrl, requestContentDirectUrl, requestContentDirectUrl

Constructor Details

AbstractRoutingContentStore

protected AbstractRoutingContentStore()

Method Details

setStoresCache

public void setStoresCache(SimpleCache<Pair<String,String>,ContentStore> storesCache)

Parameters:

storesCache - cache of stores used to access URLs

getAllStores

protected abstract List<ContentStore> getAllStores()

Returns:

Returns a list of all possible stores available for reading or writing

selectWriteStore

protected abstract ContentStore selectWriteStore(ContentContext ctx)

Get a content store based on the context provided. The applicability of the context and even the types of context allowed are up to the implementation, but normally there should be a fallback case for when the parameters are not adequate to make a decision.

Parameters:

ctx - the context to use to make the choice

Returns:

Returns the store most appropriate for the given context and never null

isContentUrlSupported

public boolean isContentUrlSupported(String contentUrl)

Specified by:

isContentUrlSupported in interface ContentStore

Returns:

Returns true if the URL is supported by any of the stores.

isWriteSupported

public boolean isWriteSupported()

Specified by:

isWriteSupported in interface ContentStore

Returns:

Returns true if write is supported by any of the stores.

getRootLocation

public String getRootLocation()

Specified by:

getRootLocation in interface ContentStore

Returns:

Returns . always

getSpaceFree

public long getSpaceFree()

Specified by:

getSpaceFree in interface ContentStore

Returns:

Returns -1 always

getSpaceTotal

public long getSpaceTotal()

Specified by:

getSpaceTotal in interface ContentStore

Returns:

Returns -1 always

exists

public boolean exists(String contentUrl)
               throws ContentIOException

Specified by:

exists in interface ContentStore

Throws:

ContentIOException

See Also:

• selectReadStore(String)

getReader

public ContentReader getReader(String contentUrl)
                        throws ContentIOException

Specified by:

getReader in interface ContentStore

Returns:

Returns a valid reader from one of the stores otherwise a EmptyContentReader is returned.

Throws:

ContentIOException

getWriter

public ContentWriter getWriter(ContentContext context)
                        throws ContentIOException

Selects a store for the given context and caches store that was used.

Specified by:

getWriter in interface ContentStore

Throws:

ContentIOException

See Also:

• selectWriteStore(ContentContext)

getWriter

public ContentWriter getWriter(ContentReader existingContentReader,
 String newContentUrl)
                        throws ContentIOException

Throws:

ContentIOException

delete

public boolean delete(String contentUrl)
               throws ContentIOException

This operation has to be performed on all the stores in order to maintain the ContentStore.exists(String) contract.

Specified by:

delete in interface ContentStore

Throws:

ContentIOException

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