co.cask.cdap.data2.transaction.queue

Class AbstractQueueProducer

java.lang.Object

co.cask.cdap.data2.transaction.queue.AbstractQueueProducer

All Implemented Interfaces:

QueueProducer, co.cask.tephra.TransactionAware, Closeable, AutoCloseable

Direct Known Subclasses:

HBaseQueueProducer, InMemoryQueueProducer, LevelDBQueueProducer

public abstract class AbstractQueueProducer
extends Object
implements QueueProducer, co.cask.tephra.TransactionAware

Abstract base class for QueueProducer that emits enqueue metrics post commit.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractQueueProducer(QueueMetrics queueMetrics, QueueName queueName)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
boolean	commitTx()
protected abstract void	doRollback()
void	enqueue(Iterable<QueueEntry> entries) Enqueues a list of QueueEntry.
void	enqueue(QueueEntry entry) Enqueues a QueueEntry.
String	getTransactionAwareName()
Collection<byte[]>	getTxChanges()
protected abstract int	persist(Iterable<QueueEntry> entries, co.cask.tephra.Transaction transaction) Persists queue entries.
void	postTxCommit()
boolean	rollbackTx()
void	startTx(co.cask.tephra.Transaction tx)
void	updateTx(co.cask.tephra.Transaction transaction)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractQueueProducer

protected AbstractQueueProducer(QueueMetrics queueMetrics,
                     QueueName queueName)

Method Detail

getTransactionAwareName

public String getTransactionAwareName()

Specified by:

getTransactionAwareName in interface co.cask.tephra.TransactionAware

enqueue

public void enqueue(QueueEntry entry)
             throws IOException

Description copied from interface: QueueProducer

Enqueues a QueueEntry.

Specified by:

enqueue in interface QueueProducer

Throws:

IOException

enqueue

public void enqueue(Iterable<QueueEntry> entries)
             throws IOException

Description copied from interface: QueueProducer

Enqueues a list of QueueEntry.

Specified by:

enqueue in interface QueueProducer

Throws:

IOException

startTx

public void startTx(co.cask.tephra.Transaction tx)

Specified by:

startTx in interface co.cask.tephra.TransactionAware

updateTx

public void updateTx(co.cask.tephra.Transaction transaction)

Specified by:

updateTx in interface co.cask.tephra.TransactionAware

getTxChanges

public Collection<byte[]> getTxChanges()

Specified by:

getTxChanges in interface co.cask.tephra.TransactionAware

commitTx

public boolean commitTx()
                 throws Exception

Specified by:

commitTx in interface co.cask.tephra.TransactionAware

Throws:

Exception

postTxCommit

public void postTxCommit()

Specified by:

postTxCommit in interface co.cask.tephra.TransactionAware

rollbackTx

public boolean rollbackTx()
                   throws Exception

Specified by:

rollbackTx in interface co.cask.tephra.TransactionAware

Throws:

Exception

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

persist

protected abstract int persist(Iterable<QueueEntry> entries,
          co.cask.tephra.Transaction transaction)
                        throws Exception

Persists queue entries.

Parameters:

entries - queue entries to persist.

transaction - transaction to use.

Returns:

size in bytes of the entries persisted.

Throws:

Exception

doRollback

protected abstract void doRollback()
                            throws Exception

Throws:

Exception