DBConnector.java

package uk.bl.monitrix.database;

import com.datastax.driver.core.Session;
import uk.bl.monitrix.model.AlertLog;
import uk.bl.monitrix.model.CrawlLog;
import uk.bl.monitrix.model.CrawlStats;
import uk.bl.monitrix.model.IngestSchedule;
import uk.bl.monitrix.model.KnownHostList;
import uk.bl.monitrix.model.VirusLog;

/**
 * A connection interface for read access to the Monitrix DB.
 * @author Rainer Simon <rainer.simon@ait.ac.at>
 */
public interface DBConnector {

    public boolean isAvailable();
	
	/**
	 * Returns the DB-backed ingest schedule.
	 * @return the ingest schedule
	 */
	public IngestSchedule getIngestSchedule();
	
	/**
	 * Returns DB-backed crawl log.
	 * @return the crawl log
	 */
	public CrawlLog getCrawlLog();

	/**
	 * Returns DB-backed crawl stats.
	 * @return the crawl stats
	 */
	public CrawlStats getCrawlStats();

	/**
	 * Returns the DB-backed alert log.
	 * @return the alert log
	 */
	public AlertLog getAlertLog();

	/**
	 * Returns the DB-backed known host list.
	 * @return the known host list
	 */
	public KnownHostList getKnownHostList();
	
	/**
	 * Returns the DB-backed virus log.
	 * @return the virus log
	 */
	public VirusLog getVirusLog();
	
	/** 
	 * Returns an extension table (i.e. a DB table maintained by a Monitrix extension) with
	 * the specified name and type.
	 * @param name the table name
	 * @param type the type
	 * @return the table
	 */
	public <T extends ExtensionTable> T getExtensionTable(String name, Class<T> type);

	/**
	 * Closes the connection
	 */
	public void close();

}