info.magnolia.module.cache

Class AbstractListeningFlushPolicy

java.lang.Object

info.magnolia.module.cache.AbstractListeningFlushPolicy

All Implemented Interfaces:

FlushPolicy

Direct Known Subclasses:

FlushAllListeningPolicy

public abstract class AbstractListeningFlushPolicy
extends Object
implements FlushPolicy

Implemenation of the FlushPolicy providing functionality for triggering flush operation based on changes in observed workspaces.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractListeningFlushPolicy.CacheCleaner Event listener triggering the cleanup of the cache.

Constructor Summary

Constructors

Constructor and Description
AbstractListeningFlushPolicy() Deprecated. since 5.4. Use AbstractListeningFlushPolicy(CacheModule, RepositoryManager) instead.
AbstractListeningFlushPolicy(CacheModule cacheModule, info.magnolia.repository.RepositoryManager repositoryManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRepository(String repository) Deprecated. since 5.4. Use setWorkspaces(List) instead.
protected void	flushByUUID(String uuid, String repository, Cache cache) Flushes all content related to given uuid&repository combination from provided cache.
List<String>	getExcludedWorkspaces() The workspaces to which the listener is NOT attached.
protected String	getPath(Cache cache)
List<String>	getRepositories() Deprecated. since 5.4. Use getWorkspaces() instead.
List<String>	getWorkspaces() The workspaces to which the listener is attached - upon any event on these, the cache is cleared.
protected abstract void	handleSingleEvent(Cache cache, String repository, javax.jcr.observation.Event event) Implement this method to react on each and every event on a given cache and repository, even if multiple where buffered.
protected abstract void	postHandleEvents(Cache cache, String repository) Implement this method to wrap up flushing process after all single events have been processed.
protected abstract boolean	preHandleEvents(Cache cache, String repository) Implement this method to react on buffered events on a given cache and repository.
void	setExcludedWorkspaces(List<String> excludedWorkspaces)
void	setRepositories(List<String> repositories) Deprecated. since 5.4. Use setWorkspaces(List) instead.
void	setWorkspaces(List<String> workspaces)
void	start(Cache cache)
void	stop(Cache cache)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractListeningFlushPolicy

public AbstractListeningFlushPolicy()

Deprecated. since 5.4. Use AbstractListeningFlushPolicy(CacheModule, RepositoryManager) instead.

AbstractListeningFlushPolicy

@Inject
public AbstractListeningFlushPolicy(CacheModule cacheModule,
                                   info.magnolia.repository.RepositoryManager repositoryManager)

Method Detail

start

public void start(Cache cache)

Specified by:

start in interface FlushPolicy

getPath

protected String getPath(Cache cache)

stop

public void stop(Cache cache)

Specified by:

stop in interface FlushPolicy

preHandleEvents

protected abstract boolean preHandleEvents(Cache cache,
                      String repository)

Implement this method to react on buffered events on a given cache and repository.

Returns:

true if single events should be processed as well, false otherwise.

postHandleEvents

protected abstract void postHandleEvents(Cache cache,
                    String repository)

Implement this method to wrap up flushing process after all single events have been processed. This method will be invoked only if preHandleEvents(Cache, String) returns true;

handleSingleEvent

protected abstract void handleSingleEvent(Cache cache,
                     String repository,
                     javax.jcr.observation.Event event)

Implement this method to react on each and every event on a given cache and repository, even if multiple where buffered. This method will be invoked only if preHandleEvents(Cache, String) returns true;

flushByUUID

protected void flushByUUID(String uuid,
               String repository,
               Cache cache)

Flushes all content related to given uuid&repository combination from provided cache. Note that more then only one pages can be flushed when this method is called.

getWorkspaces

public List<String> getWorkspaces()

The workspaces to which the listener is attached - upon any event on these, the cache is cleared.

setWorkspaces

public void setWorkspaces(List<String> workspaces)

getExcludedWorkspaces

public List<String> getExcludedWorkspaces()

The workspaces to which the listener is NOT attached.

setExcludedWorkspaces

public void setExcludedWorkspaces(List<String> excludedWorkspaces)

getRepositories

public List<String> getRepositories()

Deprecated. since 5.4. Use getWorkspaces() instead.

setRepositories

public void setRepositories(List<String> repositories)

Deprecated. since 5.4. Use setWorkspaces(List) instead.

addRepository

public void addRepository(String repository)

Deprecated. since 5.4. Use setWorkspaces(List) instead.