Jump to: navigation, search

SMILA/Documentation/Usage of Blackboard Service

What is Blackboard

Purpose of the Blackboard is management of SMILA record data during processing in SMILA component (Connectivity, Workflow Processor). Complete record data is stored only on a Blackboard which is not pushed through the workflow engine itself. The Blackboard hides handling of record persistence from the services. Clients should generally manipulate records using Blackboard API methods in most cases so records will be completely under control of the Blackboard.

Creation and Lifecycle of Blackboard

For Blackboard creation we use a BlackboardFactory service running as a declarative service.

  • The factory can create Blackboard instances which are either "transient" (pure in-memory implementation, not using any storages) or "persisting" (linked to binary storage and optionally to record storage). The client selects which kind of blackboard it wants to use. A persisting blackboard can only be created successfully, if at least a binary storage is known. Creation of transient blackboards is always possible.
  • For each "session" an own new blackboard instance is created that manages only those records worked on by this request. A session is for example:
    • a single task list execution of a QueueWorker router or listener (i.e. add/delete one record in Connectivity, or processing one input record from a queue message and manage all additional records created by the invoked workflows)
    • a single search request in the search service.
  • After the session the blackboard instance is released completely, thus freeing any memory resources automatically without interfering with other blackboard sessions.

BlackboardFactory interfaces

interface BlackboardFactory {
  /**
   * create a new non-persisting blackboard instance. 
   * This method must always return a valid empty blackboard instance.
   */
  Blackboard createTransientBlackboard();
 
  /**
   * create a blackboard able to persist records in storages
   * @throws BlackboardAccessException no persisting blackboard can be created, because 
   * not even a  binary storage service is available (record storage remains optional)
   */
  Blackboard createPersistingBlackboard() throws BlackboardAccessException;
}

Usage of Blackboard

Record lifecycle on the Blackboard

Record can be put onto Blackboard with one of the following operations:

  • create(Id);
    Creates a new record with a given Id. No data is loaded from persistence. If record with this Id already exists in the storages it will be overwritten when the created record will be committed. E.g. used by Connectivity to initialize the record from incoming data.
  • load(Id);
    Loads record data for the given Id from persistence. Used by a client to indicate that it wants to process this record.
  • split(Id, String);
    Creates a fragment of a given record, i.e. the record content is copied to a new Id derived from the given by adding a frament name (see Id Concept for details).
  • setRecord(Record);
    Puts record on the Blackboard, saves record attachments to BinStorage and replaces actual record attachments values with null.
  • synchronize(Record);
    Assumes that record with the same Id as of given record already exists on Blackboard or in storage. Loads record from the storage if needed and updates it's properties with properties of the given record.

Record is removed from the blackboard with one of these operations:

  • commit(Id);
    Saves record and attachments to storages and removes record from the Blackboard.
  • invalidate(Id);
    Record is removed from the Blackboard. If the record was created new (not overwritten) on the Blackboard it will be removed completely.

Attachments management

There are following methods for working with Record attachments in the Blackboard:

  • setAttachment(id, name, byte[]);
  • setAttachmentFromStream(id, name, InputStream);
  • byte[] getAttachment(id, name);
  • InputStream getAttachmentAsStream(id, name);
  • boolean hasAttachment(id, name);

Attachments are not stored anywhere in the Blackboard, they are saved to BinStorage directly and the actual attachment value in the corresponding Record is replaced with Template:Null. It is highly recommended to use only Stream methods to manage attachments because loading the whole attachments in memory will cause great memory consumption and can be cause for application crash.

Usage of Blackboard Notes

Notes is additional temporary data created by pipelets to be used in later pipelets in the same workflow, but not to be persisted in the storages. Notes can be either global or record specific (associated with a record Id). Record specific notes are copied on record splits and removed when the associated record is removed from the Blackboard. Each Note has a String name and Serialaizable value. There are following methods for working with Notes:

  • boolean hasGlobalNote(name);
  • Serializable getGlobalNote(name);
  • setGlobalNote(name, value);
  • boolean hasRecordNote(id, name);
  • getRecordNote(id, name);
  • setRecordNote(id, name, value);

Usage of Path with Blackboard methods

Some methods of Blackboard accept Path as an argument, for example getAttributeNames(Id, Path). Path represents the attribute path in the Record. String format of Path looks like attributeName1[index1]/attributeName2[index2]/.... The specification of index is optional and defaults to 0. Index can refer to a literal or a sub-object that depends on methods getting the argument.

Consider the following example Record structure:

<Record>
  <A n="AccessTreeExpanded">
    <O>
      <A n="account">
        <O>
          <A n="sub">
            <O>
              <A n="sid">
                <L>
                  <V>Value1</V>
                </L>
                <L>
                  <V>Value2</V>
                </L>
              </A>
            </O>
            <O>
              <A n="sid">
                <L>
                  <V>Value3</V>
                </L>
              </A>
            </O>
         </A>
        </O>
      </A>
    </O>
  </A>
</Record>

The path to access first MObject (<O>) of the sub attribute is "AccessTreeExpanded[0]/account[0]/sub[0]/". Index in each step means the number of MObject inside the attribute. That is, to access second MObject of the sub attribute the path will be "AccessTreeExpanded[0]/account[0]/sub[1]/".

There are some cases when index of last step has a different meaning:

- in the getLiteral(Id, Path) method the index of last step means the number of literal inside the attribute. That is, path for accessing literal from sid attribute of second sub MObject (literal with value "Value3") will be "AccessTreeExpanded[0]/account[0]/sub[1]/sid[0]" and path for accessing second literal of sid attribute of first sub MObject (literal with value "Value2") will be: " AccessTreeExpanded[0]/account[0]/sub[0]/sid[1]".

- in the getLiterals(Id, Path) method index of last step is irrelevant, that means this method will return all literals of the attribute found at the given path;

- in the setLiteral(Id, Path, Value) and addLiteral(Id, Path, Value) methods index of last step is irrelevant, that means that literal will be set or added to the attribute found on specified path

- in the methods that modify annotations to access root annotations of the record path should be null, "" (empty string), or empty Path