SMILA (incubation) API documentation

org.eclipse.smila.processing
Interface ProcessingService

All Known Implementing Classes:
LuceneIndexService, MimeTypeIdentifyService, SampleSecurityConverter

public interface ProcessingService

Interface of SMILA ProcessingServices (aka "Big Pipelets"). In contrast to "SimplePipelets" instances of ProcessingServices are not instantiated and configured by the Workflow engine, but are started as OSGi services (preferably by Declarative Services) independently from the workflow engine and can read their configuration from wherever they want. Their service registration must have a property named "smila.processing.service.name" that specifies the name with which the service is references by the workflow engine.

Author:
jschumacher

Field Summary
static java.lang.String PROPERTY_NAME
          Property of OSGi services specifying the name of the service.
 
Method Summary
 Id[] process(Blackboard blackboard, Id[] recordIds)
          process records on Blackboard service.
 

Field Detail

PROPERTY_NAME

static final java.lang.String PROPERTY_NAME
Property of OSGi services specifying the name of the service. The workflow engine needs this name to determine which service to invoke from the workflow.

See Also:
Constant Field Values
Method Detail

process

Id[] process(Blackboard blackboard,
             Id[] recordIds)
             throws ProcessingException
process records on Blackboard service.

Parameters:
blackboard - Blackboard service managing the records.
recordIds - Ids of records to process.
Returns:
Ids of result records.
Throws:
ProcessingException - error during processing.

SMILA (incubation) API documentation