Package com.ellucian.ethos.integration.notification

Class EthosChangeNotificationListPollService

java.lang.Object

com.ellucian.ethos.integration.notification.AbstractEthosNotificationPollService

com.ellucian.ethos.integration.notification.EthosChangeNotificationListPollService

All Implemented Interfaces:

Flow.Publisher<List<ChangeNotification>>

public class EthosChangeNotificationListPollService
extends AbstractEthosNotificationPollService
implements Flow.Publisher<List<ChangeNotification>>

Service for distributing lists of Ethos ChangeNotifications retrieved from Ethos Integration. Implements the Flow.Publisher interface, but this does NOT publish messages to Ethos Integration. Serves as a "publisher" to push notification messages out to client application code from Ethos Integration through the SDK. An instance of this class should be used to subscribe client application ChangeNotification list subscribers (extending AbstractEthosChangeNotificationListSubscriber).

Since:

0.2.0

Author:

David Kumar

Field Summary

Fields

Modifier and Type	Field	Description
protected EthosChangeNotificationService	ethosChangeNotificationService	Used by the EthosChangeNotificationSubscription built by this class.

Fields inherited from class com.ellucian.ethos.integration.notification.AbstractEthosNotificationPollService

DEFAULT_POLL_INTERVAL_SECONDS, pollingIntervalSeconds, subscriberMap

Constructor Summary

Constructors

Constructor	Description
EthosChangeNotificationListPollService(EthosChangeNotificationService ethosChangeNotificationService)	Constructs an instance of this class with the given EthosChangeNotificationService.
EthosChangeNotificationListPollService(EthosChangeNotificationService ethosChangeNotificationService, long pollingIntervalSeconds)	Constructs an instance of this class with the given params.

Method Summary

Modifier and Type	Method	Description
void	subscribe(Flow.Subscriber<? super List<ChangeNotification>> subscriber)	Subscribes the given subscriber to an EthosChangeNotificationListSubscription, initiating the process for the subscriber to receive entire lists of ChangeNotifications at a time.

Methods inherited from class com.ellucian.ethos.integration.notification.AbstractEthosNotificationPollService

getNumberOfSubscribers, getSubscribers, unsubscribe

Methods inherited from class java.lang.Object

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

Field Detail

ethosChangeNotificationService

protected EthosChangeNotificationService ethosChangeNotificationService

Used by the EthosChangeNotificationSubscription built by this class.

Constructor Detail

EthosChangeNotificationListPollService

public EthosChangeNotificationListPollService(EthosChangeNotificationService ethosChangeNotificationService)

Constructs an instance of this class with the given EthosChangeNotificationService. Uses the default AbstractEthosNotificationPollService.DEFAULT_POLL_INTERVAL_SECONDS polling interval.

Parameters:

ethosChangeNotificationService - The ChangeNotification service to use for retrieving notification messages.

Throws:

IllegalArgumentException - Thrown if the ethosChangeNotificationService is null.

EthosChangeNotificationListPollService

public EthosChangeNotificationListPollService(EthosChangeNotificationService ethosChangeNotificationService,
                                              long pollingIntervalSeconds)

Constructs an instance of this class with the given params.

Parameters:

ethosChangeNotificationService - The ChangeNotification service to use for retrieving notification messages.

pollingIntervalSeconds - The polling interval between poll attempts to retrieve notification messages, in seconds.

Throws:

IllegalArgumentException - Thrown if the ethosChangeNotificationService is null.

Method Detail

subscribe

public void subscribe(Flow.Subscriber<? super List<ChangeNotification>> subscriber)

Subscribes the given subscriber to an EthosChangeNotificationListSubscription, initiating the process for the subscriber to receive entire lists of ChangeNotifications at a time.

Specified by:

subscribe in interface Flow.Publisher<List<ChangeNotification>>

Parameters:

subscriber - An instance of a client application implementation of AbstractEthosChangeNotificationListSubscriber.