EmbeddedKafka

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. object aKafkaProducer

   

   Definition Classes

   EmbeddedKafkaSupport

5. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

6. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

7. def consumeFirstMessageFrom[T](topic: String, autoCommit: Boolean = false)(implicit config: EmbeddedKafkaConfig, deserializer: Deserializer[T]): T

   

   Consumes the first message available in a given topic, deserializing it as type T.

   Consumes the first message available in a given topic, deserializing it as type T.

   Only the message that is returned is committed if autoCommit is false. If autoCommit is true then all messages that were polled will be committed.

   topic

   the topic to consume a message from

   autoCommit

   if false, only the offset for the consumed message will be commited. if true, the offset for the last polled message will be committed instead. Defaulted to false.

   config

   an implicit EmbeddedKafkaConfig

   deserializer

   an implicit org.apache.kafka.common.serialization.Deserializer for the type T

   returns

   the first message consumed from the given topic, with a type T

   Definition Classes

   EmbeddedKafkaSupport

   Annotations

   @throws( classOf[TimeoutException] ) @throws( classOf[KafkaUnavailableException] )

   Exceptions thrown

   KafkaUnavailableException if unable to connect to Kafka

   TimeoutException if unable to consume a message within 5 seconds

8. def consumeFirstStringMessageFrom(topic: String, autoCommit: Boolean = false)(implicit config: EmbeddedKafkaConfig): String

   

   Definition Classes

   EmbeddedKafkaSupport

9. def consumeNumberMessagesFrom[T](topic: String, number: Int, autoCommit: Boolean = false)(implicit config: EmbeddedKafkaConfig, deserializer: Deserializer[T]): List[T]

   

   Definition Classes

   EmbeddedKafkaSupport

10. def consumeNumberMessagesFromTopics[T](topics: Set[String], number: Int, autoCommit: Boolean = false, timeout: Duration = 5.seconds, resetTimeoutOnEachMessage: Boolean = true)(implicit config: EmbeddedKafkaConfig, deserializer: Deserializer[T]): Map[String, List[T]]

    

    Consumes the first n messages available in given topics, deserializes them as type T, and returns the n messages in a Map from topic name to List[T].

    Consumes the first n messages available in given topics, deserializes them as type T, and returns the n messages in a Map from topic name to List[T].

    Only the messages that are returned are committed if autoCommit is false. If autoCommit is true then all messages that were polled will be committed.

    topics

    the topics to consume messages from

    number

    the number of messages to consume in a batch

    autoCommit

    if false, only the offset for the consumed messages will be commited. if true, the offset for the last polled message will be committed instead. Defaulted to false.

    timeout

    the interval to wait for messages before throwing TimeoutException

    resetTimeoutOnEachMessage

    when true, throw TimeoutException if we have a silent period (no incoming messages) for the timeout interval; when false, throw TimeoutException after the timeout interval if we haven't received all of the expected messages

    config

    an implicit EmbeddedKafkaConfig

    deserializer

    an implicit org.apache.kafka.common.serialization.Deserializer for the type T

    returns

    the List of messages consumed from the given topics, each with a type T

    Definition Classes

    EmbeddedKafkaSupport

    Exceptions thrown

    KafkaUnavailableException if unable to connect to Kafka

    TimeoutException if unable to consume messages within specified timeout

11. def consumeNumberStringMessagesFrom(topic: String, number: Int, autoCommit: Boolean = false)(implicit config: EmbeddedKafkaConfig): List[String]

    

    Definition Classes

    EmbeddedKafkaSupport

12. def createCustomTopic(topic: String, topicConfig: Map[String, String] = Map.empty, partitions: Int = 1, replicationFactor: Int = 1)(implicit config: EmbeddedKafkaConfig): Unit

    

    Creates a topic with a custom configuration

    Creates a topic with a custom configuration

    topic

    the topic name

    topicConfig

    per topic configuration Map

    partitions

    number of partitions Int

    replicationFactor

    replication factor Int

    config

    an implicit EmbeddedKafkaConfig

    Definition Classes

    EmbeddedKafkaSupport

13. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

14. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

15. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

16. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

17. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

18. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

19. def isRunning: Boolean

    

    Returns whether the in memory Kafka and Zookeeper are running.

20. def kafkaConsumer[K, T](implicit config: EmbeddedKafkaConfig, keyDeserializer: Deserializer[K], deserializer: Deserializer[T]): KafkaConsumer[K, T]

    

    Definition Classes

    EmbeddedKafkaSupport

21. def kafkaProducer[K, T](topic: String, key: K, message: T)(implicit config: EmbeddedKafkaConfig, keySerializer: Serializer[K], serializer: Serializer[T]): KafkaProducer[K, T]

    

    Definition Classes

    EmbeddedKafkaSupport

22. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

23. final def notify(): Unit

    

    Definition Classes

    AnyRef

24. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

25. def publishStringMessageToKafka(topic: String, message: String)(implicit config: EmbeddedKafkaConfig): Unit

    

    Publishes synchronously a message of type String to the running Kafka broker.

    Publishes synchronously a message of type String to the running Kafka broker.

    topic

    the topic to which publish the message (it will be auto-created)

    message

    the String message to publish

    config

    an implicit EmbeddedKafkaConfig

    Definition Classes

    EmbeddedKafkaSupport

    Exceptions thrown

    KafkaUnavailableException if unable to connect to Kafka

    See also

    EmbeddedKafka#publishToKafka

