Package org.jasig.portlet.newsreader.dao

Class HibernateNewsStore

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

org.jasig.portlet.newsreader.dao.HibernateNewsStore

All Implemented Interfaces:

NewsStore, org.springframework.beans.factory.InitializingBean

public class HibernateNewsStore
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements NewsStore

HibernateNewsStore provides a hibernate implementation of the NewsStore.

Since:

5.1.1

Author:

Anthony Colebourne, Jen Bourey

Constructor Summary

Constructors

Constructor	Description
HibernateNewsStore()

Method Summary

Modifier and Type	Method	Description
void	deleteNewsConfiguration(NewsConfiguration configuration)	Remove a news configuration from the data store
void	deleteNewsDefinition(PredefinedNewsDefinition definition)	Remove a news definition from the data store.
List<PredefinedNewsDefinition>	getHiddenPredefinedNewsDefinitions(Long setId, Set<String> roles)	Retrieve a list of hidden predefined newss for this portlet subscription and role.
NewsConfiguration	getNewsConfiguration(Long id)	Retrieve a news configuration.
List<NewsConfiguration>	getNewsConfigurations(String subscribeId)	Retrieve a list of news configurations for the specified portlet.
NewsDefinition	getNewsDefinition(Long id)	Retrieve a news definition.
NewsSet	getNewsSet(Long id)	getNewsSet.
NewsSet	getNewsSet(String userId, String setName)	getNewsSet.
List<NewsSet>	getNewsSetsForUser(String userId)	getNewsSetsForUser.
List<PredefinedNewsConfiguration>	getPredefinedNewsConfigurations()	getPredefinedNewsConfigurations.
List<PredefinedNewsConfiguration>	getPredefinedNewsConfigurations(Long setId, boolean visibleOnly)	Retrieve a list of pre-defined news configurations for the specified portlet.
PredefinedNewsDefinition	getPredefinedNewsDefinition(Long id)	Retrieve a pre-defined news definition
PredefinedNewsDefinition	getPredefinedNewsDefinitionByName(String name)	getPredefinedNewsDefinitionByName.
List<UserDefinedNewsConfiguration>	getUserDefinedNewsConfigurations(Long setId, boolean visibleOnly)	Retrieve a list of user-defined news configurations for the specified portlet.
List<String>	getUserRoles()	getUserRoles.
void	initNews(NewsSet set, Set<String> roles)	Initialize news subscriptions for a given portlet subscription and role.
void	storeNewsConfiguration(NewsConfiguration configuration)	Save or update a news configuration.
void	storeNewsDefinition(NewsDefinition listing)	Save or update a news definition.
void	storeNewsSet(NewsSet set)	storeNewsSet.

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Constructor Details

HibernateNewsStore

public HibernateNewsStore()

Method Details

storeNewsDefinition

public void storeNewsDefinition(NewsDefinition listing)

Save or update a news definition.

Specified by:

storeNewsDefinition in interface NewsStore

Parameters:

listing - NewsDefinition to be persisted

storeNewsConfiguration

public void storeNewsConfiguration(NewsConfiguration configuration)

Save or update a news configuration.

Specified by:

storeNewsConfiguration in interface NewsStore

Parameters:

configuration - NewsConfiguration to be persisted

getNewsConfigurations

public List<NewsConfiguration> getNewsConfigurations(String subscribeId)

Retrieve a list of news configurations for the specified portlet.

Specified by:

getNewsConfigurations in interface NewsStore

Parameters:

subscribeId - unique ID for this portlet subscription

Returns:

a List object

getUserDefinedNewsConfigurations

public List<UserDefinedNewsConfiguration> getUserDefinedNewsConfigurations(Long setId,
 boolean visibleOnly)

Retrieve a list of user-defined news configurations for the specified portlet.

Specified by:

getUserDefinedNewsConfigurations in interface NewsStore

Parameters:

setId - unique ID for this portlet subscription

visibleOnly - true to retrieve only non-hidden news configurations, false otherwise

Returns:

a List object

getPredefinedNewsConfigurations

public List<PredefinedNewsConfiguration> getPredefinedNewsConfigurations(Long setId,
 boolean visibleOnly)

Retrieve a list of pre-defined news configurations for the specified portlet.

Specified by:

