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 java.lang.String	LOCATIONS_PREFERENCE

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

usernameFinder

Constructor Summary

Constructors

Constructor and Description
ClassLoaderResourceNotificationService()

Method Summary

Modifier and Type	Method and Description
org.jasig.portlet.notice.NotificationResponse	fetch(javax.servlet.http.HttpServletRequest request) Returns an empty collection and logs the event.
org.jasig.portlet.notice.NotificationResponse	fetch(javax.portlet.PortletRequest req) Provide the current collection of Notifications information for the user represented by the PortletRequest.
protected java.util.List<java.lang.String>	getLocations(javax.servlet.http.HttpServletRequest req) Access to the list of locations is wrapped in a method so that subclasses can override it.
protected java.util.List<java.lang.String>	getLocations(javax.portlet.PortletRequest req) Deprecated.
void	init()
boolean	isValid(javax.portlet.PortletRequest req, org.jasig.portlet.notice.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 java.lang.String LOCATIONS_PREFERENCE

See Also:

Constant Field Values

Constructor Detail

ClassLoaderResourceNotificationService

public ClassLoaderResourceNotificationService()

Method Detail

setCache

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

init

@PostConstruct
public void init()

fetch

public org.jasig.portlet.notice.NotificationResponse fetch(javax.portlet.PortletRequest 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.PortletRequest req,
                             org.jasig.portlet.notice.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

fetch

public org.jasig.portlet.notice.NotificationResponse fetch(javax.servlet.http.HttpServletRequest request)

Description copied from class: AbstractNotificationService

Returns an empty collection and logs the event. All concrete implementations of INotificationService should override this method. The log entries this method produces are an indication that the service subclass is not ready for the post-Portlet API world.

Specified by:

fetch in interface INotificationService

Overrides:

fetch in class AbstractNotificationService

Parameters:

request - The REST request

Returns:

An abstraction representing the user's categorized notifications

getLocations

@Deprecated
protected java.util.List<java.lang.String> getLocations(javax.portlet.PortletRequest req)

Deprecated.

getLocations

protected java.util.List<java.lang.String> getLocations(javax.servlet.http.HttpServletRequest req)

Access to the list of locations is wrapped in a method so that subclasses can override it.