SMILA (incubation) API documentation

org.eclipse.smila.blackboard
Interface BlackboardFactory

All Known Implementing Classes:
BlackboardFactoryImpl

public interface BlackboardFactory

Factory service to create blackboard instances.

Author:
jschumacher

Method Summary
 Blackboard createBlackboard(boolean useRecordStorage, boolean useBinaryStorage)
          creates a blackboard.
 Blackboard createPersistingBlackboard()
          create a new persisting blackboard instance.
 Blackboard createTransientBlackboard()
          create a new non-persisting blackboard instance.
 

Method Detail

createBlackboard

Blackboard createBlackboard(boolean useRecordStorage,
                            boolean useBinaryStorage)
                            throws BlackboardAccessException
creates a blackboard.

Parameters:
useRecordStorage - if true, the records will be stored using the RecordStorage service.
useBinaryStorage - if true, the attachments will be stored using the BinaryStorage service.
Returns:
a blackboard with the desired storages attached to it.
Throws:
BlackboardAccessException - could not create the blackboard, or one of the desired services is not available.

createPersistingBlackboard

Blackboard createPersistingBlackboard()
                                      throws BlackboardAccessException
create a new persisting blackboard instance. If a record storage is available, it will be used. The Blackboard uses a binary storage to store attachments.

Returns:
blackboard instance that does persist into storages.
Throws:
BlackboardAccessException - could not create the blackboard, or no binary storage service is available.

createTransientBlackboard

Blackboard createTransientBlackboard()
create a new non-persisting blackboard instance. This method must always return a valid empty blackboard instance.

Returns:
blackboard instance that does not persist into storages.

SMILA (incubation) API documentation