org.eclipse.smila.bulkbuilder.helper
Class BulkbuilderServiceBase

java.lang.Object
  org.eclipse.smila.bulkbuilder.helper.BulkbuilderServiceBase

All Implemented Interfaces:

BulkbuilderService, JobListener, TaskKeepAliveListener

Direct Known Subclasses:

BulkbuilderServiceImpl

public abstract class BulkbuilderServiceBase
extends java.lang.Object
implements BulkbuilderService, JobListener, TaskKeepAliveListener

Base class for implementations of BulkBuilderService.

Constructor Summary

BulkbuilderServiceBase()

Method Summary

protected abstract void	activate(ComponentContext context)
protected void	activateService(BulkbuilderBase bulkbuilder, BulkbuilderTaskProvider taskProvider, RecordValidator validator) activate service with given bulkbuilder and validator.
WorkflowRunInfo	addRecord(java.lang.String jobName, Record record) add a record to a bulk to insert it to the given job.
WorkflowRunInfo	addToMicroBulk(java.lang.String jobName, Record record, java.lang.String microBulkId) Adds a record to a micro bulk with the given id.
protected void	checkActive() check if service is active and throw an exception otherwise.
WorkflowRunInfo	commitJob(java.lang.String jobName) commit the job with the given job name.
protected void	deactivate(ComponentContext context) OSGi Declarative Services service deactivation method.
WorkflowRunInfo	deleteRecord(java.lang.String jobName, Record record) add a record to a bulk to delete it from the given job.
WorkflowRunInfo	finishMicroBulk(java.lang.String jobName, java.lang.String microBulkId) Finishes the micro bulk with the given id.
protected BlackboardFactory	getBlackboardFactory() returns the BlackboardFactory service reference set by the DS.
JobManager	getJobManager() access jobmanager service reference, if already set.
ObjectStoreService	getObjectStoreService() access objectstore service reference, if already set.
TaskManager	getTaskManager() access taskmanager service reference, if already set.
WorkerManager	getWorkerManager() access objectstore service reference, if already set.
void	processJobEvent(JobEvent evt) Process a JobEvent.
void	removedTask(Task task) Called if the TaskKeepAlive gets to know that a Task (that is currently being kept alive) has been removed by the TaskManager.
void	removeMicroBulk(java.lang.String microBulkId) Remove the micro bulk with the given id.
protected void	setBlackboardFactory(BlackboardFactory factory) Sets a reference to a blackboard factory before activation.
void	setJobManager(JobManager jobManager) Sets the reference to the JobManager service.
void	setObjectStoreService(ObjectStoreService objectStoreService) method for DS to set a service reference.
void	setTaskManager(TaskManager taskManager) set task manager to use before activation.
void	setWorkerManager(WorkerManager workerManager)
protected void	unsetBlackboardFactory(BlackboardFactory factory) Resets a reference to a blackboard factory.
void	unsetJobManager(JobManager jobManager) Resets the reference to the JobManager service to null if the given jobManager instance is set.
void	unsetObjectStoreService(ObjectStoreService objectStoreService) method for DS to unset a service reference.
void	unsetTaskManager(TaskManager taskManager) remove task manager after deactivation.
void	unsetWorkerManager(WorkerManager workerManager)

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkbuilderServiceBase

public BulkbuilderServiceBase()

Method Detail

activateService

protected void activateService(BulkbuilderBase bulkbuilder,
                               BulkbuilderTaskProvider taskProvider,
                               RecordValidator validator)

activate service with given bulkbuilder and validator. To be called from activate(ComponentContext) implementation in subclass.

activate

protected abstract void activate(ComponentContext context)

Parameters:

context - OSGi service component context.

deactivate

protected void deactivate(ComponentContext context)

OSGi Declarative Services service deactivation method.

Parameters:

context - OSGi service component context.

addRecord

public WorkflowRunInfo addRecord(java.lang.String jobName,
                                 Record record)
                          throws BulkbuilderException,
                                 InvalidRecordException

Description copied from interface: BulkbuilderService

add a record to a bulk to insert it to the given job. Create a new bulk if none is open. Finish it and create a task for it if the maximum bulk size is exceeded. If record is null an IllegalArgumentException is thrown.

Specified by:

addRecord in interface BulkbuilderService

Parameters:

jobName - job name

record - record to add.

Returns:

Id of job and workflow run to which the records was added.

Throws:

BulkbuilderException - error writing the record.

InvalidRecordException - record does not conform to schema.

deleteRecord

public WorkflowRunInfo deleteRecord(java.lang.String jobName,
                                    Record record)
                             throws BulkbuilderException,
                                    InvalidRecordException

Description copied from interface: BulkbuilderService

add a record to a bulk to delete it from the given job. Create a new bulk if none is open. Finish it and create a task for it if the maximum bulk size is exceeded. If record is null an IllegalArgumentException is thrown.

