java.lang.Object
net.i2p.addressbook.SubscriptionList
All Implemented Interfaces:
Iterable<AddressBook>
class SubscriptionListextends Object implements Iterable<AddressBook>
A list of Subscriptions loaded from a file.

  • Field Details

    • subscriptions

      private final List<Subscription> subscriptions
      The subscriptions, in file order.

    • etagsFile

      private final File etagsFile
      Where each subscription's ETag is remembered.

    • lastModifiedFile

      private final File lastModifiedFile
      Where each subscription's last-modified date is remembered.

    • lastFetchedFile

      private final File lastFetchedFile
      Where each subscription's last fetch time is remembered.

    • delay

      private final long delay
      Pause between fetches, in ms.

    • proxyHost

      private final String proxyHost
      Proxy used for the fetches, null for none.

    • proxyPort

      private final int proxyPort
      Port of that proxy.

  • Constructor Details

    • SubscriptionList

      public SubscriptionList(File locationsFile, File etagsFile, File lastModifiedFile, File lastFetchedFile, long delay, List<String> defaultSubs, String proxyHost, int proxyPort)
      Construct a SubscriptionList using the urls from locationsFile and, if available, the etags and last-modified headers loaded from etagsFile and lastModifiedFile.
      Parameters:
      locationsFile - A file containing one url on each line.
      etagsFile - A file containg the etag headers used for conditional GET. The file is in the format "url=etag".
      lastModifiedFile - A file containg the last-modified headers used for conditional GET. The file is in the format "url=leastmodified".
      lastFetchedFile - A file containing the last-fetched timestamps used to enforce the minimum delay between fetches. The file is in the format "url=lastfetched".
      delay - the minimum delay since last fetched for the iterator to actually fetch
      defaultSubs - default subscription file
      proxyHost - proxy hostname, null for no proxy
      proxyPort - proxy port number

    • SubscriptionList

      public SubscriptionList(String hoststxt)
      Testing only.
      Parameters:
      hoststxt - path to a local file used as the test 'subscription' input

  • Method Details

    • iterator

      public SubscriptionIterator iterator()
      Return an iterator over the AddressBooks represented by the Subscriptions in this SubscriptionList.
      Specified by:
      iterator in interface Iterable<AddressBook>
      Returns:
      an iterator over the AddressBooks of every subscription

    • write

      public void write()
      Write the etag and last-modified headers, and the last-fetched time, for each Subscription to files. BUG - If the subscription URL is a cgi containing an '=' the files won't be read back correctly; the '=' should be escaped.