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), Alessandro Pieve (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field and Description
protected AggregationScheduler	aggregationScheduler
protected boolean	closed
protected static Integer	countFallback
protected FallbackPersistenceBackend	fallbackPersistence
static Integer	MAX_FALLBACK
static long	MAX_TIME_TO_FALLBACK
protected PersistenceBackendMonitor	persistenceBackendMonitor
protected boolean	timeoutFallback
protected long	timerToFallback

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() This method is used to close
protected void	closeAndClean() This method is used to close db and clean the configuration.
protected abstract void	closeConnection() This method is used to open db connection
void	flush(long timeout, TimeUnit timeUnit)
AggregationScheduler	getAggregationScheduler()
FallbackPersistenceBackend	getFallbackPersistence()
boolean	isOpen()
protected abstract void	openConnection() This method is used to open db connection
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)
protected void	setOpen()

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 PersistenceBackendMonitor persistenceBackendMonitor

MAX_FALLBACK

public static final Integer MAX_FALLBACK

countFallback

protected static Integer countFallback

timeoutFallback

protected boolean timeoutFallback

timerToFallback

protected long timerToFallback

MAX_TIME_TO_FALLBACK

public static final long MAX_TIME_TO_FALLBACK

See Also:

Constant Field Values

closed

protected boolean closed

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 prepare the connection with the persistence storage, DB, file etc.

Parameters:

configuration - The configuration to create the connection

Throws:

Exception - if fails

openConnection

protected abstract void openConnection()
                                throws Exception

This method is used to open db connection

Throws:

Exception

closeConnection

protected abstract void closeConnection()
                                 throws Exception

This method is used to open db connection

Throws:

Exception

close

public abstract void close()
                    throws Exception

This method is used to close

Throws:

Exception

closeAndClean

protected void closeAndClean()
                      throws Exception

This method is used to close db and clean the configuration. It is used when there are too much TimeoutException trying to persist records.

Throws:

Exception

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)
                            throws Exception

Parameters:

records -

Throws:

Exception

accountValidateAggregate

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

Parameters:

record -

validate -

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

isOpen

public boolean isOpen()

setOpen

protected void setOpen()