Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.gateway
Interface GatewayExporter

All Known Implementing Classes:
NewsgroupExporter, SmtpExporter

public interface GatewayExporter

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

See Also:
Gateway, GatewayImporter

Method Summary
 void exportData(ForumMessage message)
          Export a single message to the data source.
 void exportData(ForumMessage[] messages)
          Export a group of messages to the data source.
 java.util.Date getLastExport()
          Last date this exporter completed
 void stop()
          Stop a running export.
 

Method Detail

exportData

void exportData(ForumMessage message)
                throws GatewayException
Export a single message to the data source. For example, a concrete implementation of this interface might post the message to a newsgroup.

Parameters:
message - a message to export.
Throws:
GatewayException

exportData

void exportData(ForumMessage[] messages)
                throws GatewayException
Export a group of messages to the data source.

Parameters:
messages - an array of messages to export.
Throws:
GatewayException

getLastExport

java.util.Date getLastExport()
Last date this exporter completed

Returns:
the last date this exporter completed

stop

void stop()
          throws GatewayException
Stop a running export.

Throws:
GatewayException

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.