Package io.camunda.zeebe.engine.state.deployment

Class DbFormState

java.lang.Object

io.camunda.zeebe.engine.state.deployment.DbFormState

All Implemented Interfaces:

FormState, MutableFormState

public class DbFormState
extends Object
implements MutableFormState

Constructor Summary

Constructors

Constructor	Description
DbFormState(ZeebeDb<ZbColumnFamilies> zeebeDb, TransactionContext transactionContext, EngineConfiguration config)

Method Summary

Modifier and Type	Method	Description
void	clearCache()
void	deleteFormInFormByIdAndVersionColumnFamily(FormRecord record)	Deletes a form from FORM_BY_ID_AND_VERSION column family
void	deleteFormInFormKeyByFormIdAndDeploymentKeyColumnFamily(FormRecord record)	Deletes a form from FORM_KEY_BY_FORM_ID_AND_DEPLOYMENT_KEY column family
void	deleteFormInFormKeyByFormIdAndVersionTagColumnFamily(FormRecord record)	Deletes a form from FORM_KEY_BY_FORM_ID_AND_VERSION_TAG column family
void	deleteFormInFormsColumnFamily(FormRecord record)	Deletes a form from FORMS column family
void	deleteFormInFormVersionColumnFamily(FormRecord record)	Deletes a form from FORM_VERSION column family
Optional<PersistedForm>	findFormByIdAndDeploymentKey(org.agrona.DirectBuffer formId, long deploymentKey, String tenantId)	Query forms by the given form id and deployment key and return the form.
Optional<PersistedForm>	findFormByIdAndVersionTag(org.agrona.DirectBuffer formId, String versionTag, String tenantId)	Query forms by the given form id and version tag and return the form.
Optional<PersistedForm>	findFormByKey(long formKey, String tenantId)	Query forms by the given form key and return the form.
Optional<PersistedForm>	findLatestFormById(org.agrona.DirectBuffer formId, String tenantId)	Query forms by the given form id and return the latest version of the form.
int	getNextFormVersion(String formId, String tenantId)	Gets the next version a form of a given id will receive.
void	storeFormInFormByIdAndVersionColumnFamily(FormRecord record)	Put the given form in FORM_BY_ID_AND_VERSION column family
void	storeFormInFormColumnFamily(FormRecord record)	Put the given form in FORMS column family
void	storeFormInFormKeyByFormIdAndDeploymentKeyColumnFamily(FormRecord record)	Put the given form in FORM_KEY_BY_FORM_ID_AND_DEPLOYMENT_KEY column family
void	storeFormInFormKeyByFormIdAndVersionTagColumnFamily(FormRecord record)	Put the given form in FORM_KEY_BY_FORM_ID_AND_VERSION_TAG column family
void	updateLatestVersion(FormRecord record)	Update the latest version of the form if it is newer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DbFormState

public DbFormState(ZeebeDb<ZbColumnFamilies> zeebeDb,
 TransactionContext transactionContext,
 EngineConfiguration config)

Method Details

storeFormInFormColumnFamily

public void storeFormInFormColumnFamily(FormRecord record)

Description copied from interface: MutableFormState

Put the given form in FORMS column family

Specified by:

storeFormInFormColumnFamily in interface MutableFormState

Parameters:

record - the record of the form

storeFormInFormByIdAndVersionColumnFamily

public void storeFormInFormByIdAndVersionColumnFamily(FormRecord record)

Description copied from interface: MutableFormState

Put the given form in FORM_BY_ID_AND_VERSION column family

Specified by:

storeFormInFormByIdAndVersionColumnFamily in interface MutableFormState

Parameters:

record - the record of the form

storeFormInFormKeyByFormIdAndDeploymentKeyColumnFamily

public void storeFormInFormKeyByFormIdAndDeploymentKeyColumnFamily(FormRecord record)

Description copied from interface: MutableFormState

Put the given form in FORM_KEY_BY_FORM_ID_AND_DEPLOYMENT_KEY column family

Specified by:

storeFormInFormKeyByFormIdAndDeploymentKeyColumnFamily in interface MutableFormState

Parameters:

record - the record of the form

storeFormInFormKeyByFormIdAndVersionTagColumnFamily

public void storeFormInFormKeyByFormIdAndVersionTagColumnFamily(FormRecord record)

Description copied from interface: MutableFormState

Put the given form in FORM_KEY_BY_FORM_ID_AND_VERSION_TAG column family

Specified by:

storeFormInFormKeyByFormIdAndVersionTagColumnFamily in interface MutableFormState

