Package org.hippoecm.hst.configuration.channel

Interface ChannelManagerEventListener

public interface ChannelManagerEventListener

Allows implementers to register callback methods that will be executed when a ChannelManager event occurs.

The channel change events are:

1. creating a Channel
2. updating a Channel

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
void	channelCreated(ChannelManagerEvent event)	Called immediately after a channel has been created through ChannelManager.persist(Session, String, Channel).
void	channelUpdated(ChannelManagerEvent event)	Called immediately after a channel has been updated through ChannelManager.save(Session, String, Channel).

Method Details

channelCreated

void channelCreated(ChannelManagerEvent event)
             throws ChannelManagerEventListenerException

Called immediately after a channel has been created through ChannelManager.persist(Session, String, Channel). Note that when for every ChannelManagerEventListener the channelCreated(ChannelManagerEvent) callback have been done, the JCR Session that belongs to ChannelManagerEvent.getConfigRootNode() is saved through Session.save() : Thus, any jcr modifications made on the backing jcr Node from the ChannelManagerEvent.getConfigRootNode() are being persisted.

Parameters:

event - the ChannelManagerEvent

Throws:

ChannelManagerEventListenerException - an exception that an implementation may choose to throw to have the ChannelManager log a warning or even completely short circuit the channel processing when the ChannelManagerEventListenerException has ChannelManagerEventListenerException.getStatus() equal to ChannelManagerEventListenerException.Status.STOP_CHANNEL_PROCESSING

channelUpdated

void channelUpdated(ChannelManagerEvent event)
             throws ChannelManagerEventListenerException

Called immediately after a channel has been updated through ChannelManager.save(Session, String, Channel). Note that when for every ChannelManagerEventListener the channelUpdated(ChannelManagerEvent) callback method has been done, the JCR Session that belongs to ChannelManagerEvent.getConfigRootNode() is saved through Session.save() : Thus, any jcr modifications made on the backing jcr Node from the ChannelManagerEvent.getConfigRootNode() are being persisted.

Parameters:

event - the ChannelManagerEvent

Throws:

ChannelManagerEventListenerException - an exception that an implementation may choose to throw to have the ChannelManager log a warning or even completely short circuit the channel processing when the ChannelManagerEventListenerException has ChannelManagerEventListenerException.getStatus() equal to ChannelManagerEventListenerException.Status.STOP_CHANNEL_PROCESSING