Class RaftClusterInvocationContext.RaftClusterInstance

java.lang.Object

org.apache.kafka.common.test.junit.RaftClusterInvocationContext.RaftClusterInstance

All Implemented Interfaces:

ClusterInstance

Enclosing class:

RaftClusterInvocationContext

public static class RaftClusterInvocationContext.RaftClusterInstance
extends Object
implements ClusterInstance

Method Summary

Modifier and Type	Method	Description
kafka.network.SocketServer	activeController()
kafka.network.SocketServer	anyNonControllerBrokerSocketServer()
String	bootstrapControllers()	The broker connect string which can be used by clients for bootstrapping to the controller quorum.
String	bootstrapServers()	The broker connect string which can be used by clients for bootstrapping
Map<Integer, kafka.server.KafkaBroker>	brokers()
Map<Integer, kafka.server.KafkaBroker>	brokersMap()
org.apache.kafka.common.network.ListenerName	clientListener()	The listener for this cluster as configured by ClusterTest or by ClusterConfig.
String	clusterId()
org.apache.kafka.common.test.api.ClusterConfig	config()	The immutable cluster configuration used to create this cluster.
Set<Integer>	controllerIds()	Return the set of all controller IDs configured for this test.
org.apache.kafka.common.network.ListenerName	controllerListener()
org.apache.kafka.common.network.ListenerName	controllerListenerName()	The listener for the kraft cluster controller configured by controller.listener.names.
Map<Integer, kafka.server.ControllerServer>	controllers()
Collection<kafka.network.SocketServer>	controllerSocketServers()	A collection of all controllers in the cluster.
RaftClusterInvocationContext.RaftClusterInstance	duplicateCluster(Consumer<org.apache.kafka.common.test.api.ClusterConfig.Builder> builderConsumer)
Optional<org.apache.kafka.server.fault.FaultHandlerException>	firstFatalException()	Returns the first recorded fatal exception, if any.
Optional<org.apache.kafka.server.fault.FaultHandlerException>	firstNonFatalException()	Return the first recorded non-fatal exception, if any.
void	format()
KafkaClusterTestKit	getUnderlying()
scala.Option<CompletableFuture<Integer>>	interBrokerPortFuture()
void	killAllBrokers()
kafka.network.SocketServer	linkCoordinator(String linkName)
Map<Integer, org.apache.kafka.image.MetadataImage>	metadataImage()
void	rollingBrokerRestart()
void	shutdownBroker(int brokerId)
void	start()
void	startBroker(int brokerId)
boolean	started()
void	stop()
boolean	stopped()
org.apache.kafka.common.test.api.Type	type()
void	waitForReadyBrokers()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.kafka.common.test.ClusterInstance

admin, admin, admin, aliveBrokers, anyBrokerSocketServer, anyControllerSocketServer, authorizers, brokerIds, brokerSocketServers, consumer, consumer, createTopic, createTopic, deleteTopic, getLeaderBrokerId, producer, producer, setClientSaslConfig, shareConsumer, shareConsumer, supportedGroupProtocols, waitAcls, waitForTopic, waitTopicDeletion

Method Details

bootstrapServers

public String bootstrapServers()

Description copied from interface: ClusterInstance

The broker connect string which can be used by clients for bootstrapping

Specified by:

bootstrapServers in interface ClusterInstance

bootstrapControllers

public String bootstrapControllers()

Description copied from interface: ClusterInstance

The broker connect string which can be used by clients for bootstrapping to the controller quorum.

Specified by:

bootstrapControllers in interface ClusterInstance

clientListener

public org.apache.kafka.common.network.ListenerName clientListener()

Description copied from interface: ClusterInstance

The listener for this cluster as configured by ClusterTest or by ClusterConfig. If unspecified by those sources, this will return the listener for the default security protocol PLAINTEXT

Specified by:

clientListener in interface ClusterInstance

controllerListener

public org.apache.kafka.common.network.ListenerName controllerListener()

Specified by:

controllerListener in interface ClusterInstance

controllerListenerName

public org.apache.kafka.common.network.ListenerName controllerListenerName()

