org.jasig.portlet.notice.service.rest

Class RestfulJsonNotificationService

java.lang.Object

org.jasig.portlet.notice.service.AbstractNotificationService

org.jasig.portlet.notice.service.rest.RestfulJsonNotificationService

All Implemented Interfaces:

INotificationService

Direct Known Subclasses:

OAuth2RestfulJsonNotificationService

public class RestfulJsonNotificationService
extends AbstractNotificationService

Obtains notifications as JSON from a remote URL using a Spring RestTemplate.

Constructor Summary

Constructors

Constructor and Description
RestfulJsonNotificationService()

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 org.springframework.web.client.RestTemplate	getRestTemplate() This Notification Service provides (and uses!) a protected getter for it's restTemplate so that subclasses may override the getter and provide their own template.
protected java.util.List<java.lang.String>	getServiceUrls() The list of locations is wrapped in a protected method so that subclasses can override it.
protected java.util.List<java.lang.String>	getServiceUrls(javax.portlet.PortletRequest req) Deprecated.
void	init()
void	setPasswordEvaluator(IParameterEvaluator passwordEvaluator)
void	setRestTemplate(org.springframework.web.client.RestTemplate restTemplate)
void	setUrlParameterEvaluators(java.util.Set<IParameterEvaluator> evaluators) Gathers beans that implement IParameterEvaluator and prepares to leverage them in dynamic URLs.
void	setUsernameEvaluator(IParameterEvaluator usernameEvaluator)

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

collect, createServiceUserWindowSpecificCacheKey, getName, invoke, isValid, prepareErrorResponse, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

RestfulJsonNotificationService

public RestfulJsonNotificationService()

Method Detail

setUsernameEvaluator

public void setUsernameEvaluator(IParameterEvaluator usernameEvaluator)

setPasswordEvaluator

public void setPasswordEvaluator(IParameterEvaluator passwordEvaluator)

setUrlParameterEvaluators

@Autowired
public void setUrlParameterEvaluators(java.util.Set<IParameterEvaluator> evaluators)

Gathers beans that implement IParameterEvaluator and prepares to leverage them in dynamic URLs.

Since:

3.1

setRestTemplate

public void setRestTemplate(org.springframework.web.client.RestTemplate restTemplate)

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

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 AbstractNotificationService

Parameters:

req - The REST request

Returns:

An abstraction representing the user's categorized notifications

getRestTemplate

protected org.springframework.web.client.RestTemplate getRestTemplate()

This Notification Service provides (and uses!) a protected getter for it's restTemplate so that subclasses may override the getter and provide their own template.

getServiceUrls

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

Deprecated.

The list of locations is wrapped in a protected method so that subclasses can override it.

getServiceUrls

protected java.util.List<java.lang.String> getServiceUrls()

The list of locations is wrapped in a protected method so that subclasses can override it.