co.cask.cdap.data2.transaction.stream

Interface ConsumerStateStore<S extends ConsumerState<T>,T>

Type Parameters:

S - Type of state object this store can operate on.

T - Type of state information that the ConsumerState contains

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

HBaseStreamConsumerStateStore, InMemoryStreamConsumerStateStore, LevelDBStreamConsumerStateStore, StreamConsumerStateStore

public interface ConsumerStateStore<S extends ConsumerState<T>,T>
extends Closeable

Represents storage for ConsumerState.

Method Summary

Methods

Modifier and Type	Method and Description
S	get(long groupId, int instanceId)
void	getAll(Collection<? super S> result)
void	getByGroup(long groupId, Collection<? super S> result)
void	remove(Iterable<? extends S> states)
void	save(Iterable<? extends S> states)
void	save(S state)

Methods inherited from interface java.io.Closeable

close

Method Detail

getAll

void getAll(Collection<? super S> result)
            throws IOException

Throws:

IOException

getByGroup

void getByGroup(long groupId,
              Collection<? super S> result)
                throws IOException

Throws:

IOException

get

S get(long groupId,
    int instanceId)
                               throws IOException

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

void save(S state)
          throws IOException

Throws:

IOException

save

void save(Iterable<? extends S> states)
          throws IOException

Throws:

IOException

remove

void remove(Iterable<? extends S> states)
            throws IOException

Throws:

IOException