org.clapper.curn
Interface PreFeedDownloadPlugIn

All Superinterfaces:

PlugIn

All Known Implementing Classes:

GzipDownloadPlugIn, MetaPlugIn, RawFeedSaveAsPlugIn, UserAgentPlugIn

public interface PreFeedDownloadPlugIn
extends PlugIn

This interface defines the methods that must be supported by plug-ins that wish to be notified just before curn downloads a feed.

Version:

$Revision: 6300 $

See Also:

PlugIn, MetaPlugIn, PostFeedDownloadPlugIn, PostFeedParsePlugIn, Curn

Method Summary

boolean

runPreFeedDownloadPlugIn(FeedInfo feedInfo, java.net.URLConnection urlConn) Called just before a feed is downloaded.

Methods inherited from interface org.clapper.curn.PlugIn

getPlugInName, getPlugInSortKey, initPlugIn

Method Detail

runPreFeedDownloadPlugIn

boolean runPreFeedDownloadPlugIn(FeedInfo feedInfo,
                                 java.net.URLConnection urlConn)
                                 throws CurnException

Called just before a feed is downloaded. This method can return false to signal curn that the feed should be skipped. The plug-in method can also set values on the URLConnection used to download the plug-in, via URL.setRequestProperty(). (Note that all URLs, even file: URLs, are passed into this method. Setting a request property on the URLConnection object for a file: URL will have no effect--though it isn't specifically harmful.)

Possible uses for a pre-feed download plug-in include:

• filtering on feed URL to prevent downloading non-matching feeds
• changing the default User-Agent value
• setting a non-standard HTTP header field

Parameters:

feedInfo - the FeedInfo object for the feed to be downloaded

urlConn - the java.net.URLConnection object that will be used to download the feed's XML.

Returns:

true if curn should continue to process the feed, false to skip the feed

Throws:

CurnException - on error

See Also:

FeedInfo