org.ff4j.audit.repository

Class InMemoryEventRepository

java.lang.Object

org.ff4j.audit.repository.AbstractEventRepository

org.ff4j.audit.repository.InMemoryEventRepository

All Implemented Interfaces:

EventRepository

public class InMemoryEventRepository
extends AbstractEventRepository

Implementation of in memory EventRepository with limited events.

Author:

Cedrick Lunven (@clunven)

Field Summary

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

KDF

Constructor Summary

Constructors

Constructor and Description
InMemoryEventRepository() Default constructor with default capacity to 100.000
InMemoryEventRepository(int queueCapacity) Constructor to tune capacity.

Method Summary

Modifier and Type	Method and Description
void	createSchema() Initialize target database with expected schema if needed.
EventSeries	getAuditTrail(EventQueryDefinition q) Display audit trail as list of Event.
Event	getEventByUUID(String uuid, Long timestamp) Retrieve an event by its unique identifer.
TimeSeriesChart	getFeatureUsageHistory(EventQueryDefinition query, TimeUnit units) 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 q) Purge audit trail.
void	purgeFeatureUsage(EventQueryDefinition q) Purge feature usage.
boolean	saveEvent(Event e) Save event into store synchronously.
EventSeries	searchFeatureUsageEvents(EventQueryDefinition query) Search over events.

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

Constructor Detail

InMemoryEventRepository

public InMemoryEventRepository()

Default constructor with default capacity to 100.000

InMemoryEventRepository

public InMemoryEventRepository(int queueCapacity)

Constructor to tune capacity.

Parameters:

queueCapacity - default queue capacity

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

getFeatureUsageHitCount

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

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

Returns:

getSourceHitCount

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

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

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.

getFeatureUsageHistory

public TimeSeriesChart getFeatureUsageHistory(EventQueryDefinition query,
                                              TimeUnit units)

Create measure over time.

Returns:

getAuditTrail

public EventSeries getAuditTrail(EventQueryDefinition q)

Display audit trail as list of Event.

Returns:

target list of event

purgeAuditTrail

public void purgeAuditTrail(EventQueryDefinition q)

Purge audit trail.

purgeFeatureUsage

public void purgeFeatureUsage(EventQueryDefinition q)

Purge feature usage.

searchFeatureUsageEvents

public EventSeries searchFeatureUsageEvents(EventQueryDefinition query)

Search over events.

Returns:

a list of events

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