lib/com.prettybyte.klerk

Package-level declarations

Types

data class ArgCommandContextReader<P, C : KlerkContext, V>(val command: Command<out Any, P>, val context: C, val reader: Reader<C, V>)

ArgContextReader

data class ArgContextReader<C : KlerkContext, V>(val context: C, val reader: Reader<C, V>)

ArgForInstanceEvent

data class ArgForInstanceEvent<T : Any, P, C : KlerkContext, V>(val model: Model<T>, val command: Command<T, P>, val context: C, val reader: Reader<C, V>)

ArgForInstanceNonEvent

data class ArgForInstanceNonEvent<T : Any, C : KlerkContext, V>(val model: Model<T>, val time: Instant, val reader: Reader<C, V>)

ArgForVoidEvent

data class ArgForVoidEvent<T : Any, P, C : KlerkContext, V>(val command: Command<T, P>, val context: C, val reader: Reader<C, V>)

ArgModelContextReader

data class ArgModelContextReader<C : KlerkContext, V>(val model: Model<out Any>, val context: C, val reader: Reader<C, V>)

ArgsForPropertyAuth

data class ArgsForPropertyAuth<C : KlerkContext, V>(val property: DataContainer<*>, val model: Model<out Any>, val context: C, val reader: Reader<C, V>)

AuthenticationIdentity

object AuthenticationIdentity : ActorIdentity

AuthorizationConfig

data class AuthorizationConfig<C : KlerkContext, V>(val readModelPositiveRules: Set<(ArgModelContextReader<C, V>) -> PositiveAuthorization>, val readModelNegativeRules: Set<(ArgModelContextReader<C, V>) -> NegativeAuthorization>, val readPropertyPositiveRules: Set<(ArgsForPropertyAuth<C, V>) -> PositiveAuthorization>, val readPropertyNegativeRules: Set<(ArgsForPropertyAuth<C, V>) -> NegativeAuthorization>, val eventPositiveRules: Set<(ArgCommandContextReader<*, C, V>) -> PositiveAuthorization>, val eventNegativeRules: Set<(ArgCommandContextReader<*, C, V>) -> NegativeAuthorization>, val eventLogPositiveRules: Set<(args: ArgContextReader<C, V>) -> PositiveAuthorization>, val eventLogNegativeRules: Set<(args: ArgContextReader<C, V>) -> NegativeAuthorization>)

AuthorizationException

class AuthorizationException(message: String? = null) : RuntimeException

AuthorizationProblem

class AuthorizationProblem(message: String? = null) : Problem

BadRequestProblem

class BadRequestProblem(message: String?) : Problem

BasicEmail

data class BasicEmail(val from: BasicEmail.EmailAndName, val to: List<BasicEmail.EmailAndName>, val cc: List<BasicEmail.EmailAndName> = emptyList(), val bcc: List<BasicEmail.EmailAndName> = emptyList(), val subject: String, val htmlBody: String?, val textBody: String?, val replyTo: BasicEmail.EmailAndName?)

CollectionId

data class CollectionId(val modelName: String, val shortId: String)

CommandResult

sealed class CommandResult<T : Any, C : KlerkContext, V>

Config

data class Config<C : KlerkContext, V>(collections: V, val authorization: AuthorizationConfig<C, V>, val meterRegistry: MeterRegistry, val managedModels: Set<ManagedModel<*, *, C, V>>, val persistence: Persistence, val migrationSteps: SortedSet<MigrationStep>, val plugins: List<KlerkPlugin<C, V>> = listOf(), val contextProvider: (ActorIdentity) -> C?)

ConfigBuilder

class ConfigBuilder<C : KlerkContext, D>(dataValue: D)

CustomIdentity

class CustomIdentity(val type: Int = ActorIdentity.customType, val id: ModelID<Any>?, val externalId: Long?) : ActorIdentity

DefaultTranslator

open class DefaultTranslator : Translator

The DefaultTranslator can be used

EmailSender

interface EmailSender<C : KlerkContext, V>

Event

sealed class Event<T : Any, P>

EventId

typealias EventId = String

EventReference

data class EventReference(val modelName: String, val eventName: String)

A reference to a specific event in a state machine

EventsManager

interface EventsManager<C : KlerkContext, V>

EventWithParameters

data class EventWithParameters<T : Any>(val eventReference: EventReference, val parameters: EventParameters<T>)

HumanReadable

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class HumanReadable(val name: String)

IdempotenceProblem

class IdempotenceProblem : Problem

IllegalConfigurationException

class IllegalConfigurationException(message: String) : RuntimeException

InstanceEvent

sealed class InstanceEvent<T : Any, P> : Event<T, P>

