Package ch.tocco.nice2.persist.history.impl.store

Class HistoryDataStoreImpl

java.lang.Object

ch.tocco.nice2.persist.history.impl.store.HistoryDataStoreImpl

All Implemented Interfaces:

HistoryDataStore

@Component
public class HistoryDataStoreImpl
extends Object
implements HistoryDataStore

Initializes a separate SessionFactory for the history database using the properties of the 'hikaricp.history.properties'. Provides functionality to write to and read from the history data store.

Constructor Summary

Constructors

Constructor	Description
HistoryDataStoreImpl(org.slf4j.Logger log, BinaryHashingService hashingService, Context context, BusinessUnitManager businessUnitManager, SecurityManager securityManager, RunEnvironmentService runEnvironmentService, HistoryHibernateConfiguration hibernateConfiguration)

Method Summary

Modifier and Type	Method	Description
protected void	checkHistoryEntryVersionReadPermission()
protected void	checkPermissionForModel(String entityModel)
void	close()	Closes the underlying session factory.
void	deleteOldHistoryEntries(long maximumAge)	Deletes all HistoryEntries that are older then maximumAge
@Nullable HistorySnapshot	fetch(long pk)	Fetch a specific HistorySnapshot by primary key.
Long	getCount(HistorySearchParams searchParams)	Returns the number of history entries which apply to the given HistorySearchParams.
DataSource	getDataSource()
List<HistoryEntry>	getHistoryEntries(HistorySearchParams searchParams)	Returns a list of HistoryEntry instances that are ordered by timestamp (descending).
protected HibernatePropertiesBuilder	getSettings()
boolean	hasPermissionForModel(String entityModel)	Returns true if the current user has access to the history of the given entity model
List<Long>	saveOrUpdateHistoryEntries(List<HistorySnapshot> historyEntries)	Saves the given HistorySnapshot instances into the store.
void	setHistoryEnabled(HistoryDataStoreState state)

Methods inherited from class java.lang.Object

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

Constructor Details

HistoryDataStoreImpl

public HistoryDataStoreImpl(org.slf4j.Logger log,
 BinaryHashingService hashingService,
 Context context,
 BusinessUnitManager businessUnitManager,
 SecurityManager securityManager,
 RunEnvironmentService runEnvironmentService,
 HistoryHibernateConfiguration hibernateConfiguration)

Method Details

setHistoryEnabled

@Value("${nice2.persist.history.persistence.state}")
public void setHistoryEnabled(HistoryDataStoreState state)

getSettings

protected HibernatePropertiesBuilder getSettings()

getDataSource

public DataSource getDataSource()

Specified by:

getDataSource in interface HistoryDataStore

Returns:

the DataSource of the history database

saveOrUpdateHistoryEntries

public List<Long> saveOrUpdateHistoryEntries(List<HistorySnapshot> historyEntries)

Description copied from interface: HistoryDataStore

Saves the given HistorySnapshot instances into the store. If the HistorySnapshot contains an existing primary key, the existing entry is updated.

Specified by:

saveOrUpdateHistoryEntries in interface HistoryDataStore

getCount

public Long getCount(HistorySearchParams searchParams)

Description copied from interface: HistoryDataStore

Returns the number of history entries which apply to the given HistorySearchParams.

Specified by:

getCount in interface HistoryDataStore

getHistoryEntries

public List<HistoryEntry> getHistoryEntries(HistorySearchParams searchParams)

Description copied from interface: HistoryDataStore

Returns a list of HistoryEntry instances that are ordered by timestamp (descending).

Specified by:

getHistoryEntries in interface HistoryDataStore

Parameters:

searchParams - bean that defines the pagination and filtering of the results

deleteOldHistoryEntries

public void deleteOldHistoryEntries(long maximumAge)

Description copied from interface: HistoryDataStore

Deletes all HistoryEntries that are older then maximumAge

Specified by:

deleteOldHistoryEntries in interface HistoryDataStore

Parameters:

maximumAge - the maximum age of history entries in months

fetch

@Nullable
public @Nullable HistorySnapshot fetch(long pk)

Description copied from interface: HistoryDataStore

Fetch a specific HistorySnapshot by primary key. The primary key can be obtained from the Version object returned by HistoryDataStore.getHistoryEntries(HistorySearchParams).

Specified by:

fetch in interface HistoryDataStore

hasPermissionForModel

public boolean hasPermissionForModel(String entityModel)

Description copied from interface: HistoryDataStore

Returns true if the current user has access to the history of the given entity model

Specified by:

hasPermissionForModel in interface HistoryDataStore

checkPermissionForModel

protected void checkPermissionForModel(String entityModel)

checkHistoryEntryVersionReadPermission

protected void checkHistoryEntryVersionReadPermission()

close

public void close()

Description copied from interface: HistoryDataStore

Closes the underlying session factory.

Specified by:

close in interface HistoryDataStore