| java.lang.Object
 com.bigbross.bossa.BossaFactory
| BossaFactory | | public class BossaFactory (Code) | | This class handles the creation of a Bossa instance.
To use it, create an instance of this factory class, configure the
available Bossa options by calling methods of this instance and create
the Bossa instance using the createBossa() method.
Alternatively, use one of the provided static methods to get a preconfigured
Bossa instance.
author:
BigBross Team |
| Constructor Summary | |
| public | BossaFactory()
Creates a new Bossa factory with default configuration values. |
| Method Summary | |
| public Bossa | createBossa()
Creates a Bossa engine instance using the current configuration
of the Bossa factory. | | public static Bossa | defaultBossa()
Creates a Bossa engine instance with the default configuration
values. | | public void | setActiveHistorian(boolean activeHistorian)
Configures if the created Bossa will log its events in the historian
or not. | | public void | setStateDir(String dir)
Configures the directory where Bossa will save its state. | | public void | setTimeSource(TimeSource timeSource)
Configures the time source of a transient Bossa engine. | | public void | setTransientBossa(boolean transientBossa)
Configures if the created Bossa is transient or not. | | public static Bossa | transientBossa()
Creates a transient Bossa engine instance, keeping all other default
configuration values. |
| BossaFactory | | public BossaFactory()(Code) | | Creates a new Bossa factory with default configuration values.
|
| createBossa | | public Bossa createBossa() throws PersistenceException(Code) | | Creates a Bossa engine instance using the current configuration
of the Bossa factory.
the newly created bossa engine.
exception:
PersistenceException - if an error occours starting thepersistence mechanism. |
| defaultBossa | | public static Bossa defaultBossa() throws PersistenceException(Code) | | Creates a Bossa engine instance with the default configuration
values.
the newly created bossa engine.
exception:
PersistenceException - if an error occours starting thepersistence mechanism. |
| setActiveHistorian | | public void setActiveHistorian(boolean activeHistorian)(Code) | | Configures if the created Bossa will log its events in the historian
or not.
Default: true.
Parameters:
activeHistorian - true for the historian to logevents, false for the historianto ignore events. |
| setStateDir | | public void setStateDir(String dir)(Code) | | Configures the directory where Bossa will save its state.
If the provided directory is empty, a new Bossa engine will be created.
If the provided directory contains data of an already running Bossa
engine, it will be restarted using this data.
Default: "BossaState"
Parameters:
dir - the directory where Bossa will save its state. |
| setTimeSource | | public void setTimeSource(TimeSource timeSource)(Code) | | Configures the time source of a transient Bossa engine. See the
documentation of the TimeSource interface for more
information on time sources.
If you don't care about how time is handled by the Bossa engine,
usa an instance of the RealTimeSource class.
If you are trying to embed a transient Bossa engine in a larger
prevalent system, use an instance of the
DeterministicTimeSource class. Keep a reference to the
time source and set the time in it every time a transaction is
executed, all Bossa actions will happen using the time set.
Default: new RealTimeSource().
Parameters:
timeSource - the time source.
See Also: BossaFactory.setTransientBossa(boolean)
See Also: TimeSource
See Also: RealTimeSource
See Also: DeterministicTimeSource |
| setTransientBossa | | public void setTransientBossa(boolean transientBossa)(Code) | | Configures if the created Bossa is transient or not.
A transient Bossa won't save its state, all operations
will be lost in case of system shutdown. However, it is still
serializable, so it can be included in a larger prevalent system
(if this is the case, look the setTimeSource method).
Default: false.
Parameters:
transientBossa - true to create a transient Bossa,false to create a persistent Bossa.
See Also: BossaFactory.setTimeSource(TimeSource)
See Also: |
| transientBossa | | public static Bossa transientBossa() throws PersistenceException(Code) | | Creates a transient Bossa engine instance, keeping all other default
configuration values.
the newly created bossa engine.
exception:
PersistenceException - if an error occours starting thepersistence mechanism. |
|
|