com.sun.syndication.fetcher
Interface FeedFetcher

All Known Implementing Classes:

AbstractFeedFetcher

public interface FeedFetcher

Field Summary

static String

DEFAULT_USER_AGENT The default user agent.

Method Summary

void	addFetcherEventListener(FetcherListener listener) Add a FetcherListener.
String	getUserAgent()
boolean	isUsingDeltaEncoding() Is this fetcher using rfc3229 delta encoding?
void	removeFetcherEventListener(FetcherListener listener) Remove a FetcherListener
SyndFeed	retrieveFeed(URL feedUrl) Retrieve a feed over HTTP
void	setUserAgent(String string)
void	setUsingDeltaEncoding(boolean useDeltaEncoding) 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!

Field Detail

DEFAULT_USER_AGENT

public static final String DEFAULT_USER_AGENT

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

getUserAgent

public String getUserAgent()

Returns:

the User-Agent currently being sent to servers

setUserAgent

public void setUserAgent(String string)

Parameters:

string - The User-Agent to sent to servers

retrieveFeed

public SyndFeed retrieveFeed(URL feedUrl)
                      throws IllegalArgumentException,
                             IOException,
                             FeedException,
                             FetcherException

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

addFetcherEventListener

public void addFetcherEventListener(FetcherListener listener)

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

public void removeFetcherEventListener(FetcherListener listener)

Remove a FetcherListener

Parameters:

listener - The FetcherListener to remove

isUsingDeltaEncoding

public boolean isUsingDeltaEncoding()

Is this fetcher using rfc3229 delta encoding?

Returns:

true if using delta encoding; false otherwise

setUsingDeltaEncoding

public void setUsingDeltaEncoding(boolean useDeltaEncoding)

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 -