Description copied from interface: ClusterInstance

The listener for the kraft cluster controller configured by controller.listener.names.

Specified by:

controllerListenerName in interface ClusterInstance

controllerSocketServers

public Collection<kafka.network.SocketServer> controllerSocketServers()

Description copied from interface: ClusterInstance

A collection of all controllers in the cluster.

Specified by:

controllerSocketServers in interface ClusterInstance

anyNonControllerBrokerSocketServer

public kafka.network.SocketServer anyNonControllerBrokerSocketServer()

Specified by:

anyNonControllerBrokerSocketServer in interface ClusterInstance

activeController

public kafka.network.SocketServer activeController()
                                            throws InterruptedException

Specified by:

activeController in interface ClusterInstance

Throws:

InterruptedException

linkCoordinator

public kafka.network.SocketServer linkCoordinator(String linkName)

Specified by:

linkCoordinator in interface ClusterInstance

clusterId

public String clusterId()

Specified by:

clusterId in interface ClusterInstance

type

public org.apache.kafka.common.test.api.Type type()

Specified by:

type in interface ClusterInstance

config

public org.apache.kafka.common.test.api.ClusterConfig config()

Description copied from interface: ClusterInstance

The immutable cluster configuration used to create this cluster.

Specified by:

config in interface ClusterInstance

controllerIds

public Set<Integer> controllerIds()

Description copied from interface: ClusterInstance

Return the set of all controller IDs configured for this test. For kraft, this will return only the nodes which have the "controller" role enabled in `process.roles`.

Specified by:

controllerIds in interface ClusterInstance

getUnderlying

public KafkaClusterTestKit getUnderlying()

duplicateCluster

public RaftClusterInvocationContext.RaftClusterInstance duplicateCluster(Consumer<org.apache.kafka.common.test.api.ClusterConfig.Builder> builderConsumer)

Specified by:

duplicateCluster in interface ClusterInstance

start

public void start()

Specified by:

start in interface ClusterInstance

started

public boolean started()

Specified by:

started in interface ClusterInstance

stop

public void stop()

Specified by:

stop in interface ClusterInstance

stopped

public boolean stopped()

Specified by:

stopped in interface ClusterInstance

shutdownBroker

public void shutdownBroker(int brokerId)

Specified by:

shutdownBroker in interface ClusterInstance

startBroker

public void startBroker(int brokerId)

Specified by:

startBroker in interface ClusterInstance

firstFatalException

public Optional<org.apache.kafka.server.fault.FaultHandlerException> firstFatalException()

Description copied from interface: ClusterInstance

Returns the first recorded fatal exception, if any.

Specified by:

firstFatalException in interface ClusterInstance

firstNonFatalException

public Optional<org.apache.kafka.server.fault.FaultHandlerException> firstNonFatalException()

Description copied from interface: ClusterInstance

Return the first recorded non-fatal exception, if any.

Specified by:

firstNonFatalException in interface ClusterInstance

waitForReadyBrokers

public void waitForReadyBrokers()
                         throws InterruptedException

Specified by:

waitForReadyBrokers in interface ClusterInstance

Throws:

InterruptedException

brokersMap

public Map<Integer, kafka.server.KafkaBroker> brokersMap()

Specified by:

brokersMap in interface ClusterInstance

rollingBrokerRestart

public void rollingBrokerRestart()

Specified by:

rollingBrokerRestart in interface ClusterInstance

killAllBrokers

public void killAllBrokers()

Specified by:

killAllBrokers in interface ClusterInstance

metadataImage

public Map<Integer, org.apache.kafka.image.MetadataImage> metadataImage()

brokers

public Map<Integer, kafka.server.KafkaBroker> brokers()

Specified by:

brokers in interface ClusterInstance

controllers

public Map<Integer, kafka.server.ControllerServer> controllers()

Specified by:

controllers in interface ClusterInstance

format

public void format()
            throws Exception

Throws:

Exception

interBrokerPortFuture

public scala.Option<CompletableFuture<Integer>> interBrokerPortFuture()