org.ff4j.store.kv

Class KeyValueEventRepository<VALUE>

java.lang.Object

org.ff4j.audit.repository.AbstractEventRepository

org.ff4j.store.kv.KeyValueEventRepository<VALUE>

Type Parameters:

D - target driver

All Implemented Interfaces:

EventRepository

public class KeyValueEventRepository<VALUE>
extends AbstractEventRepository

Common implementation of time-series and audit using J/V stores.

Author:

Cedrick LUNVEN (@clunven)

Field Summary

Fields

Modifier and Type	Field and Description
protected KeyValueDriver<String,VALUE>	driver Driver to access a K/V Store.
protected EventMapper<VALUE>	eventMapper Work with Mapping.

Fields inherited from class org.ff4j.audit.repository.AbstractEventRepository

KDF

Constructor Summary

Constructors

Constructor and Description
KeyValueEventRepository() Default constructor
KeyValueEventRepository(KeyValueDriver<String,VALUE> driver) Work with Key-Value.

Method Summary

Modifier and Type	Method and Description
void	createSchema() Initialize target database with expected schema if needed.
EventSeries	getAuditTrail(EventQueryDefinition query) Display audit trail as list of Event.
KeyValueDriver<String,VALUE>	getDriver() Getter accessor for attribute 'driver'.
Event	getEventByUUID(String uuid, Long timestamp) Retrieve an event by its unique identifer.
TimeSeriesChart	getFeatureUsageHistory(EventQueryDefinition query, TimeUnit tu) Create measure over time.
Map<String,MutableHitCount>	getFeatureUsageHitCount(EventQueryDefinition query) Count hit ratio of features between 2 dates.
Map<String,MutableHitCount>	getHostHitCount(EventQueryDefinition query) Count hit for each host.
Map<String,MutableHitCount>	getSourceHitCount(EventQueryDefinition query) Count hit for each source (api...).
Map<String,MutableHitCount>	getUserHitCount(EventQueryDefinition query) Count hit for each host.
void	purgeAuditTrail(EventQueryDefinition query) Purge audit trail.
void	purgeFeatureUsage(EventQueryDefinition query) Purge feature usage.
boolean	saveEvent(Event e) Save event into store synchronously.
EventSeries	searchFeatureUsageEvents(EventQueryDefinition query) Search over events.
void	setDriver(KeyValueDriver<String,VALUE> driver) Setter accessor for attribute 'driver'.

Methods inherited from class org.ff4j.audit.repository.AbstractEventRepository

getCandidateDays, getFeatureUsageBarChart, getFeatureUsagePieChart, getFeatureUsageTotalHitCount, getHostBarChart, getHostPieChart, getKeyDate, getSourceBarChart, getSourcePieChart, getTitle, getUserBarChart, getUserPieChart, isEventInInterval, orderBarDecrecent, renderBarChartGradient, renderBarChartRainbow, renderPieChartGradient, renderPieChartRainBow, toString

Methods inherited from class java.lang.Object

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

Field Detail

driver

protected KeyValueDriver<String,VALUE> driver

Driver to access a K/V Store.

eventMapper

protected EventMapper<VALUE> eventMapper

Work with Mapping.

Constructor Detail

KeyValueEventRepository

public KeyValueEventRepository()

Default constructor

KeyValueEventRepository

public KeyValueEventRepository(KeyValueDriver<String,VALUE> driver)

Work with Key-Value.

Parameters:

driver - target driver

Method Detail

createSchema

public void createSchema()

Initialize target database with expected schema if needed.

saveEvent

public boolean saveEvent(Event e)

Save event into store synchronously.

Parameters:

e - target event to store

Returns:

if saving is OK

getEventByUUID

public Event getEventByUUID(String uuid,
                            Long timestamp)

Retrieve an event by its unique identifer.

Parameters:

uuid - get detail from a single event by its ID

timestamp - help to find the UUID (optional).

Returns:

target event detail

getFeatureUsageHitCount

public Map<String,MutableHitCount> getFeatureUsageHitCount(EventQueryDefinition query)

Count hit ratio of features between 2 dates. This will be used for different charts.

Returns:

getFeatureUsageHistory

public TimeSeriesChart getFeatureUsageHistory(EventQueryDefinition query,
                                              TimeUnit tu)

Create measure over time.

Returns:

searchFeatureUsageEvents

public EventSeries searchFeatureUsageEvents(EventQueryDefinition query)

Search over events.

Returns:

a list of events

purgeFeatureUsage

public void purgeFeatureUsage(EventQueryDefinition query)

Purge feature usage.

getHostHitCount

public Map<String,MutableHitCount> getHostHitCount(EventQueryDefinition query)

Count hit for each host.

getUserHitCount

public Map<String,MutableHitCount> getUserHitCount(EventQueryDefinition query)

Count hit for each host.

getSourceHitCount

public Map<String,MutableHitCount> getSourceHitCount(EventQueryDefinition query)

Count hit for each source (api...).

getAuditTrail

public EventSeries getAuditTrail(EventQueryDefinition query)

Display audit trail as list of Event.

Returns:

target list of event

purgeAuditTrail

public void purgeAuditTrail(EventQueryDefinition query)

Purge audit trail.

getDriver

public KeyValueDriver<String,VALUE> getDriver()

Getter accessor for attribute 'driver'.

Returns:

current value of 'driver'

setDriver

public void setDriver(KeyValueDriver<String,VALUE> driver)

Setter accessor for attribute 'driver'.

Parameters:

driver - new value for 'driver '