co.cask.cdap.data2.transaction.stream

Class StreamConsumerStateStore

java.lang.Object

co.cask.cdap.data2.transaction.stream.StreamConsumerStateStore

All Implemented Interfaces:

ConsumerStateStore<StreamConsumerState,Iterable<StreamFileOffset>>, Closeable, AutoCloseable

Direct Known Subclasses:

HBaseStreamConsumerStateStore, InMemoryStreamConsumerStateStore, LevelDBStreamConsumerStateStore

public abstract class StreamConsumerStateStore
extends Object
implements ConsumerStateStore<StreamConsumerState,Iterable<StreamFileOffset>>

Represents storage for ConsumerState for stream consumers.

Field Summary

Fields

Modifier and Type	Field and Description
protected StreamConfig	streamConfig
protected Id.Stream	streamId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamConsumerStateStore(StreamConfig streamConfig)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	delete(byte[] row, Set<byte[]> columns) Deletes the set of columns from the given row.
protected abstract byte[]	fetch(byte[] row, byte[] column) Fetches the cell value for the given row and column.
protected abstract void	fetchAll(byte[] row, byte[] columnPrefix, Map<byte[],byte[]> result) Fetches all values for the given row.
protected abstract void	fetchAll(byte[] row, Map<byte[],byte[]> result) Fetches all values for the given row.
StreamConsumerState	get(long groupId, int instanceId)
void	getAll(Collection<? super StreamConsumerState> result)
void	getByGroup(long groupId, Collection<? super StreamConsumerState> result)
void	remove(Iterable<? extends StreamConsumerState> states)
void	save(Iterable<? extends StreamConsumerState> states)
void	save(StreamConsumerState state)
protected abstract void	store(byte[] row, byte[] column, byte[] value) Stores the given value to cell identified by the given row and column.
protected abstract void	store(byte[] row, Map<byte[],byte[]> values) Stores all the values to the given row.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Field Detail

streamConfig

protected final StreamConfig streamConfig

streamId

protected final Id.Stream streamId

Constructor Detail

StreamConsumerStateStore

protected StreamConsumerStateStore(StreamConfig streamConfig)

Method Detail

getAll

public final void getAll(Collection<? super StreamConsumerState> result)
                  throws IOException

Specified by:

getAll in interface ConsumerStateStore<StreamConsumerState,Iterable<StreamFileOffset>>

Throws:

IOException

getByGroup

public final void getByGroup(long groupId,
              Collection<? super StreamConsumerState> result)
                      throws IOException

Specified by:

getByGroup in interface ConsumerStateStore<StreamConsumerState,Iterable<StreamFileOffset>>

Throws:

IOException

get

public final StreamConsumerState get(long groupId,
                      int instanceId)
                              throws IOException

Specified by:

get in interface ConsumerStateStore<StreamConsumerState,Iterable<StreamFileOffset>>

Returns:

the consumer state for the given groupId and instanceId. If no state is found, a state object with empty state info will be returned. If no such consumer exists in the state store, null will be returned.

Throws:

IOException

save

public final void save(StreamConsumerState state)
                throws IOException

Specified by:

save in interface ConsumerStateStore<StreamConsumerState,Iterable<StreamFileOffset>>

Throws:

IOException

save

public final void save(Iterable<? extends StreamConsumerState> states)
                throws IOException

Specified by:

save in interface ConsumerStateStore<StreamConsumerState,Iterable<StreamFileOffset>>

Throws:

IOException

remove

public final void remove(Iterable<? extends StreamConsumerState> states)
                  throws IOException

Specified by:

remove in interface ConsumerStateStore<StreamConsumerState,Iterable<StreamFileOffset>>

Throws:

IOException

fetch

protected abstract byte[] fetch(byte[] row,
           byte[] column)
                         throws IOException

Fetches the cell value for the given row and column. If no such value exists, null should be returned.

Throws:

IOException

fetchAll

protected abstract void fetchAll(byte[] row,
            Map<byte[],byte[]> result)
                          throws IOException

Fetches all values for the given row.

Parameters:

row - the row to fetch from.

result - a map from column to value.

Throws:

IOException

fetchAll

protected abstract void fetchAll(byte[] row,
            byte[] columnPrefix,
            Map<byte[],byte[]> result)
                          throws IOException

Fetches all values for the given row. Children can optionally use the columnPrefix to do more efficient retrieval.

Parameters:

row - the row to fetch from.

columnPrefix - the column prefix.

result - a map from column to value. It's valid to contains columns that don't start with columnPrefix.

Throws:

IOException

store

protected abstract void store(byte[] row,
         byte[] column,
         byte[] value)
                       throws IOException

Stores the given value to cell identified by the given row and column.

Throws:

IOException

store

protected abstract void store(byte[] row,
         Map<byte[],byte[]> values)
                       throws IOException

Stores all the values to the given row.

Parameters:

row - the row to store to.

values - Map from column name to value.

Throws:

IOException

delete

protected abstract void delete(byte[] row,
          Set<byte[]> columns)
                        throws IOException

Deletes the set of columns from the given row.

Parameters:

row - the row to act on.

columns - columns to get deleted.

Throws:

IOException