InstanceEventNoParameters

abstract class InstanceEventNoParameters<T : Any>(forModel: KClass<T>, isExternal: Boolean) : InstanceEvent<T, Nothing?>

InstanceEventWithParameters

open class InstanceEventWithParameters<T : Any, P : Any>(forModel: KClass<T>, isExternal: Boolean, val parametersClass: KClass<P>) : InstanceEvent<T, P>

InternalException

class InternalException(msg: String? = null) : RuntimeException

Indicates a bug in Klerk.

InternalProblem

class InternalProblem(message: String? = null) : Problem

InvalidParametersProblem

class InvalidParametersProblem(message: String? = null, val parameterName: String? = null, val fieldsMustBeNull: Set<KProperty0<DataContainer<*>?>>? = null, val fieldsMustNotBeNull: Set<KProperty0<DataContainer<*>?>>? = null, val violatedRule: RuleDescription? = null) : Problem

JobIdContainer

class JobIdContainer(value: Long) : LongContainer

JobManager

interface JobManager<C : KlerkContext, V>

Klerk

interface Klerk<C : KlerkContext, D>

KlerkContext

interface KlerkContext

The EventProducer is used to process events where the subsequent events are dependent on the results of the previous events. The processing happens in a transaction, i.e. if any of the events are rejected, all events will be rejected.

KlerkMeta

interface KlerkMeta

KlerkModels

interface KlerkModels<C : KlerkContext, V>

KlerkPlugin

interface KlerkPlugin<C : KlerkContext, V>

KlerkSettings

data class KlerkSettings(val requireEventParamsValidation: Boolean = true, val requireAnyValidation: Boolean = true, val eraseAuditLogAfterModelDeletion: Duration? = null, val allowUnsafeOperations: Boolean = false)

ManagedModel

data class ManagedModel<T : Any, ModelStates : Enum<*>, C : KlerkContext, V>(val kClass: KClass<T>, val stateMachine: StateMachine<T, ModelStates, C, V>, val collections: ModelCollections<T, C>)

Model

data class Model<T : Any>(val id: ModelID<T>, val createdAt: Instant, val lastPropsUpdateAt: Instant, val lastStateTransitionAt: Instant, val state: String, val timeTrigger: Instant?, val props: T)

ModelID

@JvmInline

value class ModelID<T : Any>(value: Int)

Model IDs are represented internally using Int but only the positive part, so the maximum amount of simultaneous models is about 2 billion (we should find a way to use UInt). It is recommended to use a String (base36) externally.

ModelIdentity

class ModelIdentity<T : Any>(val model: Model<T>) : ActorIdentity

ModelReferenceIdentity

class ModelReferenceIdentity<T : Any>(modelId: ModelID<T>) : ActorIdentity

NegativeAuthorization

enum NegativeAuthorization : Enum<NegativeAuthorization>

NotFoundProblem

class NotFoundProblem(message: String? = null) : Problem

PluginIdentity

class PluginIdentity(val plugin: KlerkPlugin<*, *>) : ActorIdentity

PositiveAuthorization

enum PositiveAuthorization : Enum<PositiveAuthorization>

Problem

abstract class Problem

ProcessingData

data class ProcessingData<Primary : Any, C : KlerkContext, V>(val primaryModel: ModelID<Primary>? = null, val currentModel: ModelID<out Any>? = null, val actions: List<GeneralAction> = emptyList(), val createdModels: List<ModelID<out Any>> = emptyList(), val updatedModels: List<ModelID<out Any>> = emptyList(), val transitions: List<ModelID<out Any>> = emptyList(), val deletedModels: List<ModelID<out Any>> = emptyList(), val unFinalizedTransition: Triple<String, Instant, Model<out Any>>? = null, val aggregatedModelState: Map<ModelID<out Any>, Model<out Any>> = emptyMap(), val newJobs: List<Job<C, V>> = emptyList(), val remainingBlocks: List<Block<*, *, C, V>> = emptyList(), val currentBlock: Block<*, *, C, V>? = null, val processedBlocks: List<Block<*, *, C, V>> = emptyList(), val remainingCommands: List<Command<out Any, out Any?>> = emptyList(), val currentCommand: Command<out Any, out Any?>? = null, val processedCommands: List<Command<out Any, out Any?>> = emptyList(), val log: List<String> = emptyList(), val functionsToUpdateViews: List<() -> Unit> = emptyList(), val problems: List<Problem> = emptyList(), val timeTriggers: Map<ModelID<out Any>, Instant?> = emptyMap(), val remainingTimeTrigger: Model<out Any>? = null)

TODO: make sure this documentation is correct

RuleDescription