Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.gateway
Interface GatewayImporter

All Known Implementing Classes:
ImapImporter, JavaMailImporter, MboxImporter, NewsgroupImporter, NewsgroupImporter.NNTPImporter, Pop3Importer

public interface GatewayImporter

A gateway importer knows how to import forum data from an external data source. It can be combined with a gateway exporter to make a full gateway.

See Also:
Gateway, GatewayExporter

Nested Class Summary
static class GatewayImporter.Stats
           
 
Method Summary
 java.util.Date getLastImport()
          Returns the Last date this importer completed
 GatewayImporter.Stats getStats()
           
 void importData(java.util.Date date)
          Import data from the data source into the specified forum.
 boolean isImporting()
           
 void setImporting(boolean importing)
           
 void stop()
          Stop a running import.
 

Method Detail

importData

void importData(java.util.Date date)
                throws GatewayException
Import data from the data source into the specified forum. For example, a concrete implementation of this interface might poll a newsgroup and add new messages to the forum.

Parameters:
date - the oldest cutoff date for data to import.
Throws:
GatewayException

getLastImport

java.util.Date getLastImport()
Returns the Last date this importer completed

Returns:
the last date this importer completed

stop

void stop()
          throws GatewayException
Stop a running import.

Throws:
GatewayException

isImporting

boolean isImporting()

setImporting

void setImporting(boolean importing)

getStats

GatewayImporter.Stats getStats()

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.