org.jasig.portlet.notice.service

Class CacheNotificationService

java.lang.Object

org.jasig.portlet.notice.service.AbstractNotificationService

org.jasig.portlet.notice.service.CacheNotificationService

All Implemented Interfaces:

INotificationService

public final class CacheNotificationService
extends AbstractNotificationService

This class contains all the notification service providers. It implements the EHCache implementation. An instance of this class is called from the DataController in order to retrieve the notifications for a given user.

Field Summary

Fields inherited from class org.jasig.portlet.notice.service.AbstractNotificationService

usernameFinder

Constructor Summary

Constructors

Constructor and Description
CacheNotificationService()

Method Summary

Methods

Modifier and Type	Method and Description
void	collect(javax.portlet.EventRequest req, javax.portlet.EventResponse res) Subclasses of AbstractNotificationService that need to perform some logic within this method should override it.
NotificationResponse	fetch(javax.portlet.ResourceRequest req) Provide the current collection of Notifications information for the user represented by the PortletRequest.
void	invoke(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res, boolean refresh) Subclasses of AbstractNotificationService that need to perform some logic within this method should override it.
void	setCache(net.sf.ehcache.Cache cache)
void	setEmbeddedServices(List<INotificationService> services)

Methods inherited from class org.jasig.portlet.notice.service.AbstractNotificationService

createServiceUserWindowSpecificCacheKey, getName, isValid, prepareErrorResponse, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheNotificationService

public CacheNotificationService()

Method Detail

setEmbeddedServices

public void setEmbeddedServices(List<INotificationService> services)

setCache

public void setCache(net.sf.ehcache.Cache cache)

invoke

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

Description copied from class: AbstractNotificationService

Subclasses of AbstractNotificationService that need to perform some logic within this method should override it.

Specified by:

invoke in interface INotificationService

Overrides:

invoke in class AbstractNotificationService

Parameters:

req - The current ActionRequest

res - The current ActionResponse

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

collect

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

Description copied from class: AbstractNotificationService

Subclasses of AbstractNotificationService that need to perform some logic within this method should override it.

Specified by:

collect in interface INotificationService

Overrides:

collect in class AbstractNotificationService

Parameters:

req - The current EventRequest

res - The current EventResponse

fetch

public NotificationResponse fetch(javax.portlet.ResourceRequest req)

Description copied from interface: INotificationService

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