com.rometools.fetcher.impl

Class HttpURLFeedFetcher

java.lang.Object

com.rometools.fetcher.impl.AbstractFeedFetcher

com.rometools.fetcher.impl.HttpURLFeedFetcher

All Implemented Interfaces:

FeedFetcher

Deprecated.

ROME Fetcher will be dropped in the next major version of ROME (version 2). For more information and some migration hints, please have a look at our detailed explanation.

@Deprecated
public class HttpURLFeedFetcher
extends AbstractFeedFetcher

Class to retrieve syndication files via HTTP.

If passed a FeedFetcherCache in the constructor it will use conditional gets to only retrieve modified content.

The class uses the Accept-Encoding: gzip header to retrieve gzipped feeds where supported by the server.

Simple usage:

 // create the cache
 FeedFetcherCache feedInfoCache = HashMapFeedInfoCache.getFeedInfoCache();
 // retrieve the feed the first time
 // any subsequent request will use conditional gets and only
 // retrieve the resource if it has changed
 SyndFeed feed = new HttpURLFeedFetcher(feedInfoCache).retrieveFeed(feedUrl);
 

See Also:

http://fishbowl.pastiche.org/2002/10/21/http_conditional_get_for_rss_hackers, http://diveintomark.org/archives/2003/07/21/atom_aggregator_behavior_http_level, http://bobwyman.pubsub.com/main/2004/09/using_rfc3229_w.html

Field Summary

Fields

Modifier and Type	Field and Description
private int	connectTimeout Deprecated.
private FeedFetcherCache	feedInfoCache Deprecated.
(package private) static int	POLL_EVENT Deprecated.
(package private) static int	RETRIEVE_EVENT Deprecated.
(package private) static int	UNCHANGED_EVENT Deprecated.

Fields inherited from interface com.rometools.fetcher.FeedFetcher

DEFAULT_USER_AGENT

Constructor Summary

Constructors

Constructor and Description
HttpURLFeedFetcher() Deprecated. Constructor to use HttpURLFeedFetcher without caching of feeds
HttpURLFeedFetcher(FeedFetcherCache feedInfoCache) Deprecated. Constructor to enable HttpURLFeedFetcher to cache feeds

Method Summary

Modifier and Type	Method and Description
FeedFetcherCache	getFeedInfoCache() Deprecated.
private SyndFeed	getSyndFeedFromStream(java.io.InputStream inputStream, java.net.URLConnection connection) Deprecated.
private SyndFeed	readSyndFeedFromStream(java.io.InputStream inputStream, java.net.URLConnection connection) Deprecated.
protected void	resetFeedInfo(java.net.URL orignalUrl, SyndFeedInfo syndFeedInfo, java.net.HttpURLConnection connection) Deprecated.
protected void	retrieveAndCacheFeed(java.net.URL feedUrl, SyndFeedInfo syndFeedInfo, java.net.HttpURLConnection connection) Deprecated.
SyndFeed	retrieveFeed(java.lang.String userAgent, java.net.URL feedUrl) Deprecated. Retrieve a feed over HTTP
SyndFeed	retrieveFeed(java.net.URL feedUrl) Deprecated. Retrieve a feed over HTTP
void	setConnectTimeout(int timeout) Deprecated.
void	setFeedInfoCache(FeedFetcherCache cache) Deprecated.
protected void	setRequestHeaders(java.net.URLConnection connection, SyndFeedInfo syndFeedInfo, java.lang.String userAgent) Deprecated. Set appropriate HTTP headers, including conditional get and gzip encoding headers

Methods inherited from class com.rometools.fetcher.impl.AbstractFeedFetcher

addFetcherEventListener, combineFeeds, fireEvent, fireEvent, fireEvent, fireEvent, getUserAgent, handleErrorCodes, isAllowDoctypes, isPreserveWireFeed, isUsingDeltaEncoding, removeFetcherEventListener, setAllowDoctypes, setPreserveWireFeed, setUserAgent, setUsingDeltaEncoding, throw4XXError, throwAuthenticationError

Methods inherited from class java.lang.Object

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

Field Detail

connectTimeout

private volatile int connectTimeout

Deprecated.

POLL_EVENT

static final int POLL_EVENT

Deprecated.

See Also:

Constant Field Values

RETRIEVE_EVENT

static final int RETRIEVE_EVENT

Deprecated.

See Also:

Constant Field Values

UNCHANGED_EVENT

