Package org.opendaylight.controller.cluster

Class PersistentDataProvider

java.lang.Object

org.opendaylight.controller.cluster.PersistentDataProvider

All Implemented Interfaces:

DataPersistenceProvider

public class PersistentDataProvider
extends Object
implements DataPersistenceProvider

A DataPersistenceProvider implementation with persistence enabled.

Constructor Summary

Constructors

Constructor	Description
PersistentDataProvider(AbstractPersistentActor persistentActor)

Method Summary

Modifier and Type	Method	Description
void	deleteMessages(long sequenceNumber)	Deletes journal entries up to the given sequence number.
void	deleteSnapshots(SnapshotSelectionCriteria criteria)	Deletes snapshots based on the given criteria.
long	getLastSequenceNumber()	Returns the last sequence number contained in the journal.
boolean	handleJournalResponse(JournalProtocol.Response response)	Receive and potentially handle a JournalProtocol response.
boolean	handleSnapshotResponse(SnapshotProtocol.Response response)	Receive and potentially handle a SnapshotProtocol response.
boolean	isRecoveryApplicable()	Returns whether or not persistence recovery is applicable/enabled.
<T> void	persist(T entry, Procedure<T> procedure)	Persists an entry to the applicable journal synchronously.
<T> void	persistAsync(T entry, Procedure<T> procedure)	Persists an entry to the applicable journal asynchronously.
void	saveSnapshot(Object snapshot)	Saves a snapshot.

Methods inherited from class java.lang.Object

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

Constructor Details

PersistentDataProvider

public PersistentDataProvider(AbstractPersistentActor persistentActor)

Method Details

isRecoveryApplicable

public boolean isRecoveryApplicable()

Description copied from interface: DataPersistenceProvider

Returns whether or not persistence recovery is applicable/enabled.

Specified by:

isRecoveryApplicable in interface DataPersistenceProvider

Returns:

true if recovery is applicable, otherwise false, in which case the provider is not persistent and may not have anything to be recovered

persist

public <T> void persist(T entry,
 Procedure<T> procedure)

Description copied from interface: DataPersistenceProvider

Persists an entry to the applicable journal synchronously.

Specified by:

persist in interface DataPersistenceProvider

Type Parameters:

T - the type of the journal entry

Parameters:

entry - the journal entry to persist

procedure - the callback when persistence is complete

persistAsync

public <T> void persistAsync(T entry,
 Procedure<T> procedure)

Description copied from interface: DataPersistenceProvider

Persists an entry to the applicable journal asynchronously.

Specified by:

persistAsync in interface DataPersistenceProvider

Type Parameters:

T - the type of the journal entry

Parameters:

entry - the journal entry to persist

procedure - the callback when persistence is complete

saveSnapshot

public void saveSnapshot(Object snapshot)

Description copied from interface: DataPersistenceProvider

Saves a snapshot.

Specified by:

saveSnapshot in interface DataPersistenceProvider

Parameters:

snapshot - the snapshot object to save

deleteSnapshots

public void deleteSnapshots(SnapshotSelectionCriteria criteria)

Description copied from interface: DataPersistenceProvider

Deletes snapshots based on the given criteria.

Specified by:

deleteSnapshots in interface DataPersistenceProvider

Parameters:

criteria - the search criteria

deleteMessages

public void deleteMessages(long sequenceNumber)

Description copied from interface: DataPersistenceProvider

Deletes journal entries up to the given sequence number.

Specified by:

deleteMessages in interface DataPersistenceProvider

Parameters:

sequenceNumber - the sequence number

getLastSequenceNumber

public long getLastSequenceNumber()

Description copied from interface: DataPersistenceProvider

Returns the last sequence number contained in the journal.

Specified by:

getLastSequenceNumber in interface DataPersistenceProvider

Returns:

the last sequence number

handleJournalResponse

public boolean handleJournalResponse(JournalProtocol.Response response)

Description copied from interface: DataPersistenceProvider

Receive and potentially handle a JournalProtocol response.

Specified by:

handleJournalResponse in interface DataPersistenceProvider

Parameters:

response - A JournalProtocol response

Returns:

true if the response was handled

handleSnapshotResponse

public boolean handleSnapshotResponse(SnapshotProtocol.Response response)

Description copied from interface: DataPersistenceProvider

Receive and potentially handle a SnapshotProtocol response.

Specified by:

handleSnapshotResponse in interface DataPersistenceProvider

Parameters:

response - A SnapshotProtocol response

Returns:

true if the response was handled