at.molindo.notify.channel.feed

Class AbstractPullChannel

java.lang.Object

at.molindo.notify.channel.feed.AbstractPullChannel

All Implemented Interfaces:

IChannel, IPullChannel

Direct Known Subclasses:

AbstractFeedChannel, DummyChannel

public abstract class AbstractPullChannel
extends Object
implements IPullChannel

Nested Class Summary

Nested classes/interfaces inherited from interface at.molindo.notify.channel.IPullChannel

IPullChannel.PullException

Field Summary

Fields

Modifier and Type	Field and Description
static Param<Integer>	AMOUNT
static int	DEFAULT_AMOUNT
static int	MAX_AMOUNT
static Param<String>	SECRET

Constructor Summary

Constructors

Constructor and Description
AbstractPullChannel()

Method Summary

Modifier and Type	Method and Description
Integer	getDefaultAmount()
boolean	isAuthorized(String userId, IChannelPreferences cPrefs)
boolean	isConfigured(Params params)
IChannelPreferences	newDefaultPreferences() create default preferences for this channel
protected abstract String	pull(List<Message> messages, Date lastModified, IChannelPreferences cPrefs, IPreferences prefs)
String	pull(String userId, IChannelPreferences cPrefs)
protected Message	render(Notification notification, IPreferences prefs, IChannelPreferences cPrefs)
void	setDefaultAmount(Integer defaultAmount)
void	setDispatchService(IDispatchService dispatchService)
void	setNotificationDAO(INotificationDAO notificationDAO)
void	setNotificationRenderService(IDispatchService dispatchService) Deprecated. use setDispatchService(IDispatchService)
void	setPreferencesDAO(IPreferencesDAO preferencesDAO)

Methods inherited from class java.lang.Object

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

Methods inherited from interface at.molindo.notify.channel.IChannel

getId, getNotificationTypes

Field Detail

SECRET

public static final Param<String> SECRET

AMOUNT

public static final Param<Integer> AMOUNT

MAX_AMOUNT

public static final int MAX_AMOUNT

See Also:

Constant Field Values

DEFAULT_AMOUNT

public static final int DEFAULT_AMOUNT

See Also:

Constant Field Values

Constructor Detail

AbstractPullChannel

public AbstractPullChannel()

Method Detail

isAuthorized

public boolean isAuthorized(String userId,
                            IChannelPreferences cPrefs)

Specified by:

isAuthorized in interface IPullChannel

isConfigured

public boolean isConfigured(Params params)

Specified by:

isConfigured in interface IChannel

Returns:

true if channel is sufficiently configured

pull

public final String pull(String userId,
                         IChannelPreferences cPrefs)
                  throws IPullChannel.PullException

Specified by:

pull in interface IPullChannel

Throws:

IPullChannel.PullException

newDefaultPreferences

public IChannelPreferences newDefaultPreferences()

Description copied from interface: IChannel

create default preferences for this channel

Specified by:

newDefaultPreferences in interface IChannel

Returns:

render

protected Message render(Notification notification,
                         IPreferences prefs,
                         IChannelPreferences cPrefs)
                  throws IRenderService.RenderException

Throws:

IRenderService.RenderException

getDefaultAmount

public Integer getDefaultAmount()

setDefaultAmount

public void setDefaultAmount(Integer defaultAmount)

setNotificationDAO

public void setNotificationDAO(INotificationDAO notificationDAO)

setPreferencesDAO

public void setPreferencesDAO(IPreferencesDAO preferencesDAO)

setDispatchService

public void setDispatchService(IDispatchService dispatchService)

setNotificationRenderService

@Deprecated
public void setNotificationRenderService(IDispatchService dispatchService)

Deprecated. use setDispatchService(IDispatchService)

Parameters:

dispatchService -

pull

protected abstract String pull(List<Message> messages,
                               Date lastModified,
                               IChannelPreferences cPrefs,
                               IPreferences prefs)
                        throws IPullChannel.PullException

Throws:

IPullChannel.PullException