Package com.jalios.jcms.workspace

Class WorkspaceListener

java.lang.Object

com.jalios.jcms.BasicStoreListener

com.jalios.jcms.workspace.WorkspaceListener

All Implemented Interfaces:

PluginComponent, StoreListener

public class WorkspaceListener
extends BasicStoreListener

This class represent a Listener for Workspace Objects

Since:

jcms-4.1

Author:

Jean-Philippe Encausse

Constructor Summary

Constructors

Constructor	Description
WorkspaceListener()

Method Summary

Modifier and Type	Method	Description
protected void	clearMemberIsWorkerCache()	Clears Member isWorker status cache.
static java.util.concurrent.ConcurrentHashMap<Category,java.util.Set<Workspace>>	getCategoryToWorkspaceSet()	Return the internal map used to track the association of Workspace's root category to the workspace using it.
void	handleCommitUpdate(Storable storable, Storable oldStorable, boolean firstTime)	This method gets called when after a storable has been updated.
void	handleCreate(Storable storable, boolean firstTime)	This method gets called when a storable is created.
void	handleDelete(Storable storable, boolean firstTime)	This method gets called when a storable is deleted.
protected void	updateAdminMembers(Workspace workspace, boolean add)	Update workspaceSet index of JStore Member.
protected void	updateDefaultWorkspace(Workspace workspace)
protected void	updateIncomingMailPattern(Workspace workspace, Workspace oldWorkspace)	Updates the Workspace incoming mail pattern when site is ready.
protected void	updateWKRoles(Workspace workspace)

Methods inherited from class com.jalios.jcms.BasicStoreListener

handlePrepareUpdate, init

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceListener

public WorkspaceListener()

Method Detail

handleCreate

public void handleCreate(Storable storable,
                         boolean firstTime)

Description copied from interface: StoreListener

This method gets called when a storable is created.

Specified by:

handleCreate in interface StoreListener

Overrides:

handleCreate in class BasicStoreListener

Parameters:

storable - the storable

firstTime - true if it is the first time this operation is processed

See Also:

StoreListener.handleCreate(Storable, boolean)

handleCommitUpdate

public void handleCommitUpdate(Storable storable,
                               Storable oldStorable,
                               boolean firstTime)

Description copied from interface: StoreListener

This method gets called when after a storable has been updated.

Specified by:

handleCommitUpdate in interface StoreListener

Overrides:

handleCommitUpdate in class BasicStoreListener

Parameters:

storable - the storable, this instance is the object that was created at first and that will be stored in jcms until deletion of the storable with this ID. You should always manipulate this object if you maintain any index.

oldStorable - the previous version of the storable, it is a clone, do not use in any index, it should only be used to access old values.

firstTime - true if it is the first time this operation is processed

See Also:

StoreListener.handleCommitUpdate(Storable, Storable, boolean)

handleDelete

public void handleDelete(Storable storable,
                         boolean firstTime)

Description copied from interface: StoreListener

This method gets called when a storable is deleted.

Specified by:

handleDelete in interface StoreListener

Overrides:

handleDelete in class BasicStoreListener

Parameters:

storable - the storable

firstTime - true if it is the first time this operation is processed

See Also:

StoreListener.handleDelete(Storable, boolean)

updateDefaultWorkspace

protected void updateDefaultWorkspace(Workspace workspace)

updateWKRoles

protected void updateWKRoles(Workspace workspace)

updateAdminMembers

protected void updateAdminMembers(Workspace workspace,
                                  boolean add)

Update workspaceSet index of JStore Member.

(DBMember do not have index, and their cache are handled differently)

Parameters:

workspace - the workspace

add - true to add members to the workspace, false to remove it

Since:

jcms-6.1.4, jcms-7.0.2, jcms-7.1

updateIncomingMailPattern

protected void updateIncomingMailPattern(Workspace workspace,
                                         Workspace oldWorkspace)

Updates the Workspace incoming mail pattern when site is ready.

Parameters:

workspace - the current Workspace (must be null in delete case)

oldWorkspace - the Workspace before update / delete (null in create case)

Since:

jcms-9.0.0

clearMemberIsWorkerCache

protected void clearMemberIsWorkerCache()

Clears Member isWorker status cache.

Since:

jcms-9.0.5 - JCMS-5683

getCategoryToWorkspaceSet

public static java.util.concurrent.ConcurrentHashMap<Category,java.util.Set<Workspace>> getCategoryToWorkspaceSet()

Return the internal map used to track the association of Workspace's root category to the workspace using it.

Read access is thread safe, but DO NOT ALTER the content of this collection.

Returns:

a ConcurrentHashMap

Since:

10.0.8 / JCMS-10792