Package com.rometools.fetcher

Interface FeedFetcher

All Known Implementing Classes:

AbstractFeedFetcher, HttpClientFeedFetcher, HttpURLFeedFetcher

@Deprecated
public interface 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.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_USER_AGENT	Deprecated. The default user agent.

Method Summary

Modifier and Type	Method	Description
void	addFetcherEventListener(FetcherListener listener)	Deprecated. Add a FetcherListener.
String	getUserAgent()	Deprecated.
boolean	isUsingDeltaEncoding()	Deprecated. Is this fetcher using rfc3229 delta encoding?
void	removeFetcherEventListener(FetcherListener listener)	Deprecated. Remove a FetcherListener
SyndFeed	retrieveFeed(String userAgent, URL url)	Deprecated.
SyndFeed	retrieveFeed(URL feedUrl)	Deprecated. Retrieve a feed over HTTP
void	setAllowDoctypes(boolean allowDoctypes)	Deprecated. In ROME 1.5.1 we fixed a security vulnerability by disallowing Doctype declarations by default.
void	setPreserveWireFeed(boolean preserveWireFeed)	Deprecated. If set to true, the WireFeed will be made accessible from the SyndFeed object returned from the Fetcher via the originalWireFeed() method.
void	setUserAgent(String string)	Deprecated.
void	setUsingDeltaEncoding(boolean useDeltaEncoding)	Deprecated. Turn on or off rfc3229 delta encoding

Field Detail

DEFAULT_USER_AGENT

static final String DEFAULT_USER_AGENT

Deprecated.

The default user agent. It is not marked final so buggy java compiler will not write this string into all classes that reference it.

http://tinyurl.com/64t5n points to https://rome.dev.java.net Some servers ban user agents with "Java" in the name.

See Also:

Constant Field Values

Method Detail

setUserAgent

void setUserAgent(String string)

Deprecated.

Parameters:

string - The User-Agent to sent to servers

getUserAgent

String getUserAgent()

Deprecated.

Returns:

the User-Agent currently being sent to servers

setUsingDeltaEncoding

void setUsingDeltaEncoding(boolean useDeltaEncoding)

Deprecated.

Turn on or off rfc3229 delta encoding

See http://www.ietf.org/rfc/rfc3229.txt and http://bobwyman.pubsub.com/main/2004/09/using_rfc3229_w.html

NOTE: This is experimental and feedback is welcome!

Parameters:

useDeltaEncoding -

isUsingDeltaEncoding

boolean isUsingDeltaEncoding()

Deprecated.

Is this fetcher using rfc3229 delta encoding?

Returns:

addFetcherEventListener

void addFetcherEventListener(FetcherListener listener)

Deprecated.

Add a FetcherListener.

The FetcherListener will receive an FetcherEvent when a Fetcher event (feed polled, retrieved, etc) occurs

Parameters:

listener - The FetcherListener to recieve the event

removeFetcherEventListener

void removeFetcherEventListener(FetcherListener listener)

Deprecated.

Remove a FetcherListener

Parameters:

listener - The FetcherListener to remove

retrieveFeed

SyndFeed retrieveFeed(URL feedUrl)
               throws IllegalArgumentException,
                      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:

IllegalArgumentException - if the URL is null;

IOException - if a TCP error occurs

FeedException - if the feed is not valid

FetcherException - if a HTTP error occurred

retrieveFeed

SyndFeed retrieveFeed(String userAgent,
                      URL url)
               throws IllegalArgumentException,
                      IOException,
                      FeedException,
                      FetcherException

Deprecated.

Throws:

IllegalArgumentException

IOException

FeedException

FetcherException

setPreserveWireFeed

void setPreserveWireFeed(boolean preserveWireFeed)

Deprecated.

If set to true, the WireFeed will be made accessible from the SyndFeed object returned from the Fetcher via the originalWireFeed() method. Each Entry in the feed will have the corresponding wireEntry property set.

setAllowDoctypes

void setAllowDoctypes(boolean allowDoctypes)

Deprecated.

In ROME 1.5.1 we fixed a security vulnerability by disallowing Doctype declarations by default. This change breaks the compatibility with at least RSS 0.91N because it requires a Doctype declaration. You are able to allow Doctype declarations again with this property. You should only activate it when the feeds that you process are absolutely trustful.

Parameters:

allowDoctypes - true when Doctype declarations should be allowed again, false otherwise