static final int UNCHANGED_EVENT

Deprecated.

See Also:

Constant Field Values

feedInfoCache

private FeedFetcherCache feedInfoCache

Deprecated.

Constructor Detail

HttpURLFeedFetcher

public HttpURLFeedFetcher()

Deprecated.

Constructor to use HttpURLFeedFetcher without caching of feeds

HttpURLFeedFetcher

public HttpURLFeedFetcher(FeedFetcherCache feedInfoCache)

Deprecated.

Constructor to enable HttpURLFeedFetcher to cache feeds

Parameters:

feedInfoCache - - an instance of the FeedFetcherCache interface

Method Detail

retrieveFeed

public SyndFeed retrieveFeed(java.net.URL feedUrl)
                      throws java.lang.IllegalArgumentException,
                             java.io.IOException,
                             FeedException,
                             FetcherException

Deprecated.

Description copied from interface: FeedFetcher

Retrieve a feed over HTTP

Parameters:

feedUrl - A non-null URL of a RSS/Atom feed to retrieve

Returns:

A SyndFeed object

Throws:

java.lang.IllegalArgumentException - if the URL is null;

java.io.IOException - if a TCP error occurs

FeedException - if the feed is not valid

FetcherException - if a HTTP error occurred

retrieveFeed

public SyndFeed retrieveFeed(java.lang.String userAgent,
                             java.net.URL feedUrl)
                      throws java.lang.IllegalArgumentException,
                             java.io.IOException,
                             FeedException,
                             FetcherException

Deprecated.

Retrieve a feed over HTTP

Parameters:

feedUrl - A non-null URL of a RSS/Atom feed to retrieve

Returns:

A SyndFeed object

Throws:

java.lang.IllegalArgumentException - if the URL is null;

java.io.IOException - if a TCP error occurs

FeedException - if the feed is not valid

FetcherException - if a HTTP error occurred

retrieveAndCacheFeed

protected void retrieveAndCacheFeed(java.net.URL feedUrl,
                                    SyndFeedInfo syndFeedInfo,
                                    java.net.HttpURLConnection connection)
                             throws java.lang.IllegalArgumentException,
                                    FeedException,
                                    FetcherException,
                                    java.io.IOException

Deprecated.

Throws:

java.lang.IllegalArgumentException

FeedException

FetcherException

java.io.IOException

resetFeedInfo

protected void resetFeedInfo(java.net.URL orignalUrl,
                             SyndFeedInfo syndFeedInfo,
                             java.net.HttpURLConnection connection)
                      throws java.lang.IllegalArgumentException,
                             java.io.IOException,
                             FeedException

Deprecated.

Throws:

java.lang.IllegalArgumentException

java.io.IOException

FeedException

setRequestHeaders

protected void setRequestHeaders(java.net.URLConnection connection,
                                 SyndFeedInfo syndFeedInfo,
                                 java.lang.String userAgent)

Deprecated.

Set appropriate HTTP headers, including conditional get and gzip encoding headers

Parameters:

connection - A URLConnection

syndFeedInfo - The SyndFeedInfo for the feed to be retrieved. May be null

userAgent - the name of the user-agent to be placed in HTTP-header.

readSyndFeedFromStream

private SyndFeed readSyndFeedFromStream(java.io.InputStream inputStream,
                                        java.net.URLConnection connection)
                                 throws java.io.IOException,
                                        java.lang.IllegalArgumentException,
                                        FeedException

Deprecated.

Throws:

java.io.IOException

java.lang.IllegalArgumentException

FeedException

getSyndFeedFromStream

private SyndFeed getSyndFeedFromStream(java.io.InputStream inputStream,
                                       java.net.URLConnection connection)
                                throws java.io.IOException,
                                       java.lang.IllegalArgumentException,
                                       FeedException

Deprecated.

Throws:

java.io.IOException

java.lang.IllegalArgumentException

FeedException

getFeedInfoCache

public FeedFetcherCache getFeedInfoCache()

Deprecated.

Returns:

The FeedFetcherCache used by this fetcher (Could be null)

setFeedInfoCache

public void setFeedInfoCache(FeedFetcherCache cache)

Deprecated.

Parameters:

cache - The cache to be used by this fetcher (pass null to stop using a cache)

setConnectTimeout

public void setConnectTimeout(int timeout)

Deprecated.

Parameters:

timeout - see java.net.URLConnection.setConnectTimeout(int timeout)