Package org.ametys.plugins.syndication

Class FeedCache

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.syndication.FeedCache

All Implemented Interfaces:

Disposable, Initializable, Component, LogEnabled, Serviceable

public class FeedCache
extends AbstractLogEnabled
implements Component, Initializable, Serviceable, Disposable

Feed cache, supports preloading multiple feeds in multiple concurrent threads.

Field Summary

Fields

Modifier and Type	Field	Description
protected Cache<String,FeedResult>	_cache	The user information cache.
protected AbstractCacheManager	_cacheManager	The cache manager
protected static final String	CACHE_ID	The feed cache id
static final String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
FeedCache()

Method Summary

Modifier and Type	Method	Description
void	dispose()
FeedResult	getFeed(String feedUrl, int lifeTime)	Get a feed.
FeedResult	getFeedNoCache(String feedUrl)	Get a feed not from the cache.
void	initialize()
protected static FeedResult	loadFeed(String feedUrl, org.apache.hc.client5.http.classic.HttpClient httpClient, Logger logger)	Retrieve a feed's content to store it into the cache.
void	preload(Collection<String> feeds)	Pre-load a collection of feeds, one by thread, to avoid getting timeouts sequentially.
void	service(ServiceManager manager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The component role.

CACHE_ID

protected static final String CACHE_ID

The feed cache id

_cacheManager

protected AbstractCacheManager _cacheManager

The cache manager

_cache

protected Cache<String,FeedResult> _cache

The user information cache.

Constructor Details

FeedCache

public FeedCache()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

preload

public void preload(Collection<String> feeds)

Pre-load a collection of feeds, one by thread, to avoid getting timeouts sequentially.

Parameters:

feeds - the feeds to preload.

getFeedNoCache

public FeedResult getFeedNoCache(String feedUrl)
                          throws IOException

Get a feed not from the cache.

Parameters:

feedUrl - the feed.

Returns:

the feed result.

Throws:

IOException - if an error occurs while loading the feed

getFeed

public FeedResult getFeed(String feedUrl,
 int lifeTime)

Get a feed.

Parameters:

feedUrl - the feed.

lifeTime - the amount of date or time to be added to the field

Returns:

the feed response.

loadFeed

protected static FeedResult loadFeed(String feedUrl,
 org.apache.hc.client5.http.classic.HttpClient httpClient,
 Logger logger)

Retrieve a feed's content to store it into the cache.

Parameters:

feedUrl - the feed to load.

httpClient - the client to use to load the feed

logger - the logger

Returns:

the feed content.

dispose

public void dispose()

Specified by:

dispose in interface Disposable