com.jalios.jcms
Class BasicStoreListener

java.lang.Object
  com.jalios.jcms.BasicStoreListener

All Implemented Interfaces:

PluginComponent, StoreListener

Direct Known Subclasses:

AbstractFileIndexListener, AbstractLinkIndexListener, AudienceRights, CategoryListener, CategorySearchEngineListener, DataListener, DescriptiveURLs.DescriptiveURLsListener, FileDocumentListener, GroupListener, ImportDataListener, JSyncDataListener, MemberListener, PublicationListener, StatReportListener, WeakLinkManager, WorkspaceListener, WSTypeEntryListener

public class BasicStoreListener
extends Object
implements StoreListener, PluginComponent

This class is a neutral implementation of StoreListener. It is intended to be used to developp custom StoreListener. It avoids the sub-class to implement not used methods of StoreListener. It implements the Comparable interface. This interface is required since JCMS 5.5.0 ; so that StoreListener can be invoked in a custom order. Default order is 0. When 2 BasicStoreListeners are equal they are ordered according their class name, then according their hashCode.

Since:

jcms-5.7.3

Version:

$Revision: 21414 $

Author:

Jean-Philippe Encausse

Field Summary

static String

REVISION

Constructor Summary

BasicStoreListener()

Method Summary

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.
void	handlePrepareUpdate(Storable storable, Map attributes, boolean firstTime) This method gets called when before a storable will be updated.
boolean	init(Plugin plugin) Initialize the component with the given plugin configuration

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

Constructor Detail

BasicStoreListener

public BasicStoreListener()

Method Detail

init

public boolean init(Plugin plugin)

Description copied from interface: PluginComponent

Initialize the component with the given plugin configuration

Specified by:

init in interface PluginComponent

Parameters:

plugin - the calling plugin

Returns:

true if the component has been correctly initialized.

Since:

jcms-5.7.1

See Also:

PluginComponent.init(Plugin)

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

Parameters:

storable - the storable

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

See Also:

StoreListener.handleCreate(Storable, boolean)

handlePrepareUpdate

public void handlePrepareUpdate(Storable storable,
                                Map attributes,
                                boolean firstTime)

Description copied from interface: StoreListener

This method gets called when before a storable will be updated.
deprecated It should not be used anymore and will be removed from future version.

Specified by:

handlePrepareUpdate in interface StoreListener

Parameters:

storable - the storable

attributes - the attributes to update

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

See Also:

StoreListener.handlePrepareUpdate(Storable, Map, 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

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

Parameters:

storable - the storable

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

See Also:

StoreListener.handleDelete(Storable, boolean)