org.eligosource.eventsourced.journal.hbase

HBaseJournalProps

case class HBaseJournalProps(zookeeperQuorum: String, tableName: String = ..., name: Option[String] = scala.None, dispatcherName: Option[String] = scala.None, replayChunkSize: Int = 16.*(100), initTimeout: FiniteDuration = ..., snapshotPath: Path = ..., snapshotSerializer: SnapshotSerializer = ..., snapshotLoadTimeout: FiniteDuration = ..., snapshotSaveTimeout: FiniteDuration = ..., snapshotFilesystem: FileSystem = ..., readOnly: Boolean = false) extends JournalProps with HadoopFilesystemSnapshottingProps[HBaseJournalProps] with Product with Serializable

Configuration object for a HBase backed journal. Journal actors can be created from a configuration object as follows:

import akka.actor._

import org.eligosource.eventsourced.core.Journal
import org.eligosource.eventsourced.journal.hbase.HBaseJournalProps

implicit val system: ActorSystem = ...

val zookeeperQuorum: String = ... // "localhost", for example
val tableName: String = ...       // "event", for example
val journal: ActorRef = Journal(HBaseJournalProps(zookeeperQuorum))

For storing event messages to HBase, an event message table must be initially created. See org.eligosource.eventsourced.journal.hbase.CreateTable and org.eligosource.eventsourced.journal.hbase.DeleteTable for details.

Event messages will be evenly distributed (partitioned) across table regions.

zookeeperQuorum

Comma separated list of servers in the ZooKeeper quorum. See also the hbase.zookeeper.quorum configuration property.

tableName

Event message table name.

name

Optional journal actor name.

dispatcherName

Optional journal actor dispatcher name.

replayChunkSize

Maximum number of event messages to keep in memory during replay.

initTimeout

Timeout for journal initialization. During initialization the highest stored sequence number is loaded from the event message table.

Linear Supertypes
Serializable, Serializable, Product, Equals, HadoopFilesystemSnapshottingProps[HBaseJournalProps], JournalProps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HBaseJournalProps
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. HadoopFilesystemSnapshottingProps
  7. JournalProps
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HBaseJournalProps(zookeeperQuorum: String, tableName: String = ..., name: Option[String] = scala.None, dispatcherName: Option[String] = scala.None, replayChunkSize: Int = 16.*(100), initTimeout: FiniteDuration = ..., snapshotPath: Path = ..., snapshotSerializer: SnapshotSerializer = ..., snapshotLoadTimeout: FiniteDuration = ..., snapshotSaveTimeout: FiniteDuration = ..., snapshotFilesystem: FileSystem = ..., readOnly: Boolean = false)

    zookeeperQuorum

    Comma separated list of servers in the ZooKeeper quorum. See also the hbase.zookeeper.quorum configuration property.

    tableName

    Event message table name.

    name

    Optional journal actor name.

    dispatcherName

    Optional journal actor dispatcher name.

    replayChunkSize

    Maximum number of event messages to keep in memory during replay.

    initTimeout

    Timeout for journal initialization. During initialization the highest stored sequence number is loaded from the event message table.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def createJournal(implicit actorRefFactory: ActorRefFactory): ActorRef

    Creates and starts a new journal using the settings of this configuration object.

    Creates and starts a new journal using the settings of this configuration object.

    Definition Classes
    JournalProps

  9. def createJournalActor: Actor

    Creates a journal actor instance.

    Creates a journal actor instance.

    Definition Classes
    HBaseJournalProps → JournalProps

  10. val dispatcherName: Option[String]

    Optional journal actor dispatcher name.

    Optional journal actor dispatcher name.

    Definition Classes
    HBaseJournalProps → JournalProps

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  14. val initTimeout: FiniteDuration

    Timeout for journal initialization.

    Timeout for journal initialization. During initialization the highest stored sequence number is loaded from the event message table.

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  16. val name: Option[String]

    Optional journal actor name.

    Optional journal actor name.

    Definition Classes
    HBaseJournalProps → JournalProps

  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  20. val readOnly: Boolean

    Make journal read only (e.

    Make journal read only (e.g. offline snapshot)

    Definition Classes
    HBaseJournalProps → JournalProps

  21. val replayChunkSize: Int

    Maximum number of event messages to keep in memory during replay.

  22. val snapshotFilesystem: FileSystem

    Hadoop filesystem for storing snapshots.

    Hadoop filesystem for storing snapshots.

    Definition Classes
    HBaseJournalProps → HadoopFilesystemSnapshottingProps

  23. val snapshotLoadTimeout: FiniteDuration

    Timeout for loading a snapshot.

    Timeout for loading a snapshot.

    Definition Classes
    HBaseJournalProps → HadoopFilesystemSnapshottingProps

  24. val snapshotPath: Path

    Path where snapshots are stored on snapshotFilesystem.

    Path where snapshots are stored on snapshotFilesystem. A relative path is relative to snapshotFilesystem's working directory.

    Definition Classes
    HBaseJournalProps → HadoopFilesystemSnapshottingProps

  25. val snapshotSaveTimeout: FiniteDuration

    Timeout for saving a snapshot.

    Timeout for saving a snapshot.

    Definition Classes
    HBaseJournalProps → HadoopFilesystemSnapshottingProps

  26. val snapshotSerializer: SnapshotSerializer

    Serializer for writing and reading snapshots.

    Serializer for writing and reading snapshots.

    Definition Classes
    HBaseJournalProps → HadoopFilesystemSnapshottingProps

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  28. val tableName: String

    Event message table name.

  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. def withDispatcherName(dispatcherName: String): HBaseJournalProps

    Java API.

  33. def withInitTimeout(initTimeout: FiniteDuration): HBaseJournalProps

    Java API.

  34. def withName(name: String): HBaseJournalProps

    Java API.

  35. def withReadOnly(ro: Boolean): HBaseJournalProps

    Java API.

  36. def withReplayChunkSize(replayChunkSize: Int): HBaseJournalProps

    Java API.

  37. def withSnapshotFilesystem(snapshotFilesystem: FileSystem): HBaseJournalProps

    Java API.

    Java API.

    Definition Classes
    HBaseJournalProps → HadoopFilesystemSnapshottingProps

  38. def withSnapshotLoadTimeout(snapshotLoadTimeout: FiniteDuration): HBaseJournalProps

    Java API.

    Java API.

    Definition Classes
    HBaseJournalProps → HadoopFilesystemSnapshottingProps

  39. def withSnapshotPath(snapshotPath: Path): HBaseJournalProps

    Java API.

  40. def withSnapshotSaveTimeout(snapshotSaveTimeout: FiniteDuration): HBaseJournalProps

    Java API.

    Java API.

    Definition Classes
    HBaseJournalProps → HadoopFilesystemSnapshottingProps

  41. def withSnapshotSerializer(snapshotSerializer: SnapshotSerializer): HBaseJournalProps

    Java API.

    Java API.

    Definition Classes
    HBaseJournalProps → HadoopFilesystemSnapshottingProps

  42. def withTableName(tableName: String): HBaseJournalProps

    Java API.

  43. val zookeeperQuorum: String

    Comma separated list of servers in the ZooKeeper quorum.

    Comma separated list of servers in the ZooKeeper quorum. See also the hbase.zookeeper.quorum configuration property.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HadoopFilesystemSnapshottingProps[HBaseJournalProps]

Inherited from JournalProps

Inherited from AnyRef

Inherited from Any

Ungrouped