org.jasig.portlet.notice.service.classloader

Class DemoNotificationService

java.lang.Object

org.jasig.portlet.notice.service.AbstractNotificationService

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

org.jasig.portlet.notice.service.classloader.DemoNotificationService

All Implemented Interfaces:

INotificationService

Direct Known Subclasses:

LegacyEmergencyAlertsDemoNotifictionService

public class DemoNotificationService
extends ClassLoaderResourceNotificationService

This is a simple demo service provider that reads notifications from a file. It provides a setActive(boolean) method (default is true) for toggling it on and off at runtime.

Field Summary

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

usernameFinder

Constructor Summary

Constructors

Constructor and Description
DemoNotificationService()

Method Summary

Modifier and Type	Method and Description
org.jasig.portlet.notice.NotificationResponse	fetch(javax.servlet.http.HttpServletRequest req) 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.ArrayList<java.lang.String>	getLocations(javax.portlet.PortletRequest req)
void	init()
boolean	isActive()
void	setActive(boolean active)

Methods inherited from class org.jasig.portlet.notice.service.classloader.ClassLoaderResourceNotificationService

isValid, setCache

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

Constructor Detail

DemoNotificationService

public DemoNotificationService()

Method Detail

init

@PostConstruct
public void init()

Overrides:

init in class ClassLoaderResourceNotificationService

setActive

public void setActive(boolean active)

isActive

public boolean isActive()

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.

Specified by:

fetch in interface INotificationService

Overrides:

fetch in class ClassLoaderResourceNotificationService

Parameters:

req - The PortletRequest

Returns:

A collection of notifications and/or errors

fetch

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

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 ClassLoaderResourceNotificationService

Parameters:

req - The REST request

Returns:

An abstraction representing the user's categorized notifications

getLocations

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

Description copied from class: ClassLoaderResourceNotificationService

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

Overrides:

getLocations in class ClassLoaderResourceNotificationService

getLocations

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

Overrides:

getLocations in class ClassLoaderResourceNotificationService