org.jasig.portlet.newsreader.adapter

Class RomeAdapter

java.lang.Object

org.jasig.portlet.newsreader.adapter.AbstractNewsAdapter

org.jasig.portlet.newsreader.adapter.RomeAdapter

All Implemented Interfaces:

INewsAdapter

Direct Known Subclasses:

RomeAdapterFullStory

public class RomeAdapter
extends AbstractNewsAdapter

RomeAdapter is a NewsAdapter for standard RSS and ATOM feeds available online via http or https.

Note: This class can process and feed supported by ROME https://rome.dev.java.net/.

Author:

Anthony Colebourne

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ANTISAMY_POLICY
protected org.apache.commons.logging.Log	log
static String	PREFERENCE_DESCRIPTION_POLICY
static String	PREFERENCE_TITLE_POLICY

Constructor Summary

Constructors

Constructor and Description
RomeAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
long	getConnectionManagerTimeout()
int	getConnectionTimeout()
org.apache.http.impl.client.AbstractHttpClient	getHttpClient()
protected String[]	getPolicyPref(String... policyKey)
int	getReadTimeout()
NewsFeed	getSyndFeed(NewsConfiguration config, int page)
protected PaginatingNewsFeed	getSyndFeed(String url, String titlePolicy, String descriptionPolicy) Retrieve the entire feed using HTTPClient and clean using AntiSamy, build an SyndFeed object using ROME.
int	getTimesToRetry()
void	init()
void	setCache(net.sf.ehcache.Cache cache)
void	setCacheKeyPrefix(String prefix) Cache prefix to support multiple instances of this class using the same cache.
void	setConnectionManagerTimeout(long connectionManagerTimeout)
void	setConnectionTimeout(int connectionTimeout)
void	setHttpClient(org.apache.http.impl.client.AbstractHttpClient httpClient)
void	setProcessor(RomeNewsProcessorImpl processor)
void	setProxyHost(String proxyHost)
void	setProxyPort(String proxyPort)
void	setReadTimeout(int readTimeout)
void	setTimesToRetry(int timesToRetry)

Methods inherited from class org.jasig.portlet.newsreader.adapter.AbstractNewsAdapter

getClassName, getDescriptionKey, getNameKey

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

PREFERENCE_TITLE_POLICY

public static final String PREFERENCE_TITLE_POLICY

See Also:

Constant Field Values

PREFERENCE_DESCRIPTION_POLICY

public static final String PREFERENCE_DESCRIPTION_POLICY

See Also:

Constant Field Values

DEFAULT_ANTISAMY_POLICY

public static final String DEFAULT_ANTISAMY_POLICY

See Also:

Constant Field Values

Constructor Detail

RomeAdapter

public RomeAdapter()

Method Detail

getHttpClient

public org.apache.http.impl.client.AbstractHttpClient getHttpClient()

setHttpClient

public void setHttpClient(org.apache.http.impl.client.AbstractHttpClient httpClient)

setProxyHost

public void setProxyHost(String proxyHost)

setProxyPort

public void setProxyPort(String proxyPort)

getConnectionTimeout

public int getConnectionTimeout()

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

getReadTimeout

public int getReadTimeout()

setReadTimeout

public void setReadTimeout(int readTimeout)

getConnectionManagerTimeout

public long getConnectionManagerTimeout()

setConnectionManagerTimeout

public void setConnectionManagerTimeout(long connectionManagerTimeout)

getTimesToRetry

public int getTimesToRetry()

setTimesToRetry

public void setTimesToRetry(int timesToRetry)

setProcessor

public void setProcessor(RomeNewsProcessorImpl processor)

setCacheKeyPrefix

public void setCacheKeyPrefix(String prefix)

Cache prefix to support multiple instances of this class using the same cache.

Parameters:

prefix - Unique prefix for cache entries for this particular instance

init

public void init()
          throws Exception

Throws:

Exception

getPolicyPref

protected String[] getPolicyPref(String... policyKey)

getSyndFeed

public NewsFeed getSyndFeed(NewsConfiguration config,
                   int page)
                     throws NewsException

Throws:

NewsException

getSyndFeed

protected PaginatingNewsFeed getSyndFeed(String url,
                             String titlePolicy,
                             String descriptionPolicy)
                                  throws NewsException

Retrieve the entire feed using HTTPClient and clean using AntiSamy, build an SyndFeed object using ROME.

Parameters:

url - String of the feed to be retrieved

titlePolicy - String the cleaning policy for the title

descriptionPolicy - String the cleaning policy for the description

Returns:

SyndFeed Feed object

Throws:

NewsException

setCache

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