Trait/Object

net.manub.embeddedkafka

EmbeddedKafka

Related Docs: object EmbeddedKafka | package embeddedkafka

Permalink

trait EmbeddedKafka extends EmbeddedKafkaSupport[EmbeddedKafkaConfig] with EmbeddedKafkaOps[EmbeddedKafkaConfig, EmbeddedK]

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EmbeddedKafka
  2. EmbeddedKafkaOps
  3. KafkaOps
  4. ZooKeeperOps
  5. ProducerOps
  6. ConsumerOps
  7. AdminOps
  8. EmbeddedKafkaSupport
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object aKafkaProducer

    Permalink
    Definition Classes
    ProducerOps
  5. val adminClientCloseTimeout: FiniteDuration

    Permalink
    Attributes
    protected
    Definition Classes
    AdminOps
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val autoCreateTopics: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    KafkaOps
  8. val brokerId: Short

    Permalink
    Attributes
    protected
    Definition Classes
    KafkaOps
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def consumeFirstKeyedMessageFrom[K, V](topic: String, autoCommit: Boolean = false)(implicit config: EmbeddedKafkaConfig, keyDeserializer: Deserializer[K], valueDeserializer: Deserializer[V]): (K, V)

    Permalink

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

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

    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 committed. if true, the offset for the last polled message will be committed instead. Defaulted to false.

    config

    an implicit EmbeddedKafkaConfig

    keyDeserializer

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

    valueDeserializer

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

    returns

    the first message consumed from the given topic, with a type V)

    Definition Classes
    ConsumerOps
    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

  11. def consumeFirstMessageFrom[V](topic: String, autoCommit: Boolean = false)(implicit config: EmbeddedKafkaConfig, valueDeserializer: Deserializer[V]): V

    Permalink

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

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

    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 committed. if true, the offset for the last polled message will be committed instead. Defaulted to false.

    config

    an implicit EmbeddedKafkaConfig

    valueDeserializer

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

    returns

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

    Definition Classes
    ConsumerOps
    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

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

    Permalink
    Definition Classes
    ConsumerOps
  13. def consumeNumberKeyedMessagesFrom[K, V](topic: String, number: Int, autoCommit: Boolean = false)(implicit config: EmbeddedKafkaConfig, keyDeserializer: Deserializer[K], valueDeserializer: Deserializer[V]): List[(K, V)]

    Permalink
    Definition Classes
    ConsumerOps
  14. def consumeNumberKeyedMessagesFromTopics[K, V](topics: Set[String], number: Int, autoCommit: Boolean = false, timeout: Duration = 5.seconds, resetTimeoutOnEachMessage: Boolean = true)(implicit config: EmbeddedKafkaConfig, keyDeserializer: Deserializer[K], valueDeserializer: Deserializer[V]): Map[String, List[(K, V)]]

    Permalink

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

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

    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 committed. 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

    keyDeserializer

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

    valueDeserializer

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

    returns

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

    Definition Classes
    ConsumerOps
    Exceptions thrown

    KafkaUnavailableException if unable to connect to Kafka

    TimeoutException if unable to consume messages within specified timeout

  15. def consumeNumberMessagesFrom[V](topic: String, number: Int, autoCommit: Boolean = false)(implicit config: EmbeddedKafkaConfig, valueDeserializer: Deserializer[V]): List[V]

    Permalink
    Definition Classes
    ConsumerOps
  16. def consumeNumberMessagesFromTopics[V](topics: Set[String], number: Int, autoCommit: Boolean = false, timeout: Duration = 5.seconds, resetTimeoutOnEachMessage: Boolean = true)(implicit config: EmbeddedKafkaConfig, valueDeserializer: Deserializer[V]): Map[String, List[V]]

    Permalink

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

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

    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 committed. 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

    valueDeserializer

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

    returns

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

    Definition Classes
    ConsumerOps
    Exceptions thrown

    KafkaUnavailableException if unable to connect to Kafka

    TimeoutException if unable to consume messages within specified timeout

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

    Permalink
    Definition Classes
    ConsumerOps
  18. val consumerPollingTimeout: FiniteDuration

    Permalink
    Attributes
    protected
    Definition Classes
    ConsumerOps
  19. def createCustomTopic(topic: String, topicConfig: Map[String, String] = Map.empty, partitions: Int = 1, replicationFactor: Int = 1)(implicit config: EmbeddedKafkaConfig): Unit

    Permalink

    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
    AdminOps
  20. def deleteTopics(topics: List[String])(implicit config: EmbeddedKafkaConfig): Try[Unit]

    Permalink

    Either deletes or marks for deletion a list of topics.

    Either deletes or marks for deletion a list of topics.

    topics

    the topic names

    config

    an implicit EmbeddedKafkaConfig

    Definition Classes
    AdminOps
  21. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  25. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. def kafkaConsumer[K, T](implicit config: EmbeddedKafkaConfig, keyDeserializer: Deserializer[K], deserializer: Deserializer[T]): KafkaConsumer[K, T]

    Permalink
    Definition Classes
    ConsumerOps
  28. def kafkaProducer[K, T](topic: String, key: K, message: T)(implicit config: EmbeddedKafkaConfig, keySerializer: Serializer[K], serializer: Serializer[T]): KafkaProducer[K, T]

    Permalink
    Definition Classes
    ProducerOps
  29. val logCleanerDedupeBufferSize: Int

    Permalink
    Attributes
    protected
    Definition Classes
    KafkaOps
  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. val producerPublishTimeout: FiniteDuration

    Permalink
    Attributes
    protected
    Definition Classes
    ProducerOps
  34. def publishStringMessageToKafka(topic: String, message: String)(implicit config: EmbeddedKafkaConfig): Unit

    Permalink

    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
    ProducerOps
    Exceptions thrown

    KafkaUnavailableException if unable to connect to Kafka

    See also

    EmbeddedKafka#publishToKafka

  35. def publishToKafka[K, T](topic: String, messages: Seq[(K, T)])(implicit config: EmbeddedKafkaConfig, keySerializer: Serializer[K], serializer: Serializer[T]): Unit

    Permalink

    Publishes synchronously a batch of message to the running Kafka broker.

    Publishes synchronously a batch of message to the running Kafka broker.

    topic

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

    messages

    the keys and messages of type T) to publish

    config

    an implicit EmbeddedKafkaConfig

    keySerializer

    an implicit Serializer for the type K

    serializer

    an implicit Serializer for the type T

    Definition Classes
    ProducerOps
    Annotations
    @throws( classOf[KafkaUnavailableException] )
    Exceptions thrown

    KafkaUnavailableException if unable to connect to Kafka

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

    Permalink

    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
    ProducerOps
    Annotations
    @throws( classOf[KafkaUnavailableException] )
    Exceptions thrown

    KafkaUnavailableException if unable to connect to Kafka

  37. def publishToKafka[T](producerRecord: ProducerRecord[String, T])(implicit config: EmbeddedKafkaConfig, serializer: Serializer[T]): Unit

    Permalink

    Publishes synchronously a message to the running Kafka broker.

    Publishes synchronously a message to the running Kafka broker.

    producerRecord

    the producerRecord of type T to publish

    config

    an implicit EmbeddedKafkaConfig

    serializer

    an implicit Serializer for the type T

    Definition Classes
    ProducerOps
    Annotations
    @throws( classOf[KafkaUnavailableException] )
    Exceptions thrown

    KafkaUnavailableException if unable to connect to Kafka

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

    Permalink

    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
    ProducerOps
    Annotations
    @throws( classOf[KafkaUnavailableException] )
    Exceptions thrown

    KafkaUnavailableException if unable to connect to Kafka

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

    Permalink
    Definition Classes
    KafkaOps
  40. def startZooKeeper(zooKeeperPort: Int, zkLogsDir: Directory): ServerCnxnFactory

    Permalink
    Definition Classes
    ZooKeeperOps
  41. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  42. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  43. val topicCreationTimeout: FiniteDuration

    Permalink
    Attributes
    protected
    Definition Classes
    AdminOps
  44. val topicDeletionTimeout: FiniteDuration

    Permalink
    Attributes
    protected
    Definition Classes
    AdminOps
  45. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. def withAdminClient[T](body: (AdminClient) ⇒ T)(implicit config: EmbeddedKafkaConfig): Try[T]

    Permalink

    Creates an AdminClient, then executes the body passed as a parameter.

    Creates an AdminClient, then executes the body passed as a parameter.

    body

    the function to execute

    config

    an implicit EmbeddedKafkaConfig

    Attributes
    protected
    Definition Classes
    AdminOps
  49. def withRunningKafka[T](body: ⇒ T)(implicit config: EmbeddedKafkaConfig): T

    Permalink

    Starts a ZooKeeper instance and a Kafka broker (and performs additional logic, if any), then executes the body passed as a parameter.

    Starts a ZooKeeper instance and a Kafka broker (and performs additional logic, if any), then executes the body passed as a parameter.

    body

    the function to execute

    config

    an implicit EmbeddedKafkaConfig

    Definition Classes
    EmbeddedKafkaSupport
  50. def withRunningKafkaOnFoundPort[T](config: EmbeddedKafkaConfig)(body: (EmbeddedKafkaConfig) ⇒ T): T

    Permalink

    Starts a ZooKeeper instance and a Kafka broker (and performs additional logic, if any), then executes the body passed as a parameter.

    Starts a ZooKeeper instance and a Kafka broker (and performs additional logic, if any), then executes the body passed as a parameter. The actual ports of the servers will be detected and inserted into a copied version of the EmbeddedKafkaConfig that gets passed to body. This is useful if you set any 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 the servers are running on

    Definition Classes
    EmbeddedKafkaSupport
  51. val zkConnectionTimeout: FiniteDuration

    Permalink
    Attributes
    protected
    Definition Classes
    KafkaOps
  52. val zkConnectionTimeoutMs: Int

    Permalink
    Definition Classes
    AdminOps
  53. val zkSessionTimeoutMs: Int

    Permalink
    Definition Classes
    AdminOps

Inherited from EmbeddedKafkaOps[EmbeddedKafkaConfig, EmbeddedK]

Inherited from KafkaOps

Inherited from ZooKeeperOps

Inherited from AdminOps[EmbeddedKafkaConfig]

Inherited from EmbeddedKafkaSupport[EmbeddedKafkaConfig]

Inherited from AnyRef

Inherited from Any

Ungrouped