Package org.imixs.archive.importer

Class DocumentImportService

java.lang.Object

org.imixs.archive.importer.DocumentImportService

public class DocumentImportService
extends Object

The DocumentImportService provides definitions and methods to process a import source.

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ITEM_SOURCES
static final String	SOURCE_ITEM_EVENT
static final String	SOURCE_ITEM_MODELVERSION
static final String	SOURCE_ITEM_OPTIONS
static final String	SOURCE_ITEM_PASSWORD
static final String	SOURCE_ITEM_PORT
static final String	SOURCE_ITEM_SELECTOR
static final String	SOURCE_ITEM_SERVER
static final String	SOURCE_ITEM_TASK
static final String	SOURCE_ITEM_USER
static final String	SOURCE_ITEM_WORKFLOWGROUP

Constructor Summary

Constructors

Constructor	Description
DocumentImportService()

Method Summary

Modifier and Type	Method	Description
Properties	getOptionsProperties(org.imixs.workflow.ItemCollection source)	This helper method evaluates the options and returns a Properties object
List<org.imixs.workflow.ItemCollection>	loadSourcesFromConfiguration(org.imixs.workflow.ItemCollection configuration)	This method returns a list of ItemCollection objects representing the sources defined in a Importer configuration.
void	logMessage(String message, DocumentImportEvent event)	Creates a new log entry and stores the message into an optional event
void	logMessage(String message, org.imixs.workflow.ItemCollection config)	Creates a new log entry and stores the message into the item '_scheduler_logmessage' of an optional scheduler document

Methods inherited from class java.lang.Object

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

Field Details

ITEM_SOURCES

public static final String ITEM_SOURCES

See Also:

• Constant Field Values

SOURCE_ITEM_SERVER

public static final String SOURCE_ITEM_SERVER

See Also:

• Constant Field Values

SOURCE_ITEM_PORT

public static final String SOURCE_ITEM_PORT

See Also:

• Constant Field Values

SOURCE_ITEM_USER

public static final String SOURCE_ITEM_USER

See Also:

• Constant Field Values

SOURCE_ITEM_PASSWORD

public static final String SOURCE_ITEM_PASSWORD

See Also:

• Constant Field Values

SOURCE_ITEM_TASK

public static final String SOURCE_ITEM_TASK

See Also:

• Constant Field Values

SOURCE_ITEM_EVENT

public static final String SOURCE_ITEM_EVENT

See Also:

• Constant Field Values

SOURCE_ITEM_WORKFLOWGROUP

public static final String SOURCE_ITEM_WORKFLOWGROUP

See Also:

• Constant Field Values

SOURCE_ITEM_MODELVERSION

public static final String SOURCE_ITEM_MODELVERSION

See Also:

• Constant Field Values

SOURCE_ITEM_SELECTOR

public static final String SOURCE_ITEM_SELECTOR

See Also:

• Constant Field Values

SOURCE_ITEM_OPTIONS

public static final String SOURCE_ITEM_OPTIONS

See Also:

• Constant Field Values

Constructor Details

DocumentImportService

public DocumentImportService()

Method Details

loadSourcesFromConfiguration

public List<org.imixs.workflow.ItemCollection> loadSourcesFromConfiguration(org.imixs.workflow.ItemCollection configuration)

This method returns a list of ItemCollection objects representing the sources defined in a Importer configuration.

logMessage

public void logMessage(String message,
 DocumentImportEvent event)

Creates a new log entry and stores the message into an optional event

Parameters:

message -

source -

logMessage

public void logMessage(String message,
 org.imixs.workflow.ItemCollection config)

Creates a new log entry and stores the message into the item '_scheduler_logmessage' of an optional scheduler document

Parameters:

message -

source -

getOptionsProperties

public Properties getOptionsProperties(org.imixs.workflow.ItemCollection source)

This helper method evaluates the options and returns a Properties object

Throws:

org.imixs.workflow.exceptions.PluginException