org.gcube.documentstore.persistence

Class PersistenceBackend

java.lang.Object

org.gcube.documentstore.persistence.PersistenceBackend

Direct Known Subclasses:

FallbackPersistenceBackend

public abstract class PersistenceBackend
extends Object

Author:

Luca Frosini (ISTI - CNR) http://www.lucafrosini.com/

Field Summary

Fields

Modifier and Type	Field and Description
protected AggregationScheduler	aggregationScheduler
protected FallbackPersistenceBackend	fallbackPersistence
protected org.gcube.documentstore.persistence.PersistenceBackendMonitor	persistenceBackendMonitor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PersistenceBackend()
protected	PersistenceBackend(FallbackPersistenceBackend fallback)

Method Summary

Methods

Modifier and Type	Method and Description
void	account(Record record) Persist the #UsageRecord.
protected void	accountValidateAggregate(Record record, boolean validate, boolean aggregate)
protected void	accountWithFallback(Record... records)
abstract void	close()
void	flush(long timeout, TimeUnit timeUnit)
AggregationScheduler	getAggregationScheduler()
FallbackPersistenceBackend	getFallbackPersistence()
protected abstract void	prepareConnection(PersistenceBackendConfiguration configuration) Prepare the connection to persistence.
protected abstract void	reallyAccount(Record record) This method contains the code to save the Record
protected void	setAggregationScheduler(AggregationScheduler aggregationScheduler)
protected void	setFallback(FallbackPersistenceBackend fallback)

Methods inherited from class java.lang.Object

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

Field Detail

fallbackPersistence

protected FallbackPersistenceBackend fallbackPersistence

aggregationScheduler

protected AggregationScheduler aggregationScheduler

persistenceBackendMonitor

protected org.gcube.documentstore.persistence.PersistenceBackendMonitor persistenceBackendMonitor

Constructor Detail

PersistenceBackend

protected PersistenceBackend()

PersistenceBackend

protected PersistenceBackend(FallbackPersistenceBackend fallback)

Method Detail

getFallbackPersistence

public FallbackPersistenceBackend getFallbackPersistence()

Returns:

the fallbackPersistence

setFallback

protected void setFallback(FallbackPersistenceBackend fallback)

Parameters:

fallback - the fallback to set

getAggregationScheduler

public AggregationScheduler getAggregationScheduler()

Returns:

the aggregationScheduler

setAggregationScheduler

protected void setAggregationScheduler(AggregationScheduler aggregationScheduler)

Parameters:

aggregationScheduler - the aggregationScheduler to set

prepareConnection

protected abstract void prepareConnection(PersistenceBackendConfiguration configuration)
                                   throws Exception

Prepare the connection to persistence. This method must be used by implementation class to open the connection with the persistence storage, DB, file etc.

Parameters:

configuration - The configuration to create the connection

Throws:

Exception - if fails

reallyAccount

protected abstract void reallyAccount(Record record)
                               throws Exception

This method contains the code to save the Record

Throws:

Exception

accountWithFallback

protected void accountWithFallback(Record... records)

accountValidateAggregate

protected void accountValidateAggregate(Record record,
                            boolean validate,
                            boolean aggregate)

account

public void account(Record record)
             throws InvalidValueException

Persist the #UsageRecord. The Record is validated first, then accounted, in a separated thread. So that the program can continue the execution. If the persistence fails the class write that the record in a local file so that the #UsageRecord can be recorder later.

Parameters:

usageRecord - the #UsageRecord to persist

Throws:

InvalidValueException - if the Record Validation Fails

flush

public void flush(long timeout,
         TimeUnit timeUnit)
           throws Exception

Throws:

Exception

close

public abstract void close()
                    throws Exception

Throws:

Exception