com.bigdata.journal

Interface IJournal

All Superinterfaces:

IAddressManager, IAtomicStore, IBTreeManager, ICounterSetAccess, IGISTLocalManager, IGISTManager, IIndexManager, IIndexStore, IMRMW, IMROW, IRawStore, IStreamStore

All Known Subinterfaces:

IHAJournal

All Known Implementing Classes:

AbstractJournal, Journal, JournalDelegate, StoreManager.ManagedJournal

public interface IJournal
extends IMRMW, IAtomicStore, IBTreeManager

An persistence capable data structure supporting atomic commit, scalable named indices, and transactions.

Author:

Bryan Thompson

Field Summary

Fields inherited from interface com.bigdata.rawstore.IAddressManager

NULL

Method Summary

Methods

Modifier and Type	Method and Description
long	awaitHAReady(long timeout, TimeUnit units) Await the service being ready to partitipate in an HA quorum.
ILocalTransactionManager	getLocalTransactionManager() Return the object providing the local transaction manager for this journal.
Properties	getProperties() A copy of the properties used to initialize this journal.
Quorum<HAGlue,QuorumService<HAGlue>>	getQuorum() The Quorum for this service -or- null if the service is not running with a quorum.
boolean	isHAJournal() Convenience method created in BLZG-1370 to factor out bigdata-jini artifact dependencies.
void	shutdown() Shutdown the journal politely.
void	shutdownNow() Immediate shutdown.

Methods inherited from interface com.bigdata.journal.IAtomicStore

abort, commit, getCommitRecord, getRootAddr, getRootBlockView, isDirty, setCommitter

Methods inherited from interface com.bigdata.rawstore.IRawStore

close, delete, deleteResources, destroy, force, getFile, getResourceMetadata, getUUID, isFullyBuffered, isOpen, isReadOnly, isStable, read, size, write

Methods inherited from interface com.bigdata.rawstore.IAddressManager

getByteCount, getOffset, getPhysicalAddress, toAddr, toString

Methods inherited from interface com.bigdata.rawstore.IStreamStore

getInputStream, getOutputStream

Methods inherited from interface com.bigdata.journal.IBTreeManager

getIndex, registerIndex, registerIndex

Methods inherited from interface com.bigdata.journal.IIndexManager

getIndex, isGroupCommit

Methods inherited from interface com.bigdata.journal.IIndexStore

addScheduledTask, destroy, getCollectPlatformStatistics, getCollectQueueStatistics, getExecutorService, getGlobalFileSystem, getGlobalRowStore, getGlobalRowStore, getHttpdPort, getLastCommitTime, getResourceLocator, getResourceLockService, getTempStore

Methods inherited from interface com.bigdata.counters.ICounterSetAccess

getCounters

Methods inherited from interface com.bigdata.journal.IGISTLocalManager

getIndexLocal, getUnisolatedIndex, register

Methods inherited from interface com.bigdata.journal.IGISTManager

dropIndex, indexNameScan, registerIndex

Method Detail

getProperties

Properties getProperties()

A copy of the properties used to initialize this journal.

shutdown

void shutdown()

Shutdown the journal politely. Scheduled operations will run to completion, but no new operations will be scheduled.

shutdownNow

void shutdownNow()

Immediate shutdown.

getLocalTransactionManager

ILocalTransactionManager getLocalTransactionManager()

Return the object providing the local transaction manager for this journal.

getQuorum

Quorum<HAGlue,QuorumService<HAGlue>> getQuorum()

The Quorum for this service -or- null if the service is not running with a quorum.

awaitHAReady

long awaitHAReady(long timeout,
                TimeUnit units)
                  throws InterruptedException,
                         TimeoutException,
                         AsynchronousQuorumCloseException

Await the service being ready to partitipate in an HA quorum. The preconditions include:

1. receiving notice of the quorum token via #setQuorumToken(long)
2. The service is joined with the met quorum for that token
3. If the service is a follower and it's local root blocks were at commitCounter:=0, then the root blocks from the leader have been installed on the follower.

Parameters:

timeout - The timeout to await this condition.

units - The units for that timeout.

Returns:

the quorum token for which the service became HA ready.

Throws:

InterruptedException

TimeoutException

AsynchronousQuorumCloseException

isHAJournal

boolean isHAJournal()

Convenience method created in BLZG-1370 to factor out bigdata-jini artifact dependencies. This should return true IFF the underlying journal is com.bigdata.jini.ha.HAJournal.

Returns: