org.hippoecm.hst.configuration.channel

Interface ChannelManagerEvent

public interface ChannelManagerEvent

This event type is used by the ChannelManagerEventListener in order to identify the channel and its related information.

Version:

$Id$

Method Summary

Methods

Modifier and Type	Method and Description
Blueprint	getBlueprint() Returns a blueprint object which is being used during the channel creation.
Channel	getChannel() Returns the channel which was used as an input during channel creation or update.
String	getChannelId() Returns the ID of the channel which is being created or updated.
javax.jcr.Node	getConfigRootNode() Returns the HST Configuration root node.

Method Detail

getBlueprint

Blueprint getBlueprint()

Returns a blueprint object which is being used during the channel creation. If the event is not triggered on channel creation, it returns null.

Returns:

getChannelId

String getChannelId()

Returns the ID of the channel which is being created or updated. If a channel is created, you must use this method to get the ID of the created channel. Otherwise, this method will return the same value as getChannel().getId().

Returns:

getChannel

Channel getChannel()

Returns the channel which was used as an input during channel creation or update.

Returns:

getConfigRootNode

javax.jcr.Node getConfigRootNode()

Returns the HST Configuration root node. e.g., /hst:hst

Returns: