com.sun.syndication.fetcher.FeedFetcher Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2004 Sun Microsystems, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package com.sun.syndication.fetcher;

import java.io.IOException;
import java.net.URL;

import com.sun.syndication.feed.synd.SyndFeed;
import com.sun.syndication.io.FeedException;

public interface FeedFetcher {
	/**
	 * 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. 
	 * 
	 */
	public static String DEFAULT_USER_AGENT = "Rome Client (http://tinyurl.com/64t5n)";

	/**
	 * @return the User-Agent currently being sent to servers
	 */
	public abstract String getUserAgent();
	/**
	 * @param string The User-Agent to sent to servers
	 */
	public abstract void setUserAgent(String string);
	/**
	 * Retrieve a feed over HTTP
	 *
	 * @param feedUrl A non-null URL of a RSS/Atom feed to retrieve
	 * @return A {@link com.sun.syndication.feed.synd.SyndFeed} object
	 * @throws IllegalArgumentException if the URL is null;
	 * @throws IOException if a TCP error occurs
	 * @throws FeedException if the feed is not valid
	 * @throws FetcherException if a HTTP error occurred
	 */
	public abstract SyndFeed retrieveFeed(URL feedUrl)	throws IllegalArgumentException, IOException, FeedException, FetcherException;

	/**
	 * Add a FetcherListener.
	 *
	 * The FetcherListener will receive an FetcherEvent when
	 * a Fetcher event (feed polled, retrieved, etc) occurs
	 *
	 * @param listener The FetcherListener to recieve the event
	 */
	public abstract void addFetcherEventListener(FetcherListener listener);

	/**
	 * Remove a FetcherListener
	 *
	 * @param listener The FetcherListener to remove
	 */
	public abstract void removeFetcherEventListener(FetcherListener listener);

	/**
	 * Is this fetcher using rfc3229 delta encoding?
	 * 
	 * @return
	 */
    public abstract boolean isUsingDeltaEncoding();

    /**
     * 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!
     * 
     * @param useDeltaEncoding
     */
    public abstract void setUsingDeltaEncoding(boolean useDeltaEncoding);
    
    /**
     * If set to true, the WireFeed will be made accessible from the SyndFeed object returned from the Fetcher 
     * via the originalWireFeed() method. Each Entry in the feed will have the corresponding wireEntry property set.
     */
    void setPreserveWireFeed(boolean preserveWireFeed);
	
}