org.clapper.curn.plugins
Class DisableFeedPlugIn

java.lang.Object
  org.clapper.curn.plugins.DisableFeedPlugIn

All Implemented Interfaces:

FeedConfigItemPlugIn, PlugIn

public class DisableFeedPlugIn
extends java.lang.Object
implements FeedConfigItemPlugIn

The DisableFeedPlugIn handles disabling a feed. It intercepts the following per-feed configuration parameters:

Disabled	Flag indicating whether or not to disable the feed.

Version:

$Revision: 6491 $

Constructor Summary

DisableFeedPlugIn()
Default constructor (required).

Method Summary

java.lang.String	getPlugInName() Get a displayable name for the plug-in.
java.lang.String	getPlugInSortKey() Get the sort key for this plug-in.
void	initPlugIn() Initialize the plug-in.
boolean	runFeedConfigItemPlugIn(java.lang.String sectionName, java.lang.String paramName, CurnConfig config, FeedInfo feedInfo) Called immediately after curn has read and processed a configuration item in a "feed" configuration section.

Methods inherited from class java.lang.Object

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

Constructor Detail

DisableFeedPlugIn

public DisableFeedPlugIn()

Default constructor (required).

Method Detail

getPlugInName

public java.lang.String getPlugInName()

Get a displayable name for the plug-in.

Specified by:

getPlugInName in interface PlugIn

Returns:

the name

getPlugInSortKey

public java.lang.String getPlugInSortKey()

Get the sort key for this plug-in.

Specified by:

getPlugInSortKey in interface PlugIn

Returns:

the sort key string.

initPlugIn

public void initPlugIn()
                throws CurnException

Initialize the plug-in. This method is called before any of the plug-in methods are called.

Specified by:

initPlugIn in interface PlugIn

Throws:

CurnException - on error

runFeedConfigItemPlugIn

public boolean runFeedConfigItemPlugIn(java.lang.String sectionName,
                                       java.lang.String paramName,
                                       CurnConfig config,
                                       FeedInfo feedInfo)
                                throws CurnException

Called immediately after curn has read and processed a configuration item in a "feed" configuration section. All configuration items are passed, one by one, to each loaded plug-in. If a plug-in class is not interested in a particular configuration item, this method should simply return without doing anything. Note that some configuration items may simply be variable assignment; there's no real way to distinguish a variable assignment from a blessed configuration item.

Specified by:

runFeedConfigItemPlugIn in interface FeedConfigItemPlugIn

Parameters:

sectionName - the name of the configuration section where the item was found

paramName - the name of the parameter

config - the active configuration

feedInfo - partially complete FeedInfo object for the feed. The URL is guaranteed to be present, but no other fields are.

Returns:

true to continue processing the feed, false to skip it

Throws:

CurnException - on error

See Also:

CurnConfig, FeedInfo, FeedInfo.getURL()