org.apache.twill.kafka.client

Interface BrokerService

All Superinterfaces:

com.google.common.util.concurrent.Service

public interface BrokerService
extends com.google.common.util.concurrent.Service

Service for providing information of kafka brokers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BrokerService.BrokerChangeListener Listener for changes in broker list.

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Method Summary

Modifier and Type	Method and Description
Cancellable	addChangeListener(BrokerService.BrokerChangeListener listener, Executor executor) Adds a listener to changes in broker list managed by this service.
String	getBrokerList() Returns a comma separate string of all current brokers.
Iterable<BrokerInfo>	getBrokers() Returns a live iterable that gives information for all the known brokers.
BrokerInfo	getLeader(String topic, int partition) Returns the broker information of the current leader of the given topic and partition.

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, start, startAndWait, startAsync, state, stop, stopAndWait, stopAsync

Method Detail

getLeader

BrokerInfo getLeader(String topic,
                     int partition)

Returns the broker information of the current leader of the given topic and partition.

Parameters:

topic - Topic for looking up for leader.

partition - Partition for looking up for leader.

Returns:

A BrokerInfo containing information about the current leader, or null if current leader is unknown.

getBrokers

Iterable<BrokerInfo> getBrokers()

Returns a live iterable that gives information for all the known brokers.

Returns:

An Iterable of BrokerInfo that when Iterable.iterator() is called, it returns an iterator that gives the latest list of BrokerInfo.

getBrokerList

String getBrokerList()

Returns a comma separate string of all current brokers.

Returns:

A string in the format host1:port1,host2:port2 or empty string if no broker has been discovered.

addChangeListener

Cancellable addChangeListener(BrokerService.BrokerChangeListener listener,
                              Executor executor)

Adds a listener to changes in broker list managed by this service.

Parameters:

listener - The listener to invoke when there is changes.

executor - Executor to use for invocation to the listener.

Returns:

A Cancellable to stop listening.