Package org.imixs.archive.importer.ftp

Class CSVImportService

java.lang.Object

org.imixs.archive.importer.ftp.CSVImportService

@Named
public class CSVImportService
extends Object

The CSVImportService reacts on DocumentImportEvent and imports a CSV file form a FTP data source.

The implementation is based on org.apache.commons.net.ftp

The CSV import can be customized by various options

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATA_ERROR
static final String	IMPORT_ERROR

Constructor Summary

Constructors

Constructor	Description
CSVImportService()

Method Summary

Modifier and Type	Method	Description
org.imixs.workflow.ItemCollection	findEntityByName(String key, String type)	This method finds a entity by the attribute 'Name'
String	importData(InputStream inputStream, String encoding, String type, String keyField, DocumentImportEvent event)	This method imports all entities from a csv file.
protected org.imixs.workflow.FileData	importFromFTP(String ftpServer, String csvSelector, String encoding, DocumentImportEvent event)	Helper method to import the data source from a FTP server The method returns a byte array with the file raw data.
void	onEvent(DocumentImportEvent event)	This method reacts on a CDI ImportEvent and imports the data of a CSV file form a ftp server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DATA_ERROR

public static final String DATA_ERROR

See Also:

• Constant Field Values

IMPORT_ERROR

public static final String IMPORT_ERROR

See Also:

• Constant Field Values

Constructor Details

CSVImportService

public CSVImportService()

Method Details

onEvent

public void onEvent(@Observes
 DocumentImportEvent event)

This method reacts on a CDI ImportEvent and imports the data of a CSV file form a ftp server.

importFromFTP

protected org.imixs.workflow.FileData importFromFTP(String ftpServer,
 String csvSelector,
 String encoding,
 DocumentImportEvent event)

Helper method to import the data source from a FTP server The method returns a byte array with the file raw data.

importData

public String importData(InputStream inputStream,
 String encoding,
 String type,
 String keyField,
 DocumentImportEvent event)
                  throws org.imixs.workflow.exceptions.PluginException

This method imports all entities from a csv file. The file must have one header line.

The method runs in a new transaction so processing exceptions can be caught.

All existing entries not listed in the current file will be removed.

Each imported document will have a unique key in the item 'name' to be used to verify if the entry already exists.

Optional a workflow task/event can be defined in the source configuration. In this case the entity will be processed. Otherwise it will be saved only.

The method returns a log . If an error occurs a plugin exception is thrown

Returns:

ErrorMessage or empty String

Throws:

org.imixs.workflow.exceptions.PluginException

findEntityByName

public org.imixs.workflow.ItemCollection findEntityByName(String key,
 String type)

This method finds a entity by the attribute 'Name'

Parameters:

key - - name of the object (name)

type - - type of the object

Returns:

entity or null if no entity with the given name exists