Package com.jalios.jcms.analytics.storage.impl

Class FileSystemStorage

java.lang.Object

com.jalios.jcms.analytics.storage.AbstractStorageHandler

com.jalios.jcms.analytics.storage.impl.FileSystemStorage

public class FileSystemStorage
extends AbstractStorageHandler

Constructor Summary

Constructors

Constructor	Description
FileSystemStorage()

Method Summary

Modifier and Type	Method	Description
AbstractEventDataProvider	getEventDataProvider(StatisticContext context)	Build a AbstractEventDataProvider to provide data for analysis
java.io.File	getEventDirectory()	Retrieve event data directory
java.time.Instant	getOlderAnalyticsDataDate()	Retrieve the older date from the analytics file
void	init(java.lang.String propertyPrefix, JProperties subProperties)	Create a EventData storage (in a directory of the current file system)
boolean	isAnalysisProvider()	indicate if the AbstractStorageHandler is the eventData provider for analysis or not.
void	shutdown()	shutdown a AbstractEventDataProvider instance
void	writeEvent(EventData data)	Write an EventData in the file

Methods inherited from class com.jalios.jcms.analytics.storage.AbstractStorageHandler

getName, isEnabled, setEnabled, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemStorage

public FileSystemStorage()

Method Detail

init

public void init(java.lang.String propertyPrefix,
                 JProperties subProperties)

Create a EventData storage (in a directory of the current file system)

Specified by:

init in class AbstractStorageHandler

Parameters:

propertyPrefix - used to configure the handler

subProperties - the Map with the handler's properties

shutdown

public void shutdown()

Description copied from class: AbstractStorageHandler

shutdown a AbstractEventDataProvider instance

Overrides:

shutdown in class AbstractStorageHandler

writeEvent

public void writeEvent(EventData data)
                throws StorageException

Write an EventData in the file

Specified by:

writeEvent in class AbstractStorageHandler

Parameters:

data - the EventData

Throws:

StorageException - Exception thrown when eventData is save as JSON data

getOlderAnalyticsDataDate

public java.time.Instant getOlderAnalyticsDataDate()

Retrieve the older date from the analytics file

Specified by:

getOlderAnalyticsDataDate in class AbstractStorageHandler

Returns:

the older date if any, Long.MAX_VALUE otherwise

isAnalysisProvider

public boolean isAnalysisProvider()

Description copied from class: AbstractStorageHandler

indicate if the AbstractStorageHandler is the eventData provider for analysis or not. Note only one AbstractStorageHandler should be enabled for analysis at runtime

Specified by:

isAnalysisProvider in class AbstractStorageHandler

Returns:

true if the AbstractStorageHandler is enabled for provided analysis data, false otherwise

getEventDataProvider

public AbstractEventDataProvider getEventDataProvider(StatisticContext context)
                                               throws StorageException

Description copied from class: AbstractStorageHandler

Build a AbstractEventDataProvider to provide data for analysis

Specified by:

getEventDataProvider in class AbstractStorageHandler

Parameters:

context - the StatisticContext used to create the EventData provider

Returns:

the AbstractEventDataProvider

Throws:

StorageException - if the EventData cannot be created

getEventDirectory

public java.io.File getEventDirectory()

Retrieve event data directory

Returns:

the File