org.jasig.portlet.notice.service.jdbc

Class AbstractJdbcNotificationService

java.lang.Object

org.jasig.portlet.notice.service.AbstractNotificationService

org.jasig.portlet.notice.service.jdbc.AbstractJdbcNotificationService

All Implemented Interfaces:

INotificationService

Direct Known Subclasses:

AnyRowResourceContentJdbcNotificationService

public abstract class AbstractJdbcNotificationService
extends AbstractNotificationService

Base class for INotificationService implementations that pull notifications from JDBC data sources using common patterns.

Since:

3.2

Field Summary

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

usernameFinder

Constructor Summary

Constructors

Constructor and Description
AbstractJdbcNotificationService()

Method Summary

Modifier and Type	Method and Description
org.jasig.portlet.notice.NotificationResponse	executeQuery(java.lang.String username, org.springframework.jdbc.core.namedparam.SqlParameterSource sqlParameterSource, org.springframework.jdbc.core.ResultSetExtractor<org.jasig.portlet.notice.NotificationResponse> resultSetExtractor)
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.
org.jasig.portlet.notice.NotificationResponse	fetchFromCacheOrSupplier(java.lang.String username, java.util.function.Supplier<org.jasig.portlet.notice.NotificationResponse> supplier)
protected abstract org.springframework.jdbc.core.ResultSetExtractor<org.jasig.portlet.notice.NotificationResponse>	getResultSetExtractor(javax.servlet.http.HttpServletRequest request) Subclasses must override this method to provide a custom ResultSetExtractor.
protected abstract org.springframework.jdbc.core.ResultSetExtractor<org.jasig.portlet.notice.NotificationResponse>	getResultSetExtractor(javax.portlet.PortletRequest req) Subclasses must override this method to provide a custom ResultSetExtractor.
protected org.springframework.jdbc.core.namedparam.SqlParameterSource	getSqlParameterSource(javax.servlet.http.HttpServletRequest request) General-purpose implementation of this method that wraps the OIDC Id token in an SqlParameterSource.
protected org.springframework.jdbc.core.namedparam.SqlParameterSource	getSqlParameterSource(javax.portlet.PortletRequest req) General-purpose implementation of this method that wraps the PortletRequest.USER_INFO map in a MapSqlParameterSource.
void	init()
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.
void	setCache(net.sf.ehcache.Cache cache)
void	setDataSource(javax.sql.DataSource dataSource)
void	setRequiredParameters(java.util.Set<java.lang.String> requiredParameters) Implementors may may call this method to specify parameters that must be present in the SqlParameterSource.
void	setSql(java.lang.String sql)

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

collect, createServiceUserWindowSpecificCacheKey, getName, isValid, prepareErrorResponse, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJdbcNotificationService

public AbstractJdbcNotificationService()

Method Detail

setDataSource

public void setDataSource(javax.sql.DataSource dataSource)

setSql

public void setSql(java.lang.String sql)

setCache

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

setRequiredParameters

public void setRequiredParameters(java.util.Set<java.lang.String> requiredParameters)

Implementors may may call this method to specify parameters that must be present in the SqlParameterSource.

init

@PostConstruct
public void init()

invoke

public void invoke(javax.portlet.ActionRequest req,
                   javax.portlet.ActionResponse res,
                   boolean refresh)

Description copied from class: AbstractNotificationService

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

Specified by:

invoke in interface INotificationService

Overrides:

invoke in class AbstractNotificationService

Parameters:

req - The current ActionRequest

res - The current ActionResponse

refresh - If true, the service should expire any cached data

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

getSqlParameterSource

protected org.springframework.jdbc.core.namedparam.SqlParameterSource getSqlParameterSource(javax.portlet.PortletRequest req)

General-purpose implementation of this method that wraps the PortletRequest.USER_INFO map in a MapSqlParameterSource. Subclasses may override this method to provide a custom SqlParameterSource when needed.

getSqlParameterSource

protected org.springframework.jdbc.core.namedparam.SqlParameterSource getSqlParameterSource(javax.servlet.http.HttpServletRequest request)

General-purpose implementation of this method that wraps the OIDC Id token in an SqlParameterSource. Subclasses may override this method to provide a custom SqlParameterSource when needed.

getResultSetExtractor

protected abstract org.springframework.jdbc.core.ResultSetExtractor<org.jasig.portlet.notice.NotificationResponse> getResultSetExtractor(javax.portlet.PortletRequest req)

Subclasses must override this method to provide a custom ResultSetExtractor.

getResultSetExtractor

protected abstract org.springframework.jdbc.core.ResultSetExtractor<org.jasig.portlet.notice.NotificationResponse> getResultSetExtractor(javax.servlet.http.HttpServletRequest request)

Subclasses must override this method to provide a custom ResultSetExtractor.

fetchFromCacheOrSupplier

public org.jasig.portlet.notice.NotificationResponse fetchFromCacheOrSupplier(java.lang.String username,
                                                                              java.util.function.Supplier<org.jasig.portlet.notice.NotificationResponse> supplier)

executeQuery

public org.jasig.portlet.notice.NotificationResponse executeQuery(java.lang.String username,
                                                                  org.springframework.jdbc.core.namedparam.SqlParameterSource sqlParameterSource,
                                                                  org.springframework.jdbc.core.ResultSetExtractor<org.jasig.portlet.notice.NotificationResponse> resultSetExtractor)