Parameters:

record - the record of the form

updateLatestVersion

public void updateLatestVersion(FormRecord record)

Description copied from interface: MutableFormState

Update the latest version of the form if it is newer.

Specified by:

updateLatestVersion in interface MutableFormState

Parameters:

record - the record of the form

deleteFormInFormsColumnFamily

public void deleteFormInFormsColumnFamily(FormRecord record)

Description copied from interface: MutableFormState

Deletes a form from FORMS column family

Specified by:

deleteFormInFormsColumnFamily in interface MutableFormState

Parameters:

record - the record of the form that is deleted

deleteFormInFormByIdAndVersionColumnFamily

public void deleteFormInFormByIdAndVersionColumnFamily(FormRecord record)

Description copied from interface: MutableFormState

Deletes a form from FORM_BY_ID_AND_VERSION column family

Specified by:

deleteFormInFormByIdAndVersionColumnFamily in interface MutableFormState

Parameters:

record - the record of the form that is deleted

deleteFormInFormVersionColumnFamily

public void deleteFormInFormVersionColumnFamily(FormRecord record)

Description copied from interface: MutableFormState

Deletes a form from FORM_VERSION column family

Specified by:

deleteFormInFormVersionColumnFamily in interface MutableFormState

Parameters:

record - the record of the form that is deleted

deleteFormInFormKeyByFormIdAndDeploymentKeyColumnFamily

public void deleteFormInFormKeyByFormIdAndDeploymentKeyColumnFamily(FormRecord record)

Description copied from interface: MutableFormState

Deletes a form from FORM_KEY_BY_FORM_ID_AND_DEPLOYMENT_KEY column family

Specified by:

deleteFormInFormKeyByFormIdAndDeploymentKeyColumnFamily in interface MutableFormState

Parameters:

record - the record of the form that is deleted

deleteFormInFormKeyByFormIdAndVersionTagColumnFamily

public void deleteFormInFormKeyByFormIdAndVersionTagColumnFamily(FormRecord record)

Description copied from interface: MutableFormState

Deletes a form from FORM_KEY_BY_FORM_ID_AND_VERSION_TAG column family

Specified by:

deleteFormInFormKeyByFormIdAndVersionTagColumnFamily in interface MutableFormState

Parameters:

record - the record of the form that is deleted

findLatestFormById

public Optional<PersistedForm> findLatestFormById(org.agrona.DirectBuffer formId,
 String tenantId)

Description copied from interface: FormState

Query forms by the given form id and return the latest version of the form.

Specified by:

findLatestFormById in interface FormState

Parameters:

formId - the id of the form

tenantId - the id of the tenant

Returns:

the latest version of the form, or Optional.empty() if no form is deployed with the given id

findFormByKey

public Optional<PersistedForm> findFormByKey(long formKey,
 String tenantId)

Description copied from interface: FormState

Query forms by the given form key and return the form.

Specified by:

findFormByKey in interface FormState

Parameters:

formKey - the key of the form

tenantId - the id of the tenant

Returns:

the form, or Optional.empty() if no form is deployed with the given key

findFormByIdAndDeploymentKey

public Optional<PersistedForm> findFormByIdAndDeploymentKey(org.agrona.DirectBuffer formId,
 long deploymentKey,
 String tenantId)

Description copied from interface: FormState

Query forms by the given form id and deployment key and return the form.

Specified by:

findFormByIdAndDeploymentKey in interface FormState

Parameters:

formId - the id of the form

deploymentKey - the key of the deployment the form was deployed with

tenantId - the id of the tenant

Returns:

the form, or Optional.empty() if no form with the given id was deployed with the given deployment

findFormByIdAndVersionTag

public Optional<PersistedForm> findFormByIdAndVersionTag(org.agrona.DirectBuffer formId,
 String versionTag,
 String tenantId)

Description copied from interface: FormState

Query forms by the given form id and version tag and return the form.

Specified by:

findFormByIdAndVersionTag in interface FormState

Parameters:

formId - the id of the form

versionTag - the version tag of the form

tenantId - the id of the tenant

Returns:

the form, or Optional.empty() if no form with the given id and version tag is deployed

getNextFormVersion

public int getNextFormVersion(String formId,
 String tenantId)

Description copied from interface: FormState

Gets the next version a form of a given id will receive. This is used, for example, when a new deployment is done. Using this method we decide the version the newly deployed form receives.

Specified by:

getNextFormVersion in interface FormState

Parameters:

formId - the id of the form

clearCache

public void clearCache()

Specified by:

clearCache in interface FormState