com.sun.syndication.fetcher.impl
Class AbstractFeedFetcher

java.lang.Object
  extended bycom.sun.syndication.fetcher.impl.AbstractFeedFetcher
All Implemented Interfaces:
FeedFetcher
Direct Known Subclasses:
HttpClientFeedFetcher, HttpURLFeedFetcher

public abstract class AbstractFeedFetcher
extends java.lang.Object
implements FeedFetcher


Field Summary
 
Fields inherited from interface com.sun.syndication.fetcher.FeedFetcher
DEFAULT_USER_AGENT
 
Constructor Summary
AbstractFeedFetcher()
           
 
Method Summary
 void addFetcherEventListener(FetcherListener listener)
          Add a FetcherListener.
static com.sun.syndication.feed.synd.SyndFeed combineFeeds(com.sun.syndication.feed.synd.SyndFeed originalFeed, com.sun.syndication.feed.synd.SyndFeed newFeed)
          Combine the entries in two feeds into a single feed.
protected  void fireEvent(java.lang.String eventType, java.lang.String urlStr)
           
protected  void fireEvent(java.lang.String eventType, java.lang.String urlStr, com.sun.syndication.feed.synd.SyndFeed feed)
           
protected  void fireEvent(java.lang.String eventType, java.net.URLConnection connection)
           
protected  void fireEvent(java.lang.String eventType, java.net.URLConnection connection, com.sun.syndication.feed.synd.SyndFeed feed)
           
 java.lang.String getUserAgent()
           
protected  void handleErrorCodes(int responseCode)
          Handles HTTP error codes.
 boolean isUsingDeltaEncoding()
          Is this fetcher using rfc3229 delta encoding?
 void removeFetcherEventListener(FetcherListener listener)
          Remove a FetcherListener
 void setUserAgent(java.lang.String string)
           
 void setUsingDeltaEncoding(boolean useDeltaEncoding)
          Turn on or off rfc3229 delta encoding
protected  void throw4XXError(int responseCode)
           
protected  void throwAuthenticationError(int responseCode)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.sun.syndication.fetcher.FeedFetcher
retrieveFeed
 

Constructor Detail

AbstractFeedFetcher

public AbstractFeedFetcher()
Method Detail

getUserAgent

public java.lang.String getUserAgent()
Specified by:
getUserAgent in interface FeedFetcher
Returns:
the User-Agent currently being sent to servers

setUserAgent

public void setUserAgent(java.lang.String string)
Specified by:
setUserAgent in interface FeedFetcher
Parameters:
string - The User-Agent to sent to servers

fireEvent

protected void fireEvent(java.lang.String eventType,
                         java.net.URLConnection connection)
Parameters:
eventType - The event type to fire
connection - the current connection

fireEvent

protected void fireEvent(java.lang.String eventType,
                         java.net.URLConnection connection,
                         com.sun.syndication.feed.synd.SyndFeed feed)
Parameters:
eventType - The event type to fire
connection - the current connection
feed - The feed to pass to the event

fireEvent

protected void fireEvent(java.lang.String eventType,
                         java.lang.String urlStr)
Parameters:
eventType - The event type to fire
urlStr - the current url as a string

fireEvent

protected void fireEvent(java.lang.String eventType,
                         java.lang.String urlStr,
                         com.sun.syndication.feed.synd.SyndFeed feed)
Parameters:
eventType - The event type to fire
urlStr - the current url as a string
feed - The feed to pass to the event

addFetcherEventListener

public void addFetcherEventListener(FetcherListener listener)
Description copied from interface: FeedFetcher

Add a FetcherListener.

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

Specified by:
addFetcherEventListener in interface FeedFetcher
Parameters:
listener - The FetcherListener to recieve the event
See Also:
FeedFetcher.addFetcherEventListener(com.sun.syndication.fetcher.FetcherListener)

removeFetcherEventListener

public void removeFetcherEventListener(FetcherListener listener)
Description copied from interface: FeedFetcher

Remove a FetcherListener

Specified by:
removeFetcherEventListener in interface FeedFetcher
Parameters:
listener - The FetcherListener to remove
See Also:
FeedFetcher.removeFetcherEventListener(com.sun.syndication.fetcher.FetcherListener)

isUsingDeltaEncoding

public boolean isUsingDeltaEncoding()
Description copied from interface: FeedFetcher

Is this fetcher using rfc3229 delta encoding?

Specified by:
isUsingDeltaEncoding in interface FeedFetcher
Returns:
Returns the useDeltaEncoding.

setUsingDeltaEncoding

public void setUsingDeltaEncoding(boolean useDeltaEncoding)
Description copied from interface: FeedFetcher

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!

Specified by:
setUsingDeltaEncoding in interface FeedFetcher
Parameters:
useDeltaEncoding - The useDeltaEncoding to set.

handleErrorCodes

protected void handleErrorCodes(int responseCode)
                         throws FetcherException

Handles HTTP error codes.

Parameters:
responseCode - the HTTP response code
Throws:
FetcherException - if response code is in the range 400 to 599 inclusive

throw4XXError

protected void throw4XXError(int responseCode)
                      throws FetcherException
Throws:
FetcherException

throwAuthenticationError

protected void throwAuthenticationError(int responseCode)
                                 throws FetcherException
Throws:
FetcherException

combineFeeds

public static com.sun.syndication.feed.synd.SyndFeed combineFeeds(com.sun.syndication.feed.synd.SyndFeed originalFeed,
                                                                  com.sun.syndication.feed.synd.SyndFeed newFeed)

Combine the entries in two feeds into a single feed.

The returned feed will have the same data as the newFeed parameter, with the entries from originalFeed appended to the end of its entries.

Parameters:
originalFeed -
newFeed -
Returns:


Copyright © 2004-2005 Sun Microsystems. All Rights Reserved.