com.jivesoftware.community.importer
Interface Importer

All Superinterfaces:

java.lang.Runnable

public interface Importer
extends java.lang.Runnable

An importer is used to bulk import content into a Clearspace instance. A variety of default importers are available to import from Jive Integrated Server, Jive Forums and Jive Knowledge Base. Custom importers can be created and added to the system via methods in the ImporterFactory class.

Implementations of this interface are required to have a no-argument constructor.

See Also:

ImporterFactory

Method Summary

com.jivesoftware.community.importer.Callback	getCallback() Returns a callback if one is waiting or null if no callback is waiting for user input.
com.jivesoftware.community.importer.ImportConfiguration	getConfiguration() Returns the import configuration for this importer.
java.util.Date	getFinishDate() Returns the date the import finished or null if the import has not yet finished
com.jivesoftware.community.importer.ImportStatistics	getImportStatistics() Returns statistics for the current import.
java.util.Date	getStartDate() Returns the date the import started or null if the import has not yet started
boolean	isFinished() Returns true if the importer has finished running.
boolean	isRunning() Returns true if the importer is currently running.
java.util.Map<java.lang.String,java.lang.String>	validateConfiguration() Returns a map of errors (field name -> error string) or an empty map if the configuration is deemed valid

Methods inherited from interface java.lang.Runnable

run

Method Detail

getConfiguration

com.jivesoftware.community.importer.ImportConfiguration getConfiguration()

Returns the import configuration for this importer.

Returns:

the import configuration for this importer.

validateConfiguration

java.util.Map<java.lang.String,java.lang.String> validateConfiguration()

Returns a map of errors (field name -> error string) or an empty map if the configuration is deemed valid

Returns:

a map of errors (field name -> error string) or an empty map if the configuration is deemed valid

isRunning

boolean isRunning()

Returns true if the importer is currently running.

Returns:

true if the importer is currently running.

isFinished

boolean isFinished()

Returns true if the importer has finished running.

Returns:

true if the importer has finished running.

getStartDate

java.util.Date getStartDate()

Returns the date the import started or null if the import has not yet started

Returns:

the date the import started

getFinishDate

java.util.Date getFinishDate()

Returns the date the import finished or null if the import has not yet finished

Returns:

the date the import finished

getImportStatistics

com.jivesoftware.community.importer.ImportStatistics getImportStatistics()

Returns statistics for the current import.

Returns:

statistics for the current import.

getCallback

com.jivesoftware.community.importer.Callback getCallback()

Returns a callback if one is waiting or null if no callback is waiting for user input.

Returns:

a callback if one is waiting or null if no callback is waiting for user input.