com.liferay.portal.kernel.notifications

Class BaseChannelImpl

java.lang.Object

com.liferay.portal.kernel.notifications.BaseChannelImpl

All Implemented Interfaces:

Channel

public abstract class BaseChannelImpl
extends java.lang.Object
implements Channel

Author:

Edward Han

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.locks.Lock	lock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseChannelImpl(long companyId, long usedId)

Method Summary

Modifier and Type	Method and Description
void	cleanUp()
void	close()
protected abstract void	doCleanUp()
long	getCompanyId()
java.util.List<NotificationEvent>	getNotificationEvents()
long	getUserId()
boolean	hasNotificationEvents()
protected void	notifyChannelListeners()
void	registerChannelListener(ChannelListener channelListener)
void	setCleanUpInterval(long cleanUpInterval)
void	unregisterChannelListener(ChannelListener channelListener)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.portal.kernel.notifications.Channel

confirmDelivery, confirmDelivery, confirmDelivery, confirmDelivery, deleteUserNotificiationEvent, deleteUserNotificiationEvents, flush, flush, getNotificationEvents, init, removeTransientNotificationEvents, removeTransientNotificationEventsByUuid, sendNotificationEvent, sendNotificationEvents, storeNotificationEvent

Field Detail

lock

protected final java.util.concurrent.locks.Lock lock

Constructor Detail

BaseChannelImpl

protected BaseChannelImpl(long companyId,
                          long usedId)

Method Detail

cleanUp

public void cleanUp()
             throws ChannelException

Specified by:

cleanUp in interface Channel

Throws:

ChannelException

close

public void close()
           throws ChannelException

Specified by:

close in interface Channel

Throws:

ChannelException

getCompanyId

public long getCompanyId()

getNotificationEvents

public java.util.List<NotificationEvent> getNotificationEvents()
                                                        throws ChannelException

Specified by:

getNotificationEvents in interface Channel

Throws:

ChannelException

getUserId

public long getUserId()

Specified by:

getUserId in interface Channel

hasNotificationEvents

public boolean hasNotificationEvents()

registerChannelListener

public void registerChannelListener(ChannelListener channelListener)

Specified by:

registerChannelListener in interface Channel

setCleanUpInterval

public void setCleanUpInterval(long cleanUpInterval)

unregisterChannelListener

public void unregisterChannelListener(ChannelListener channelListener)

Specified by:

unregisterChannelListener in interface Channel

doCleanUp

protected abstract void doCleanUp()
                           throws java.lang.Exception

Throws:

java.lang.Exception

notifyChannelListeners

protected void notifyChannelListeners()