com.torrentMech.crawler
Interface Plugin

All Superinterfaces:
java.lang.Runnable

public interface Plugin
extends java.lang.Runnable

The Plugin interface is the base for all web site parsing for torrents. Classes implement the methods here plus the run() method from the java.lang.Runnable extension and are called from the com.torrentMech.crawler.TorrentCrawler class as a new thread. The TorrentCrawler class starts the plugin and routinely calls the getStatus() method to check on the status of the plugin. Upon completion of its work, the Plugin implementation's getIterator() method is called by TorrentCrawler and its torrent files are iterated and stored in the DBMS.

Version:
.01 alpha
Author:
Will Bailey

Method Summary
 java.util.Iterator getIterator()
          Returns a java.util.Iterator that can be used to iterate through the bencoded torrents that this Plugin implementation retrieves from the web.
 java.lang.String getStatus()
          Returns a java.lang.String status message giving useful information about the current state/progress of the Plugin's torrent retrieval status.
 
Methods inherited from interface java.lang.Runnable
run
 

Method Detail

getIterator

java.util.Iterator getIterator()
Returns a java.util.Iterator that can be used to iterate through the bencoded torrents that this Plugin implementation retrieves from the web.

Returns:
A java.util.Iterator containing bencoded torrents.

getStatus

java.lang.String getStatus()
Returns a java.lang.String status message giving useful information about the current state/progress of the Plugin's torrent retrieval status.

Returns:
A java.lang.String status message.