Package com.jalios.jcms.analytics.storage

Class AbstractStorageHandler

java.lang.Object

com.jalios.jcms.analytics.storage.AbstractStorageHandler

Direct Known Subclasses:

FileSystemStorage

public abstract class AbstractStorageHandler
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
AbstractStorageHandler()

Method Summary

Modifier and Type	Method	Description
abstract AbstractEventDataProvider	getEventDataProvider(StatisticContext context)	Build a AbstractEventDataProvider to provide data for analysis
java.lang.String	getName()
abstract java.time.Instant	getOlderAnalyticsDataDate()	Retrieve the older date from the analytics file
abstract void	init(java.lang.String propertyPrefix, JProperties subProperties)	Init a EventData storage
abstract boolean	isAnalysisProvider()	indicate if the AbstractStorageHandler is the eventData provider for analysis or not.
boolean	isEnabled()
void	setEnabled(boolean enabled)
void	setName(java.lang.String name)
void	shutdown()	shutdown a AbstractEventDataProvider instance
abstract void	writeEvent(EventData data)	Write a EventData in the storage

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStorageHandler

public AbstractStorageHandler()

Method Detail

init

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

Init a EventData storage

Parameters:

propertyPrefix - used to configure the handler

subProperties - the JProperties with the handler's properties

writeEvent

public abstract void writeEvent(EventData data)
                         throws StorageException

Write a EventData in the storage

Parameters:

data - the EventData to write

Throws:

StorageException - exception throw by the storage subsystem

getOlderAnalyticsDataDate

public abstract java.time.Instant getOlderAnalyticsDataDate()

Retrieve the older date from the analytics file

Returns:

the older date if any, null otherwise

isAnalysisProvider

public abstract boolean isAnalysisProvider()

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

Returns:

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

getEventDataProvider

public abstract AbstractEventDataProvider getEventDataProvider(StatisticContext context)
                                                        throws StorageException

Build a AbstractEventDataProvider to provide data for analysis

Parameters:

context - the StatisticContext used to create the EventData provider

Returns:

the AbstractEventDataProvider

Throws:

StorageException - if the EventData cannot be created

shutdown

public void shutdown()

shutdown a AbstractEventDataProvider instance

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)