org.jasig.portlet.notice

Interface INotificationService

All Known Implementing Classes:

AbstractNotificationService, CacheNotificationService, ClassLoaderResourceNotificationService, DemoNotificationService, PortletEventNotificationService, RestfulJsonNotificationService, RomeNotificationService

public interface INotificationService

This is the central interface of the Notifications API. It is used to retrieve notifications from data sources.

Method Summary

Methods

Modifier and Type	Method and Description
void	collect(javax.portlet.EventRequest req, javax.portlet.EventResponse res) This method allows INotificationService implementations that receive portlet events to collect notifications from other portlets in the portal.
NotificationResponse	fetch(javax.portlet.ResourceRequest req) Provide the current collection of Notifications information for the user represented by the PortletRequest.
String	getName() Returns the name of the service, which should be unique in the portlet app.
void	invoke(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res, boolean refresh) This method 'primes the pump' for INotificationService implementations.
boolean	isValid(javax.portlet.ResourceRequest req, NotificationResponse previousResponse) Indicates whether a previous (presumably cached) NotificationResponse is still valid.

Method Detail

getName

String getName()

Returns the name of the service, which should be unique in the portlet app.

Returns:

A unique name for this service

invoke

void invoke(javax.portlet.ActionRequest req,
          javax.portlet.ActionResponse res,
          boolean refresh)

This method 'primes the pump' for INotificationService implementations. Not all concrete services will need this method, and those that don't can safely make it a no-op. But those that do need it can rely on receiving a call to invoke() before receiving a call to fetch().

Parameters:

req - The current ActionRequest

res - The current ActionResponse

refresh - If true, the service should expire any cached data

collect

void collect(javax.portlet.EventRequest req,
           javax.portlet.EventResponse res)

This method allows INotificationService implementations that receive portlet events to collect notifications from other portlets in the portal. Not all concrete services will need this method, and those that don't can safely make it a no-op.

Parameters:

req - The current EventRequest

res - The current EventResponse

fetch

NotificationResponse fetch(javax.portlet.ResourceRequest req)

Provide the current collection of Notifications information for the user represented by the PortletRequest.

Parameters:

req - The PortletRequest

Returns:

A collection of notifications and/or errors

isValid

boolean isValid(javax.portlet.ResourceRequest req,
              NotificationResponse previousResponse)

Indicates whether a previous (presumably cached) NotificationResponse is still valid. A few service implementations will be able to make this determination without contacting a remote service or doing anything computationally expensive. Those that can't should just return true; they will have the chance to update their responses when the cached version expires or when the user clicks refresh.

Parameters:

req - The current request

previousResponse - A response provided by this service at an earlier point

Returns:

true if the earlier response is still acceptable for the present