getPredefinedNewsConfigurations in interface NewsStore

Parameters:

setId - unique ID for this portlet subscription

visibleOnly - true to retrieve only non-hidden news configurations, false otherwise

Returns:

a List object

getPredefinedNewsConfigurations

public List<PredefinedNewsConfiguration> getPredefinedNewsConfigurations()

getPredefinedNewsConfigurations.

Specified by:

getPredefinedNewsConfigurations in interface NewsStore

Returns:

a List object

getHiddenPredefinedNewsDefinitions

public List<PredefinedNewsDefinition> getHiddenPredefinedNewsDefinitions(Long setId,
 Set<String> roles)

Retrieve a list of hidden predefined newss for this portlet subscription and role.

Specified by:

getHiddenPredefinedNewsDefinitions in interface NewsStore

Parameters:

setId - unique ID for this portlet subscription

roles - user role to use to find default newss

Returns:

a List object

initNews

public void initNews(NewsSet set,
 Set<String> roles)

Initialize news subscriptions for a given portlet subscription and role.

Specified by:

initNews in interface NewsStore

Parameters:

set - news collection to initialize

roles - user roles to use to find default newss

getPredefinedNewsDefinition

public PredefinedNewsDefinition getPredefinedNewsDefinition(Long id)

Retrieve a pre-defined news definition

Specified by:

getPredefinedNewsDefinition in interface NewsStore

Parameters:

id - ID of the news definition to be retrieved

Returns:

a PredefinedNewsDefinition object

getPredefinedNewsDefinitionByName

public PredefinedNewsDefinition getPredefinedNewsDefinitionByName(String name)

getPredefinedNewsDefinitionByName.

Specified by:

getPredefinedNewsDefinitionByName in interface NewsStore

Parameters:

name - a String object

Returns:

a PredefinedNewsDefinition object

getNewsDefinition

public NewsDefinition getNewsDefinition(Long id)

Retrieve a news definition.

Specified by:

getNewsDefinition in interface NewsStore

Parameters:

id - ID of the news definition to be retrieved

Returns:

a NewsDefinition object

getNewsConfiguration

public NewsConfiguration getNewsConfiguration(Long id)

Retrieve a news configuration.

Specified by:

getNewsConfiguration in interface NewsStore

Parameters:

id - ID of the news configuration to be retrieved

Returns:

a NewsConfiguration object

deleteNewsConfiguration

public void deleteNewsConfiguration(NewsConfiguration configuration)

Remove a news configuration from the data store

Specified by:

deleteNewsConfiguration in interface NewsStore

Parameters:

configuration - configuration to be removed

deleteNewsDefinition

public void deleteNewsDefinition(PredefinedNewsDefinition definition)

Remove a news definition from the data store.

Specified by:

deleteNewsDefinition in interface NewsStore

Parameters:

definition - definition to be removed

getUserRoles

@Cacheable("HibernateNewsStore.userRoles")
public List<String> getUserRoles()

getUserRoles.

Specified by:

getUserRoles in interface NewsStore

Returns:

a List object

getNewsSet

@Cacheable("HibernateNewsStore.newsSetById")
public NewsSet getNewsSet(Long id)

getNewsSet.

Specified by:

getNewsSet in interface NewsStore

Parameters:

id - a Long object

Returns:

a NewsSet object

getNewsSetsForUser

@Cacheable("HibernateNewsStore.newsSetByUser")
public List<NewsSet> getNewsSetsForUser(String userId)

getNewsSetsForUser.

Specified by:

getNewsSetsForUser in interface NewsStore

Parameters:

userId - a String object

Returns:

a List object

storeNewsSet

@CacheEvict(cacheNames={"HibernateNewsStore.newsSetById","HibernateNewsStore.newsSetByUser","HibernateNewsStore.newsSetByUserAndName"})
public void storeNewsSet(NewsSet set)

storeNewsSet.

Specified by:

storeNewsSet in interface NewsStore

Parameters:

set - a NewsSet object

getNewsSet

@Cacheable("HibernateNewsStore.newsSetByUserAndName")
public NewsSet getNewsSet(String userId,
 String setName)

getNewsSet.

Specified by:

getNewsSet in interface NewsStore

Parameters:

userId - a String object

setName - a String object

Returns:

a NewsSet object