Package com.tangosol.io.journal

Class BackupJournalRM.RamConsumer

java.lang.Object

com.tangosol.io.journal.BackupJournalRM.RamConsumer

All Implemented Interfaces:

Disposable, Journal.JournalConsumer, AutoCloseable

Enclosing class:

BackupJournalRM

protected class BackupJournalRM.RamConsumer
extends Object
implements Journal.JournalConsumer

The RamConsumer is a pass-through consumer used to obtain a ram journal instance.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RamConsumer()

Method Summary

Modifier and Type	Method	Description
void	dedupe(byte[][] aab)	This method may be invoked by the Journal implementation to request that any immutable byte arrays managed by the consumer be de-duplicated.
void	dispose()	Invoked when all resources owned by the implementer can safely be released.
void	evacuate(long lTicketMask, long lTicketValue)	This method may be invoked by the Journal implementation to request that the consumer evacuate a particular journal file.
BackupJournalRM.JournalImpl	getBackupJournal()	Obtain the instance of the backup journal.
Journal.JournalConsumer	getConsumer()	Obtain the underlying consumer that this RamConsumer delegates to.
String	getDescription()	Format a String description of the Consumer.
void	setBackupJournal(BackupJournalRM.JournalImpl jrnlBackup)	Specify the instance of the backup journal.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.coherence.common.base.Disposable

close

Constructor Detail

RamConsumer

protected RamConsumer()

Method Detail

evacuate

public void evacuate(long lTicketMask,
                     long lTicketValue)

This method may be invoked by the Journal implementation to request that the consumer evacuate a particular journal file.

Specified by:

evacuate in interface Journal.JournalConsumer

Parameters:

lTicketMask - indicates which bits of the tickets to check

lTicketValue - indicates what bit pattern needs to be matched on the tickets in order to select them for evacuation

dedupe

public void dedupe(byte[][] aab)

This method may be invoked by the Journal implementation to request that any immutable byte arrays managed by the consumer be de-duplicated.

Specified by:

dedupe in interface Journal.JournalConsumer

Parameters:

aab - an array of byte[] objects for intern-ing byte[] references

getDescription

public String getDescription()

Format a String description of the Consumer.

Specified by:

getDescription in interface Journal.JournalConsumer

Returns:

a comma-delimited key-value description of this object

dispose

public void dispose()

Invoked when all resources owned by the implementer can safely be released.

Once disposed of the object should no longer be considered to be usable.

Note the Disposable interface is compatible with try-with-resources which will automatically invoke this method.

Specified by:

dispose in interface Disposable

getBackupJournal

public BackupJournalRM.JournalImpl getBackupJournal()

Obtain the instance of the backup journal.

Returns:

the instance of the backup JournalImpl that this delegating RamConsumer is serving

setBackupJournal

public void setBackupJournal(BackupJournalRM.JournalImpl jrnlBackup)

Specify the instance of the backup journal.

Parameters:

jrnlBackup - the instance of the backup JournalImpl that this delegating RamConsumer is serving

getConsumer

public Journal.JournalConsumer getConsumer()

Obtain the underlying consumer that this RamConsumer delegates to. The consumer is null before the backup journal is configured and after the backup journal or RamConsumer has been disposed.

Returns:

the underlying consumer or null