org.exoplatform.commons.api.notification.channel

Interface ChannelManager

public interface ChannelManager

Method Summary

Modifier and Type	Method and Description
AbstractChannel	getChannel(ChannelKey key) Gets the channel by the specified key
List<AbstractChannel>	getChannels() Gets list of the channels
AbstractNotificationLifecycle	getLifecycle(ChannelKey key) Gets the lifecycle by the ChannelKey
void	register(AbstractChannel channel) Register new channel
void	registerOverrideTemplateProvider(TemplateProvider provider) Register and override the Template provider
void	registerTemplateProvider(TemplateProvider provider) Register the Template provider
int	sizeChannels() Gets size of channels has been registered
void	unregister(AbstractChannel channel) Unregister the specified channel

Method Detail

register

void register(AbstractChannel channel)

Register new channel

Parameters:

channel -

unregister

void unregister(AbstractChannel channel)

Unregister the specified channel

Parameters:

channel -

registerTemplateProvider

void registerTemplateProvider(TemplateProvider provider)

Register the Template provider

Parameters:

provider -

registerOverrideTemplateProvider

void registerOverrideTemplateProvider(TemplateProvider provider)

Register and override the Template provider

Parameters:

provider -

getChannel

AbstractChannel getChannel(ChannelKey key)

Gets the channel by the specified key

Parameters:

key - the channel key

Returns:

getChannels

List<AbstractChannel> getChannels()

Gets list of the channels

Returns:

getLifecycle

AbstractNotificationLifecycle getLifecycle(ChannelKey key)

Gets the lifecycle by the ChannelKey

Parameters:

key -

Returns:

sizeChannels

int sizeChannels()

Gets size of channels has been registered

Returns: