org.nuxeo.lib.stream.log

Interface LogManager

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractLogManager, ChronicleLogManager, KafkaLogManager

public interface LogManager
extends AutoCloseable

Manage Log and give access to Appenders and Tailers. Closing the LogManager will also close all its appenders and tailers.

Since:

9.3

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	createIfNotExists(String name, int size) Creates a new Log with size partitions if the Log does not exists.
<M extends Externalizable> LogTailer<M>	createTailer(String group, Collection<LogPartition> partitions) Create a tailer for a consumer group and assign multiple partitions.
default <M extends Externalizable> LogTailer<M>	createTailer(String group, LogPartition partition) Create a tailer for a consumer group and assign a single partition.
default <M extends Externalizable> LogTailer<M>	createTailer(String group, String name) Create a tailer for a consumer group and assign all partitions of the Log.
boolean	delete(String name) Try to delete a Log.
boolean	exists(String name) Returns true if a Log with this name exists.
<M extends Externalizable> LogAppender<M>	getAppender(String name) Get an appender for the Log named name.
default LogLag	getLag(String name, String group) Returns the lag between consumer group and producers for a Log.
List<LogLag>	getLagPerPartition(String name, String group) Returns the lag between consumer group and the producers for each partition.
List<String>	listAll() Returns all the Log names.
List<String>	listConsumerGroups(String name) List the consumer groups for a Log.
<M extends Externalizable> LogTailer<M>	subscribe(String group, Collection<String> names, RebalanceListener listener) Create a tailer for a consumer group and subscribe to multiple Logs.
boolean	supportSubscribe() Returns true if the Log subscribe(java.lang.String, java.util.Collection<java.lang.String>, org.nuxeo.lib.stream.log.RebalanceListener) method is supported.

Method Detail

exists

boolean exists(String name)

Returns true if a Log with this name exists.

createIfNotExists

boolean createIfNotExists(String name,
                          int size)

Creates a new Log with size partitions if the Log does not exists. Returns true it the Log has been created.

delete

boolean delete(String name)

Try to delete a Log. Returns true if successfully deleted, might not be possible depending on the implementation.

getAppender

<M extends Externalizable> LogAppender<M> getAppender(String name)

Get an appender for the Log named name. An appender is thread safe.

createTailer

<M extends Externalizable> LogTailer<M> createTailer(String group,
                                                     Collection<LogPartition> partitions)

Create a tailer for a consumer group and assign multiple partitions. Note that partitions can be from different Logs. A tailer is NOT thread safe.

createTailer

default <M extends Externalizable> LogTailer<M> createTailer(String group,
                                                             LogPartition partition)

Create a tailer for a consumer group and assign a single partition. A tailer is NOT thread safe.

createTailer

default <M extends Externalizable> LogTailer<M> createTailer(String group,
                                                             String name)

Create a tailer for a consumer group and assign all partitions of the Log. A tailer is NOT thread safe.

supportSubscribe

boolean supportSubscribe()

Returns true if the Log subscribe(java.lang.String, java.util.Collection<java.lang.String>, org.nuxeo.lib.stream.log.RebalanceListener) method is supported.

subscribe

<M extends Externalizable> LogTailer<M> subscribe(String group,
                                                  Collection<String> names,
                                                  RebalanceListener listener)

Create a tailer for a consumer group and subscribe to multiple Logs. The partitions assignment is done dynamically depending on the number of subscribers. The partitions can change during tailers life, this is called a rebalancing. A listener can be used to be notified on assignment changes.

A tailer is NOT thread safe.

You should not mix createTailer(java.lang.String, java.util.Collection<org.nuxeo.lib.stream.log.LogPartition>) and subscribe usage using the same group.

getLagPerPartition

List<LogLag> getLagPerPartition(String name,
                                String group)

Returns the lag between consumer group and the producers for each partition. The result list is ordered, for instance index 0 is lag for partition 0.

getLag

default LogLag getLag(String name,
                      String group)

Returns the lag between consumer group and producers for a Log.

listAll

List<String> listAll()

Returns all the Log names.

listConsumerGroups

List<String> listConsumerGroups(String name)

List the consumer groups for a Log.

close

void close()

Specified by:

close in interface AutoCloseable