org.sakaiproject.news.impl

Class BasicNewsService

java.lang.Object

org.sakaiproject.news.impl.BasicNewsService

All Implemented Interfaces:

org.sakaiproject.entity.api.EntityProducer, org.sakaiproject.entity.api.EntityTransferrer, org.sakaiproject.news.api.NewsService

public class BasicNewsService
extends Object
implements org.sakaiproject.news.api.NewsService, org.sakaiproject.entity.api.EntityTransferrer

BasicNewsService implements the NewsService using the Rome RSS package.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_TOP_REFRESH
protected static int	DEFAULT_EXPIRATION
protected org.sakaiproject.memory.api.MemoryService	m_memoryService Dependency: MemoryService.
protected org.sakaiproject.memory.api.Cache	m_storage

Fields inherited from interface org.sakaiproject.news.api.NewsService

REFERENCE_ROOT, SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
BasicNewsService()

Method Summary

Methods

Modifier and Type	Method and Description
String	archive(String siteId, Document doc, Stack stack, String arg3, List attachments)
void	destroy() Returns to uninitialized state.
org.sakaiproject.news.api.NewsChannel	getChannel(String source) Retrieves a NewsChannel object indexed by a URL.
org.sakaiproject.entity.api.Entity	getEntity(org.sakaiproject.entity.api.Reference ref)
Collection	getEntityAuthzGroups(org.sakaiproject.entity.api.Reference ref)
Collection	getEntityAuthzGroups(org.sakaiproject.entity.api.Reference ref, String userId)
String	getEntityDescription(org.sakaiproject.entity.api.Reference ref)
org.sakaiproject.entity.api.ResourceProperties	getEntityResourceProperties(org.sakaiproject.entity.api.Reference ref)
String	getEntityUrl(org.sakaiproject.entity.api.Reference ref)
org.sakaiproject.entity.api.HttpAccess	getHttpAccess()
String	getLabel()
List	getNewsitems(String source) Retrieves a list of items from an rss feed.
List	getNewsitems(String source, org.sakaiproject.javax.Filter filter) Retrieves a list of items from an rss feed.
protected String	getUserAgent() Get the user agent to use for web requests.
void	init() Final initialization, once all dependencies are set.
boolean	isUpdateAvailable(String source) Checks whether an update is available for the rss news feed.
String	merge(String siteId, Element root, String archivePath, String fromSiteId, Map attachmentNames, Map userIdTrans, Set userListAllowImport)
String[]	myToolIds()
boolean	parseEntityReference(String reference, org.sakaiproject.entity.api.Reference ref)
void	removeChannel(String source) Removes a NewsChannel object from the service.
void	setMemoryService(org.sakaiproject.memory.api.MemoryService service) Dependency: MemoryService.
void	transferCopyEntities(String fromContext, String toContext, List ids)
void	transferCopyEntities(String fromContext, String toContext, List ids, boolean cleanup)
String	trimToNull(String value)
protected void	updateChannel(String source) Checks whether channel is cached.
boolean	willArchiveMerge()
boolean	willImport()

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_TOP_REFRESH

public static final String ATTR_TOP_REFRESH

See Also:

Constant Field Values

DEFAULT_EXPIRATION

protected static final int DEFAULT_EXPIRATION

See Also:

Constant Field Values

m_storage

protected org.sakaiproject.memory.api.Cache m_storage

m_memoryService

protected org.sakaiproject.memory.api.MemoryService m_memoryService

Dependency: MemoryService.

Constructor Detail

BasicNewsService

public BasicNewsService()

Method Detail

setMemoryService

public void setMemoryService(org.sakaiproject.memory.api.MemoryService service)

Dependency: MemoryService.

Parameters:

service - The MemoryService.

init

public void init()

Final initialization, once all dependencies are set.

destroy

public void destroy()

Returns to uninitialized state.

updateChannel

protected void updateChannel(String source)
                      throws org.sakaiproject.news.api.NewsConnectionException,
                             org.sakaiproject.news.api.NewsFormatException

Checks whether channel is cached. If not or if it's expired, retrieve the feed and update the cache

Parameters:

source - The url for the news feed

Throws:

NewsConnectionException, - for errors making the connection.

NewsFormatException, - for errors in the URL or errors parsing the feed.

org.sakaiproject.news.api.NewsConnectionException

org.sakaiproject.news.api.NewsFormatException

getNewsitems

public List getNewsitems(String source)
                  throws org.sakaiproject.news.api.NewsConnectionException,
                         org.sakaiproject.news.api.NewsFormatException

Retrieves a list of items from an rss feed.

Specified by:

getNewsitems in interface org.sakaiproject.news.api.NewsService

Parameters:

source - The url for the feed.

Returns:

A list of NewsItem objects retrieved from the feed.

Throws:

NewsConnectionException, - for errors making the connection.

NewsFormatException, - for errors in the URL or errors parsing the feed.

org.sakaiproject.news.api.NewsConnectionException

org.sakaiproject.news.api.NewsFormatException

getNewsitems

