01: /*---------------------------------------------------------------------------*\
02: $Id: PostFeedDownloadPlugIn.java 7041 2007-09-09 01:04:47Z bmc $
03: ---------------------------------------------------------------------------
04: This software is released under a BSD-style license:
05:
06: Copyright (c) 2004-2007 Brian M. Clapper. All rights reserved.
07:
08: Redistribution and use in source and binary forms, with or without
09: modification, are permitted provided that the following conditions are
10: met:
11:
12: 1. Redistributions of source code must retain the above copyright notice,
13: this list of conditions and the following disclaimer.
14:
15: 2. The end-user documentation included with the redistribution, if any,
16: must include the following acknowlegement:
17:
18: "This product includes software developed by Brian M. Clapper
19: (bmc@clapper.org, http://www.clapper.org/bmc/). That software is
20: copyright (c) 2004-2007 Brian M. Clapper."
21:
22: Alternately, this acknowlegement may appear in the software itself,
23: if wherever such third-party acknowlegements normally appear.
24:
25: 3. Neither the names "clapper.org", "curn", nor any of the names of the
26: project contributors may be used to endorse or promote products
27: derived from this software without prior written permission. For
28: written permission, please contact bmc@clapper.org.
29:
30: 4. Products derived from this software may not be called "curn", nor may
31: "clapper.org" appear in their names without prior written permission
32: of Brian M. Clapper.
33:
34: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
36: MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
37: NO EVENT SHALL BRIAN M. CLAPPER BE LIABLE FOR ANY DIRECT, INDIRECT,
38: INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
39: NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
40: DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
41: THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42: (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43: THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44: \*---------------------------------------------------------------------------*/
45:
46: package org.clapper.curn;
47:
48: import java.io.File;
49:
50: /**
51: * This interface defines the methods that must be supported by plug-ins
52: * that wish to be notified just after <i>curn</i> downloads a feed.
53: *
54: * @see PlugIn
55: * @see MetaPlugIn
56: * @see PreFeedDownloadPlugIn
57: * @see PostFeedParsePlugIn
58: * @see Curn
59: *
60: * @version <tt>$Revision: 7041 $</tt>
61: */
62: public interface PostFeedDownloadPlugIn extends PlugIn {
63: /*----------------------------------------------------------------------*\
64: Public Methods
65: \*----------------------------------------------------------------------*/
66:
67: /**
68: * Called immediately after a feed is downloaded. This method can
69: * return <tt>false</tt> to signal <i>curn</i> that the feed should be
70: * skipped. For instance, a plug-in that filters on the unparsed XML
71: * feed content could use this method to weed out non-matching feeds
72: * before they are downloaded.
73: *
74: * @param feedInfo the {@link FeedInfo} object for the feed that
75: * has been downloaded
76: * @param feedDataFile the file containing the downloaded, unparsed feed
77: * XML. <b><i>curn</i> may delete this file after all
78: * plug-ins are notified!</b>
79: * @param encoding the encoding used to store the data in the file,
80: * or null for the default
81: *
82: * @return <tt>true</tt> if <i>curn</i> should continue to process the
83: * feed, <tt>false</tt> to skip the feed. A return value of
84: * <tt>false</tt> aborts all further processing on the feed.
85: * In particular, <i>curn</i> will not pass the feed along to
86: * other plug-ins that have yet to be notified of this event.
87: *
88: * @throws CurnException on error
89: *
90: * @see FeedInfo
91: */
92: public boolean runPostFeedDownloadPlugIn(FeedInfo feedInfo,
93: File feedDataFile, String encoding) throws CurnException;
94:
95: }
|