Specified by:

deleteRecord in interface BulkbuilderService

Parameters:

jobName - job name

record - record to add.

Returns:

Id of job and workflow run to which the records was added.

Throws:

BulkbuilderException - error writing the record.

InvalidRecordException - record does not conform to schema.

commitJob

public WorkflowRunInfo commitJob(java.lang.String jobName)
                          throws BulkbuilderException

Description copied from interface: BulkbuilderService

commit the job with the given job name.

Specified by:

commitJob in interface BulkbuilderService

Parameters:

jobName - job name

Returns:

Id of job and workflow run to which the records was added.

Throws:

BulkbuilderException - error committing the job

addToMicroBulk

public WorkflowRunInfo addToMicroBulk(java.lang.String jobName,
                                      Record record,
                                      java.lang.String microBulkId)
                               throws BulkbuilderException,
                                      InvalidRecordException

Description copied from interface: BulkbuilderService

Adds a record to a micro bulk with the given id.

Specified by:

addToMicroBulk in interface BulkbuilderService

Parameters:

jobName - the job name

record - The record

microBulkId - The id of the micro bulk

Returns:

The workflow run info.

Throws:

BulkbuilderException - error writing the record.

InvalidRecordException - record does not conform to schema.

finishMicroBulk

public WorkflowRunInfo finishMicroBulk(java.lang.String jobName,
                                       java.lang.String microBulkId)
                                throws BulkbuilderException

Description copied from interface: BulkbuilderService

Finishes the micro bulk with the given id. This also removes the micro bulk after successful processing.

Specified by:

finishMicroBulk in interface BulkbuilderService

Parameters:

jobName - the job name

microBulkId - The id

Returns:

the workflow run info

Throws:

BulkbuilderException - error writing the micro bulk.

removeMicroBulk

public void removeMicroBulk(java.lang.String microBulkId)

Description copied from interface: BulkbuilderService

Remove the micro bulk with the given id.

Specified by:

removeMicroBulk in interface BulkbuilderService

Parameters:

microBulkId - The micro bulk to remove

processJobEvent

public void processJobEvent(JobEvent evt)

Description copied from interface: JobListener

Process a JobEvent.

Specified by:

processJobEvent in interface JobListener

Parameters:

evt - the job event.

removedTask

public void removedTask(Task task)

Called if the TaskKeepAlive gets to know that a Task (that is currently being kept alive) has been removed by the TaskManager.

Specified by:

removedTask in interface TaskKeepAliveListener

Parameters:

task - the task that has been removed.

checkActive

protected void checkActive()
                    throws BulkbuilderException

check if service is active and throw an exception otherwise.

Throws:

BulkbuilderException - if service is not active.

getObjectStoreService

public ObjectStoreService getObjectStoreService()

access objectstore service reference, if already set.

setObjectStoreService

public void setObjectStoreService(ObjectStoreService objectStoreService)

method for DS to set a service reference.

Parameters:

objectStoreService - ObjectStoreService reference.

unsetObjectStoreService

public void unsetObjectStoreService(ObjectStoreService objectStoreService)

method for DS to unset a service reference.

Parameters:

objectStoreService - ObjectStoreService reference.

getTaskManager

public TaskManager getTaskManager()

access taskmanager service reference, if already set.

setTaskManager

public void setTaskManager(TaskManager taskManager)

set task manager to use before activation.

Parameters:

taskManager - the task manager

unsetTaskManager

public void unsetTaskManager(TaskManager taskManager)

remove task manager after deactivation.

Parameters:

taskManager - the task manager

getJobManager

public JobManager getJobManager()

access jobmanager service reference, if already set.

setJobManager

public void setJobManager(JobManager jobManager)

Sets the reference to the JobManager service.

Parameters:

jobManager - the reference to the JobManager service.

unsetJobManager

public void unsetJobManager(JobManager jobManager)

Resets the reference to the JobManager service to null if the given jobManager instance is set.

Parameters:

jobManager - the reference to the current JobManager service.

getWorkerManager

public WorkerManager getWorkerManager()

access objectstore service reference, if already set.

setWorkerManager

public void setWorkerManager(WorkerManager workerManager)

Parameters:

workerManager - the reference to the WorkerManager service.

unsetWorkerManager

public void unsetWorkerManager(WorkerManager workerManager)

Parameters:

workerManager - the reference to the current WorkerManager service.

getBlackboardFactory

protected BlackboardFactory getBlackboardFactory()

returns the BlackboardFactory service reference set by the DS.

setBlackboardFactory

protected void setBlackboardFactory(BlackboardFactory factory)

Sets a reference to a blackboard factory before activation. Called by OSGi Declarative Services.

unsetBlackboardFactory

protected void unsetBlackboardFactory(BlackboardFactory factory)

Resets a reference to a blackboard factory. Called by OSGi Declarative Services.