org.eligosource.eventsourced.journal.mongodb.casbah

MongodbCasbahJournalProps

case class MongodbCasbahJournalProps(mongoClient: com.mongodb.casbah.Imports.MongoClient, dbName: String, collName: String, snapshotPath: Path = ..., snapshotSerializer: SnapshotSerializer = ..., snapshotLoadTimeout: FiniteDuration = ..., snapshotSaveTimeout: FiniteDuration = ..., snapshotFilesystem: FileSystem = ..., name: Option[String] = scala.None, dispatcherName: Option[String] = scala.None, readOnly: Boolean = false) extends JournalProps with HadoopFilesystemSnapshottingProps[MongodbCasbahJournalProps] with Product with Serializable

Configuration object for an Mongodb/Casbah based 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.mongodb.casbah.MongodbCasbahJournalProps

implicit val system: ActorSystem = ...

val journal: ActorRef = Journal(MongodbCasbahJournalProps(journalConn))
mongoClient

Required mongoDB/Casbah client.

dbName

Required mongoDB database name.

collName

Required mongoDB collection name.

name

Optional journal actor name.

dispatcherName

Optional journal actor dispatcher name.

Linear Supertypes
Serializable, Serializable, Product, Equals, HadoopFilesystemSnapshottingProps[MongodbCasbahJournalProps], JournalProps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MongodbCasbahJournalProps
  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 MongodbCasbahJournalProps(mongoClient: com.mongodb.casbah.Imports.MongoClient, dbName: String, collName: String, snapshotPath: Path = ..., snapshotSerializer: SnapshotSerializer = ..., snapshotLoadTimeout: FiniteDuration = ..., snapshotSaveTimeout: FiniteDuration = ..., snapshotFilesystem: FileSystem = ..., name: Option[String] = scala.None, dispatcherName: Option[String] = scala.None, readOnly: Boolean = false)

    mongoClient

    Required mongoDB/Casbah client.

    dbName

    Required mongoDB database name.

    collName

    Required mongoDB collection name.

    name

    Optional journal actor name.

    dispatcherName

    Optional journal actor dispatcher name.

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. val collName: String

    Required mongoDB collection name.

  9. 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

  10. def createJournalActor: Actor

    Creates a journal actor instance.

    Creates a journal actor instance.

    Definition Classes
    MongodbCasbahJournalProps → JournalProps

  11. val dbName: String

    Required mongoDB database name.

  12. val dispatcherName: Option[String]

    Optional journal actor dispatcher name.

    Optional journal actor dispatcher name.

    Definition Classes
    MongodbCasbahJournalProps → JournalProps

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

    Definition Classes
    AnyRef

  14. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  17. val mongoClient: com.mongodb.casbah.Imports.MongoClient

    Required mongoDB/Casbah client.

  18. val name: Option[String]

    Optional journal actor name.

    Optional journal actor name.

    Definition Classes
    MongodbCasbahJournalProps → JournalProps

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

    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  22. val readOnly: Boolean

    Make journal read only (e.

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

    Definition Classes
    MongodbCasbahJournalProps → JournalProps

  23. val snapshotFilesystem: FileSystem

    Hadoop filesystem for storing snapshots.

    Hadoop filesystem for storing snapshots.

    Definition Classes
    MongodbCasbahJournalProps → HadoopFilesystemSnapshottingProps

  24. val snapshotLoadTimeout: FiniteDuration

    Timeout for loading a snapshot.

    Timeout for loading a snapshot.

    Definition Classes
    MongodbCasbahJournalProps → HadoopFilesystemSnapshottingProps

  25. 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
    MongodbCasbahJournalProps → HadoopFilesystemSnapshottingProps

  26. val snapshotSaveTimeout: FiniteDuration

    Timeout for saving a snapshot.

    Timeout for saving a snapshot.

    Definition Classes
    MongodbCasbahJournalProps → HadoopFilesystemSnapshottingProps

  27. val snapshotSerializer: SnapshotSerializer

    Serializer for writing and reading snapshots.

    Serializer for writing and reading snapshots.

    Definition Classes
    MongodbCasbahJournalProps → HadoopFilesystemSnapshottingProps

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

    Definition Classes
    AnyRef

  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): MongodbCasbahJournalProps

    Java API.

    Java API.

    Returns a new MongodbCasbahJournalProps with specified journal actor dispatcher name.

  33. def withName(name: String): MongodbCasbahJournalProps

    Java API.

    Java API.

    Returns a new MongodbCasbahJournalProps with specified journal actor name.

  34. def withReadOnly(ro: Boolean): MongodbCasbahJournalProps

    Java API.

  35. def withSnapshotFilesystem(snapshotFilesystem: FileSystem): MongodbCasbahJournalProps

    Java API.

    Java API.

    Definition Classes
    MongodbCasbahJournalProps → HadoopFilesystemSnapshottingProps

  36. def withSnapshotLoadTimeout(snapshotLoadTimeout: FiniteDuration): MongodbCasbahJournalProps

    Java API.

    Java API.

    Definition Classes
    MongodbCasbahJournalProps → HadoopFilesystemSnapshottingProps

  37. def withSnapshotPath(snapshotPath: Path): MongodbCasbahJournalProps

    Java API.

  38. def withSnapshotSaveTimeout(snapshotSaveTimeout: FiniteDuration): MongodbCasbahJournalProps

    Java API.

    Java API.

    Definition Classes
    MongodbCasbahJournalProps → HadoopFilesystemSnapshottingProps

  39. def withSnapshotSerializer(snapshotSerializer: SnapshotSerializer): MongodbCasbahJournalProps

    Java API.

    Java API.

    Definition Classes
    MongodbCasbahJournalProps → HadoopFilesystemSnapshottingProps

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HadoopFilesystemSnapshottingProps[MongodbCasbahJournalProps]

Inherited from JournalProps

Inherited from AnyRef

Inherited from Any

Ungrouped