public List getNewsitems(String source,
                org.sakaiproject.javax.Filter filter)
                  throws org.sakaiproject.news.api.NewsConnectionException,
                         org.sakaiproject.news.api.NewsFormatException

Retrieves a list of items from an rss feed.

Specified by:

getNewsitems in interface org.sakaiproject.news.api.NewsService

Parameters:

source - The url for the feed.

filter - A filtering object to accept NewsItems, or null if no filtering is desired.

Returns:

A list of NewsItem objects retrieved from the feed.

Throws:

NewsConnectionException, - for errors making the connection.

NewsFormatException, - for errors in the URL or errors parsing the feed.

org.sakaiproject.news.api.NewsConnectionException

org.sakaiproject.news.api.NewsFormatException

isUpdateAvailable

public boolean isUpdateAvailable(String source)

Checks whether an update is available for the rss news feed.

Specified by:

isUpdateAvailable in interface org.sakaiproject.news.api.NewsService

Parameters:

source - The url for the feed.

Returns:

true if update is available, false otherwise

Throws:

NewsConnectionException, - for errors making the connection.

NewsFormatException, - for errors in the URL or errors parsing the feed.

getChannel

public org.sakaiproject.news.api.NewsChannel getChannel(String source)
                                                 throws org.sakaiproject.news.api.NewsConnectionException,
                                                        org.sakaiproject.news.api.NewsFormatException

Retrieves a NewsChannel object indexed by a URL.

Specified by:

getChannel in interface org.sakaiproject.news.api.NewsService

Parameters:

source - The url for the channel.

Returns:

A NewsChannel object (possibly null).

Throws:

NewsConnectionException, - for errors making the connection.

NewsFormatException, - for errors in the URL or errors parsing the feed.

org.sakaiproject.news.api.NewsConnectionException

org.sakaiproject.news.api.NewsFormatException

removeChannel

public void removeChannel(String source)

Removes a NewsChannel object from the service.

Specified by:

removeChannel in interface org.sakaiproject.news.api.NewsService

Parameters:

source - The url for the channel.

getEntityUrl

public String getEntityUrl(org.sakaiproject.entity.api.Reference ref)

Specified by:

getEntityUrl in interface org.sakaiproject.entity.api.EntityProducer

willArchiveMerge

public boolean willArchiveMerge()

Specified by:

willArchiveMerge in interface org.sakaiproject.entity.api.EntityProducer

willImport

public boolean willImport()

getHttpAccess

public org.sakaiproject.entity.api.HttpAccess getHttpAccess()

Specified by:

getHttpAccess in interface org.sakaiproject.entity.api.EntityProducer

getEntityDescription

public String getEntityDescription(org.sakaiproject.entity.api.Reference ref)

Specified by:

getEntityDescription in interface org.sakaiproject.entity.api.EntityProducer

getEntityResourceProperties

public org.sakaiproject.entity.api.ResourceProperties getEntityResourceProperties(org.sakaiproject.entity.api.Reference ref)

Specified by:

getEntityResourceProperties in interface org.sakaiproject.entity.api.EntityProducer

getEntity

public org.sakaiproject.entity.api.Entity getEntity(org.sakaiproject.entity.api.Reference ref)

Specified by:

getEntity in interface org.sakaiproject.entity.api.EntityProducer

merge

public String merge(String siteId,
           Element root,
           String archivePath,
           String fromSiteId,
           Map attachmentNames,
           Map userIdTrans,
           Set userListAllowImport)

Specified by:

merge in interface org.sakaiproject.entity.api.EntityProducer

archive

public String archive(String siteId,
             Document doc,
             Stack stack,
             String arg3,
             List attachments)

Specified by:

archive in interface org.sakaiproject.entity.api.EntityProducer

transferCopyEntities

public void transferCopyEntities(String fromContext,
                        String toContext,
                        List ids)

Specified by:

transferCopyEntities in interface org.sakaiproject.entity.api.EntityTransferrer

getLabel

public String getLabel()

Specified by:

getLabel in interface org.sakaiproject.entity.api.EntityProducer

getEntityAuthzGroups

public Collection getEntityAuthzGroups(org.sakaiproject.entity.api.Reference ref)

getEntityAuthzGroups

public Collection getEntityAuthzGroups(org.sakaiproject.entity.api.Reference ref,
                              String userId)

Specified by:

getEntityAuthzGroups in interface org.sakaiproject.entity.api.EntityProducer

myToolIds

public String[] myToolIds()

Specified by:

myToolIds in interface org.sakaiproject.entity.api.EntityTransferrer

parseEntityReference

public boolean parseEntityReference(String reference,
                           org.sakaiproject.entity.api.Reference ref)

Specified by:

parseEntityReference in interface org.sakaiproject.entity.api.EntityProducer

trimToNull

public String trimToNull(String value)

transferCopyEntities

public void transferCopyEntities(String fromContext,
                        String toContext,
                        List ids,
                        boolean cleanup)

Specified by:

transferCopyEntities in interface org.sakaiproject.entity.api.EntityTransferrer

getUserAgent

protected String getUserAgent()

Get the user agent to use for web requests.