org.jasig.portlet.notice.service.classloader

Class ClassLoaderResourceNotificationService

java.lang.Object

org.jasig.portlet.notice.service.AbstractNotificationService

org.jasig.portlet.notice.service.classloader.ClassLoaderResourceNotificationService

All Implemented Interfaces:

INotificationService

Direct Known Subclasses:

DemoNotificationService

public class ClassLoaderResourceNotificationService
extends AbstractNotificationService

This is a simple service provider that reads notifications from one or more files in the classpath. It's a handy way to implement, for example, an online reference or FAQ using the Notification portlet. It also serves as the basis for the DemoNotificationService.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCATIONS_PREFERENCE

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

usernameFinder

Constructor Summary

Constructors

Constructor and Description
ClassLoaderResourceNotificationService()

Method Summary

Methods

Modifier and Type	Method and Description
NotificationResponse	fetch(javax.portlet.ResourceRequest req) Provide the current collection of Notifications information for the user represented by the PortletRequest.
protected ArrayList<String>	getLocations(javax.portlet.PortletRequest req) Returns a specific List impl (ArrayList) because it implements Serializable.
boolean	isValid(javax.portlet.ResourceRequest req, NotificationResponse previousResponse) Returns true.
void	setCache(net.sf.ehcache.Cache cache)

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

collect, createServiceUserWindowSpecificCacheKey, getName, invoke, prepareErrorResponse, setName

Methods inherited from class java.lang.Object

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

Field Detail

LOCATIONS_PREFERENCE

public static final String LOCATIONS_PREFERENCE

See Also:

Constant Field Values

Constructor Detail

ClassLoaderResourceNotificationService

public ClassLoaderResourceNotificationService()

Method Detail

setCache

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

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

isValid

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

Description copied from class: AbstractNotificationService

Returns true. Subclasses of AbstractNotificationService that can better answer this question should override this method.

Specified by:

isValid in interface INotificationService

Overrides:

isValid in class AbstractNotificationService

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

getLocations

protected ArrayList<String> getLocations(javax.portlet.PortletRequest req)

Returns a specific List impl (ArrayList) because it implements Serializable.