26. def publishToKafka[K, T](topic: String, key: K, message: T)(implicit config: EmbeddedKafkaConfig, keySerializer: Serializer[K], serializer: Serializer[T]): Unit

    

    Publishes synchronously a message to the running Kafka broker.

    Publishes synchronously a message to the running Kafka broker.

    topic

    the topic to which publish the message (it will be auto-created)

    key

    the key of type K to publish

    message

    the message of type T to publish

    config

    an implicit EmbeddedKafkaConfig

    serializer

    an implicit Serializer for the type T

    Definition Classes

    EmbeddedKafkaSupport

    Annotations

    @throws( classOf[KafkaUnavailableException] )

    Exceptions thrown

    KafkaUnavailableException if unable to connect to Kafka

27. def publishToKafka[T](topic: String, message: T)(implicit config: EmbeddedKafkaConfig, serializer: Serializer[T]): Unit

    

    Publishes synchronously a message to the running Kafka broker.

    Publishes synchronously a message to the running Kafka broker.

    topic

    the topic to which publish the message (it will be auto-created)

    message

    the message of type T to publish

    config

    an implicit EmbeddedKafkaConfig

    serializer

    an implicit Serializer for the type T

    Definition Classes

    EmbeddedKafkaSupport

    Annotations

    @throws( classOf[KafkaUnavailableException] )

    Exceptions thrown

    KafkaUnavailableException if unable to connect to Kafka

28. def start()(implicit config: EmbeddedKafkaConfig): Unit

    

    Starts a ZooKeeper instance and a Kafka broker in memory, using temporary directories for storing logs.

    Starts a ZooKeeper instance and a Kafka broker in memory, using temporary directories for storing logs. The log directories will be cleaned after calling the stop() method or on JVM exit, whichever happens earlier.

    config

    an implicit EmbeddedKafkaConfig

29. def startKafka(kafkaLogDir: Directory)(implicit config: EmbeddedKafkaConfig): Unit

    

    Starts a Kafka broker in memory, storing logs in a specific location.

    Starts a Kafka broker in memory, storing logs in a specific location.

    kafkaLogDir

    the path for the Kafka logs

    config

    an implicit EmbeddedKafkaConfig

30. def startKafka(config: EmbeddedKafkaConfig, kafkaLogDir: Directory): KafkaServer

    

    Definition Classes

    EmbeddedKafkaSupport

31. def startZooKeeper(zkLogsDir: Directory)(implicit config: EmbeddedKafkaConfig): Unit

    

    Starts a Zookeeper instance in memory, storing logs in a specific location.

    Starts a Zookeeper instance in memory, storing logs in a specific location.

    zkLogsDir

    the path for the Zookeeper logs

    config

    an implicit EmbeddedKafkaConfig

32. def startZooKeeper(zooKeeperPort: Int, zkLogsDir: Directory): ServerCnxnFactory

    

    Definition Classes

    EmbeddedKafkaSupport

33. def stop(): Unit

    

    Stops the in memory ZooKeeper instance and Kafka broker, and deletes the log directories.

34. def stopKafka(): Unit

    

    Stops the in memory Kafka instance, preserving the logs directory.

35. def stopZooKeeper(): Unit

    

    Stops the in memory Zookeeper instance, preserving the logs directory.

36. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

37. def toString(): String

    

    Definition Classes

    AnyRef → Any

38. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

39. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

40. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

41. def withRunningKafka[T](body: ⇒ T)(implicit config: EmbeddedKafkaConfig): T

    

    Starts a ZooKeeper instance and a Kafka broker, then executes the body passed as a parameter.

    Starts a ZooKeeper instance and a Kafka broker, then executes the body passed as a parameter.

    body

    the function to execute

    config

    an implicit EmbeddedKafkaConfig

    Definition Classes

    EmbeddedKafkaSupport

42. def withRunningKafkaOnFoundPort[T](config: EmbeddedKafkaConfig)(body: (EmbeddedKafkaConfig) ⇒ T): T

    

    Starts a ZooKeeper instance and a Kafka broker, then executes the body passed as a parameter.

    Starts a ZooKeeper instance and a Kafka broker, then executes the body passed as a parameter. The actual ZooKeeper and Kafka ports will be detected and inserted into a copied version of the EmbeddedKafkaConfig that gets passed to body. This is useful if you set either or both port to 0, which will listen on an arbitrary available port.

    config

    the user-defined EmbeddedKafkaConfig

    body

    the function to execute, given an EmbeddedKafkaConfig with the actual ports Kafka and ZooKeeper are running on

    Definition Classes

    EmbeddedKafkaSupport

43. val zkConnectionTimeoutMs: Int

    

    Definition Classes

    EmbeddedKafkaSupport

44. val zkSecurityEnabled: Boolean

    

    Definition Classes

    EmbeddedKafkaSupport

45. val zkSessionTimeoutMs: Int

    

    Definition Classes

    EmbeddedKafkaSupport