Class/Object

com.ing.baker.runtime.core

Baker

Related Docs: object Baker | package core

Permalink

class Baker extends AnyRef

The Baker is the component of the Baker library that runs one or multiples recipes. For each recipe a new instance can be baked, sensory events can be send and state can be inquired upon

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

Instance Constructors

  1. new Baker()(implicit actorSystem: ActorSystem)

    Permalink

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. implicit val actorSystem: ActorSystem

    Permalink
  5. def addInteractionImplementation(interactionImplementation: InteractionImplementation): Unit

    Permalink
  6. def addInteractionImplementation(implementation: AnyRef): Unit

    Permalink
  7. def addInteractionImplementations(implementations: Seq[AnyRef]): Unit

    Permalink
  8. def addRecipe(compiledRecipe: CompiledRecipe, timeout: FiniteDuration = defaultBakeTimeout): String

    Permalink

    Adds a recipe to baker and returns a recipeId for the recipe.

    Adds a recipe to baker and returns a recipeId for the recipe.

    This function is idempotent, if the same (equal) recipe was added earlier this will return the same recipeId

    compiledRecipe

    The compiled recipe.

    returns

    A recipeId

  9. def allProcessMetadata: Set[ProcessMetadata]

    Permalink
  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. def bake(recipeId: String, processId: String, timeout: FiniteDuration = defaultBakeTimeout): ProcessState

    Permalink

    Creates a process instance for the given recipeId with the given processId as identifier

    Creates a process instance for the given recipeId with the given processId as identifier

    recipeId

    The recipeId for the recipe to bake

    processId

    The identifier for the newly baked process

  12. def bakeAsync(recipeId: String, processId: String, timeout: FiniteDuration = defaultBakeTimeout): Future[ProcessState]

    Permalink

    Asynchronously creates a process instance for the given recipeId with the given processId as identifier

    Asynchronously creates a process instance for the given recipeId with the given processId as identifier

    recipeId

    The recipeId for the recipe to bake

    processId

    The identifier for the newly baked process

  13. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def events(processId: String, timeout: FiniteDuration = defaultInquireTimeout): Seq[RuntimeEvent]

    Permalink

    Synchronously returns all events that occurred for a process.

  17. def eventsAsync(processId: String): Source[RuntimeEvent, NotUsed]

    Permalink

    Returns a Source of baker events for a process.

    Returns a Source of baker events for a process.

    processId

    The process identifier.

    returns

    The source of events.

  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def getAllRecipes(timeout: FiniteDuration = defaultInquireTimeout): Map[String, CompiledRecipe]

    Permalink

    Returns all recipes added to this baker instance.

    Returns all recipes added to this baker instance.

    returns

    All recipes in the form of map of recipeId -> CompiledRecipe

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

    Permalink
    Definition Classes
    AnyRef → Any
  21. def getIngredients(processId: String, timeout: FiniteDuration = defaultInquireTimeout): Map[String, Value]

    Permalink

    Returns all provided ingredients for a given process id.

    Returns all provided ingredients for a given process id.

    processId

    The process id.

    returns

    The provided ingredients.

    Annotations
    @throws( ... ) @throws( ... )
  22. def getIngredientsAsync(processId: String, timeout: FiniteDuration = defaultInquireTimeout): Future[Map[String, Value]]

    Permalink

    Returns a future of all the provided ingredients for a given process id.

    Returns a future of all the provided ingredients for a given process id.

    processId

    The process id.

    returns

    A future of the provided ingredients.

  23. def getProcessStateAsync(processId: String, timeout: FiniteDuration = defaultInquireTimeout): Future[ProcessState]

    Permalink

    returns a future with the process state.

    returns a future with the process state.

    processId

    The process identifier

    returns

    The process state.

  24. def getRecipe(recipeId: String, timeout: FiniteDuration = defaultInquireTimeout): CompiledRecipe

    Permalink

    Returns the recipe for the given RecipeId

  25. def getVisualState(processId: String, timeout: FiniteDuration = defaultInquireTimeout): String

    Permalink

    Returns the visual state (.dot) for a given process.

    Returns the visual state (.dot) for a given process.

    processId

    The process identifier.

    timeout

    How long to wait to retreive the process state.

    returns

    A visual (.dot) representation of the process state.

  26. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  28. implicit val materializer: ActorMaterializer

    Permalink
  29. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  32. def processEvent(processId: String, event: Any, timeout: FiniteDuration = defaultProcessEventTimeout): SensoryEventStatus

    Permalink

    Notifies Baker that an event has happened and waits until all the actions which depend on this event are executed.

    Notifies Baker that an event has happened and waits until all the actions which depend on this event are executed.

    processId

    The process identifier

    event

    The event object

  33. def processEventAsync(processId: String, event: Any, timeout: FiniteDuration = defaultProcessEventTimeout): BakerResponse

    Permalink

    Notifies Baker that an event has happened and waits until all the actions which depend on this event are executed.

    Notifies Baker that an event has happened and waits until all the actions which depend on this event are executed.

    This call is fire and forget: If nothing is done with the response object there is NO guarantee that the event is received by the process instance.

  34. val processIndexActor: ActorRef

    Permalink
  35. val processInstanceStore: ProcessInstanceStore

    Permalink
  36. val recipeManager: ActorRef

    Permalink
  37. def registerEventListener(listener: EventListener): Boolean

    Permalink

    Registers a listener to all runtime events for all recipes that run in this Baker instance.

    Registers a listener to all runtime events for all recipes that run in this Baker instance.

    Note that the delivery guarantee is *AT MOST ONCE*. Do not use it for critical functionality

  38. def registerEventListener(recipeName: String, listener: EventListener): Boolean

    Permalink

    Registers a listener to all runtime events for recipes with the given name run in this baker instance.

    Registers a listener to all runtime events for recipes with the given name run in this baker instance.

    Note that the delivery guarantee is *AT MOST ONCE*. Do not use it for critical functionality

  39. def shutdown(timeout: FiniteDuration = defaultShutdownTimeout): Unit

    Permalink

    Attempts to gracefully shutdown the baker system.

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped