Object/Class

core3.database.dals.memory.utils

CacheStore

Related Docs: class CacheStore | package utils

Permalink

object CacheStore

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CacheStore
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Clear(objectType: ContainerType) extends Product with Serializable

    Permalink

    Message instructing the Store to clear the cache for the specified containers type.

    Message instructing the Store to clear the cache for the specified containers type.

    Responds with: Future[Unit]

    objectType

    the type of objects to clear

  2. case class Create(container: Container) extends Product with Serializable

    Permalink

    Message instructing the Store to create the supplied container.

    Message instructing the Store to create the supplied container.

    Responds with: Future[Boolean]

    container

    the container to be created

  3. case class CustomQuery(objectsType: ContainerType, customQueryName: String, queryParams: Map[String, String]) extends Product with Serializable

    Permalink

    Message instructing the Store to run a custom query with the specified parameters.

    Message instructing the Store to run a custom query with the specified parameters.

    Responds with: Future[ContainerSet]

    objectsType

    the container type to query

    customQueryName

    the name of the custom query

    queryParams

    the parameters to use for the query

  4. case class Delete(objectType: ContainerType, objectID: ObjectID, sourceUpdated: Boolean = false) extends Product with Serializable

    Permalink

    Message instructing the Store to delete a container.

    Message instructing the Store to delete a container.

    Responds with: Future[Boolean]

    objectType

    the type of container to be deleted

    objectID

    the ID of the container to be deleted

    sourceUpdated

    set to true, if the source DAL has already been updated and another deletion request should not be sent (default is false)

  5. case class GenericQuery(objectsType: ContainerType) extends Product with Serializable

    Permalink

    Message instructing the Store to run a generic query.

    Message instructing the Store to run a generic query.

    Responds with: Future[ContainerSet]

    objectsType

    the container type to query

  6. case class Get(objectType: ContainerType, objectID: ObjectID) extends Product with Serializable

    Permalink

    Message instructing the Store to get a container.

    Message instructing the Store to get a container.

    Responds with: Future[Container]

    objectType

    the requested container type

    objectID

    the requested object ID

  7. case class Load(objectsTypeOpt: Option[ContainerType] = None) extends Product with Serializable

    Permalink

    Message instructing the Store to load objects from the database.

    Message instructing the Store to load objects from the database.

    Responds with: Future[Unit]

    objectsTypeOpt

    the type of objects to load; set to None to load all supported (default is None)

  8. case class LoadObject(objectType: ContainerType, objectID: ObjectID, revisionID: Option[RevisionID], revisionSequenceNumber: Option[RevisionSequenceNumber], attemptNumber: Int = 0) extends Product with Serializable

    Permalink

    Message instructing the Store to load a specific object from the database.

    Message instructing the Store to load a specific object from the database.

    Responds with: Nothing

    Notes:

    • Used for loading containers when database updates are performed outside the local system.
    objectType

    the type of object to load

    objectID

    the ID of the object to load

    revisionID

    the revision ID of the object to load

    revisionSequenceNumber

    the revision sequence number to load

    attemptNumber

    the current attempt number; by default starts from 0

  9. case class Update(container: MutableContainer) extends Product with Serializable

    Permalink

    Message instructing the Store to do an update for the supplied container.

    Message instructing the Store to do an update for the supplied container.

    Responds with: Future[Boolean]

    container

    the container to be updated

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. def props(source: DatabaseAbstractionLayer, companions: Map[ContainerType, BasicContainerCompanion], containerTypeMaxCacheSize: Int, actionTimeout: Int, maxLoadAttempts: Int, preload: Boolean)(implicit ec: ExecutionContext): Props

    Permalink

    Creates a new config object for the core3.database.dals.memory.utils.CacheStore actor.

    Creates a new config object for the core3.database.dals.memory.utils.CacheStore actor.

    source

    the source DAL to use for data retrieval and updates

    companions

    map with all registered container companion objects

    containerTypeMaxCacheSize

    maximum cache size per container type

    actionTimeout

    the amount of time (in seconds) before an operation is considered as timed out

    maxLoadAttempts

    maximum number of times to attempt loading an object from the source

    preload

    if set to true, the cache will attempt to load all data during initialization

    returns

    the config object

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

    Permalink
    Definition Classes
    AnyRef
  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped