org.jasig.portlet.notice.service

Class AbstractNotificationService

java.lang.Object

org.jasig.portlet.notice.service.AbstractNotificationService

All Implemented Interfaces:

INotificationService

Direct Known Subclasses:

AbstractJdbcNotificationService, CacheNotificationService, ClassLoaderResourceNotificationService, JpaNotificationService, PortletEventNotificationService, RestfulJsonNotificationService, RomeNotificationService, SSPTaskNotificationService

public abstract class AbstractNotificationService
extends java.lang.Object
implements INotificationService

Field Summary

Fields

Modifier and Type	Field and Description
protected UsernameFinder	usernameFinder

Constructor Summary

Constructors

Constructor and Description
AbstractNotificationService()

Method Summary

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.
protected java.lang.String	createServiceUserWindowSpecificCacheKey(javax.portlet.PortletRequest req)
org.jasig.portlet.notice.NotificationResponse	fetch(javax.servlet.http.HttpServletRequest request) Returns an empty collection and logs the event.
java.lang.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) Subclasses of AbstractNotificationService that need to perform some logic within this method should override it.
boolean	isValid(javax.portlet.PortletRequest req, org.jasig.portlet.notice.NotificationResponse previousResponse) Returns true.
protected org.jasig.portlet.notice.NotificationResponse	prepareErrorResponse(java.lang.String source, java.lang.String message)
void	setName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jasig.portlet.notice.INotificationService

fetch

Field Detail

usernameFinder

@Autowired
protected UsernameFinder usernameFinder

Constructor Detail

AbstractNotificationService

public AbstractNotificationService()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: INotificationService

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

Specified by:

getName in interface INotificationService

Returns:

A unique name for this service

setName

public void setName(java.lang.String name)

invoke

public 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.

Specified by:

invoke in interface INotificationService

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)

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

Specified by:

collect in interface INotificationService

Parameters:

req - The current EventRequest

res - The current EventResponse

isValid

public boolean isValid(javax.portlet.PortletRequest req,
                       org.jasig.portlet.notice.NotificationResponse previousResponse)

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

Specified by:

isValid in interface INotificationService

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)

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

Parameters:

request - The REST request

Returns:

An abstraction representing the user's categorized notifications

createServiceUserWindowSpecificCacheKey

protected final java.lang.String createServiceUserWindowSpecificCacheKey(javax.portlet.PortletRequest req)

prepareErrorResponse

protected final org.jasig.portlet.notice.NotificationResponse prepareErrorResponse(java.lang.String source,
                                                                                   java.lang.String message)