java.lang.Object
- com.github.ddth.queue.impl.AbstractQueueFactory<T,ID,DATA>
- - com.github.ddth.queue.impl.KafkaQueueFactory<T,ID,DATA>

All Implemented Interfaces:

IQueueFactory<ID,DATA>, AutoCloseable

Direct Known Subclasses:

UniversalKafkaQueueFactory, UniversalKafkaQueueFactory
```
public abstract class KafkaQueueFactory<T extends KafkaQueue<ID,DATA>,ID,DATA>
extends AbstractQueueFactory<T,ID,DATA>
```
Factory to create KafkaQueue instances.

Since:

0.4.1

Author:

Thanh Ba Nguyen

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`SPEC_FIELD_BOOTSTRAP_SERVERS`
`static String`	`SPEC_FIELD_CONSUMER_GROUP_ID`
`static String`	`SPEC_FIELD_CONSUMER_PROPERTIES`
`static String`	`SPEC_FIELD_PRODUCER_PROPERTIES`
`static String`	`SPEC_FIELD_PRODUCER_TYPE`
`static String`	`SPEC_FIELD_SEND_ASYNC`
`static String`	`SPEC_FIELD_TOPIC`

Constructor Summary

Constructors
Constructor Description

KafkaQueueFactory()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`destroy()`
`String`	`getDefaultBootstrapServers()`	Default Kafka bootstrap server list (format `host1:9092,host2:port2,host3:port3`), passed to all queues created by this factory.
`String`	`getDefaultConsumerGroupId()`	Default Kafka group-id to consume messages, passed to all queues created by this factory.
`Properties`	`getDefaultConsumerProps()`	Default custom configuration properties for Kafka consumer, passed to all queues created by this factory.
`protected com.github.ddth.kafka.KafkaClient`	`getDefaultKafkaClient()`	If all `KafkaQueue` instances are connecting to one Kafka broker, it's a good idea to pre-create a `KafkaClient` instance and share it amongst `KafkaQueue` instances created from this factory by assigning it to `defaultKafkaClient` (see `setDefaultKafkaClient(KafkaClient)`).
`Properties`	`getDefaultProducerProps()`	Default custom configuration properties for Kafka producer, passed to all queues created by this factory.
`com.github.ddth.kafka.KafkaClient.ProducerType`	`getDefaultProducerType()`	Default Kafka's producer type, used to send messages (default `KafkaClient.ProducerType.LEADER_ACK`), passed to all queues created by this factory.
`boolean`	`getDefaultSendAsync()`	Should messages sent to Kafka asynchronously (default `true`)?
`String`	`getDefaultTopicName()`	Default name of Kafka topic to store queue messages, passed to all queues created by this factory.
`protected void`	`initQueue(T queue, QueueSpec spec)`	Initialize a newly created queue instance.
`boolean`	`isDefaultSendAsync()`	Should messages sent to Kafka asynchronously (default `true`)?
`void`	`setDefaultBootstrapServers(String defaultBootstrapServers)`	Default Kafka bootstrap server list (format `host1:9092,host2:port2,host3:port3`), passed to all queues created by this factory.
`void`	`setDefaultConsumerGroupId(String defaultConsumerGroupId)`	Default Kafka group-id to consume messages, passed to all queues created by this factory.
`void`	`setDefaultConsumerProps(Properties defaultConsumerProps)`	Default custom configuration properties for Kafka consumer, passed to all queues created by this factory.
`KafkaQueueFactory<T,ID,DATA>`	`setDefaultKafkaClient(com.github.ddth.kafka.KafkaClient kafkaClient)`	If all `KafkaQueue` instances are connecting to one Kafka broker, it's a good idea to pre-create a `KafkaClient` instance and share it amongst `KafkaQueue` instances created from this factory by assigning it to `defaultKafkaClient` (see `setDefaultKafkaClient(KafkaClient)`).
`protected KafkaQueueFactory<T,ID,DATA>`	`setDefaultKafkaClient(com.github.ddth.kafka.KafkaClient kafkaClient, boolean setMyOwnKafkaClient)`	If all `KafkaQueue` instances are connecting to one Kafka broker, it's a good idea to pre-create a `KafkaClient` instance and share it amongst `KafkaQueue` instances created from this factory by assigning it to `defaultKafkaClient` (see `setDefaultKafkaClient(KafkaClient)`).
`void`	`setDefaultProducerProps(Properties defaultProducerProps)`	Default custom configuration properties for Kafka producer, passed to all queues created by this factory.
`void`	`setDefaultProducerType(com.github.ddth.kafka.KafkaClient.ProducerType defaultProducerType)`	Default Kafka's producer type, used to send messages (default `KafkaClient.ProducerType.LEADER_ACK`), passed to all queues created by this factory.
`void`	`setDefaultSendAsync(boolean defaultSendAsync)`	Should messages sent to Kafka asynchronously (default `true`)?
`void`	`setDefaultTopicName(String defaultTopicName)`	Default name of Kafka topic to store queue messages, passed to all queues created by this factory.

Methods inherited from class com.github.ddth.queue.impl.AbstractQueueFactory
close, createAndInitQueue, createQueueInstance, getDefaultEphemeralDisabled, getDefaultEphemeralMaxSize, getDefaultMaxSize, getQueue, init, isDefaultEphemeralDisabled, setDefaultEphemeralDisabled, setDefaultEphemeralMaxSize, setDefaultMaxSize

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SPEC_FIELD_BOOTSTRAP_SERVERS
```
public static final String SPEC_FIELD_BOOTSTRAP_SERVERS
```
    See Also:
    
    Constant Field Values
  - SPEC_FIELD_TOPIC
```
public static final String SPEC_FIELD_TOPIC
```
    See Also:
    
    Constant Field Values
  - SPEC_FIELD_CONSUMER_GROUP_ID
```
public static final String SPEC_FIELD_CONSUMER_GROUP_ID
```
    See Also:
    
    Constant Field Values
  - SPEC_FIELD_PRODUCER_TYPE
```
public static final String SPEC_FIELD_PRODUCER_TYPE
```
    See Also:
    
    Constant Field Values
  - SPEC_FIELD_PRODUCER_PROPERTIES
```
public static final String SPEC_FIELD_PRODUCER_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - SPEC_FIELD_CONSUMER_PROPERTIES
```
public static final String SPEC_FIELD_CONSUMER_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - SPEC_FIELD_SEND_ASYNC
```
public static final String SPEC_FIELD_SEND_ASYNC
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - KafkaQueueFactory
```
public KafkaQueueFactory()
```
- Method Detail
  - getDefaultBootstrapServers
```
public String getDefaultBootstrapServers()
```
    Default Kafka bootstrap server list (format host1:9092,host2:port2,host3:port3), passed to all queues created by this factory.
    
    Returns:
    
    Since:
    
    0.6.2
  - setDefaultBootstrapServers
```
public void setDefaultBootstrapServers(String defaultBootstrapServers)
```
    Default Kafka bootstrap server list (format host1:9092,host2:port2,host3:port3), passed to all queues created by this factory.
    
    Parameters:
    
    defaultBootstrapServers -
    
    Since:
    
    0.6.2
  - getDefaultTopicName
```
public String getDefaultTopicName()
```
    Default name of Kafka topic to store queue messages, passed to all queues created by this factory.
    
    Returns:
    
    Since:
    
    0.6.2
  - setDefaultTopicName
```
public void setDefaultTopicName(String defaultTopicName)
```
    Default name of Kafka topic to store queue messages, passed to all queues created by this factory.
    
    Parameters:
    
    defaultTopicName -
    
    Since:
    
    0.6.2
  - getDefaultConsumerGroupId
```
public String getDefaultConsumerGroupId()
```
    Default Kafka group-id to consume messages, passed to all queues created by this factory.
    
    Returns:
    
    Since:
    
    0.6.2
  - setDefaultConsumerGroupId
```
public void setDefaultConsumerGroupId(String defaultConsumerGroupId)
```
    Default Kafka group-id to consume messages, passed to all queues created by this factory.
    
    Parameters:
    
    defaultConsumerGroupId -
    
    Since:
    
    0.6.2
  - getDefaultProducerType
```
public com.github.ddth.kafka.KafkaClient.ProducerType getDefaultProducerType()
```
    Default Kafka's producer type, used to send messages (default KafkaClient.ProducerType.LEADER_ACK), passed to all queues created by this factory.
    
    Returns:
  - setDefaultProducerType
```
public void setDefaultProducerType(com.github.ddth.kafka.KafkaClient.ProducerType defaultProducerType)
```
    Default Kafka's producer type, used to send messages (default KafkaClient.ProducerType.LEADER_ACK), passed to all queues created by this factory.
    
    Parameters:
    
    defaultProducerType -
  - getDefaultProducerProps
```
public Properties getDefaultProducerProps()
```
    Default custom configuration properties for Kafka producer, passed to all queues created by this factory.
    
    Returns:
  - setDefaultProducerProps
```
public void setDefaultProducerProps(Properties defaultProducerProps)
```
    Default custom configuration properties for Kafka producer, passed to all queues created by this factory.
    
    Parameters:
    
    defaultProducerProps -
  - getDefaultConsumerProps
```
public Properties getDefaultConsumerProps()
```
    Default custom configuration properties for Kafka consumer, passed to all queues created by this factory.
    
    Returns:
  - setDefaultConsumerProps
```
public void setDefaultConsumerProps(Properties defaultConsumerProps)
```
    Default custom configuration properties for Kafka consumer, passed to all queues created by this factory.
    
    Parameters:
    
    defaultConsumerProps -
  - isDefaultSendAsync
```
public boolean isDefaultSendAsync()
```
    Should messages sent to Kafka asynchronously (default true)?
    
    Returns:
    
    Since:
    
    0.6.2
  - getDefaultSendAsync
```
public boolean getDefaultSendAsync()
```
    Should messages sent to Kafka asynchronously (default true)?
    
    Since:
    
    0.6.2
  - setDefaultSendAsync
```
public void setDefaultSendAsync(boolean defaultSendAsync)
```
    Should messages sent to Kafka asynchronously (default true)?
    
    Parameters:
    
    defaultSendAsync -
    
    Since:
    
    0.6.2
  - getDefaultKafkaClient
```
protected com.github.ddth.kafka.KafkaClient getDefaultKafkaClient()
```
    If all KafkaQueue instances are connecting to one Kafka broker, it's a good idea to pre-create a KafkaClient instance and share it amongst KafkaQueue instances created from this factory by assigning it to defaultKafkaClient (see setDefaultKafkaClient(KafkaClient)).
    
    Returns:
    
    Since:
    
    0.7.1
  - setDefaultKafkaClient
```
protected KafkaQueueFactory<T,ID,DATA> setDefaultKafkaClient(com.github.ddth.kafka.KafkaClient kafkaClient,
                                                                         boolean setMyOwnKafkaClient)
```
    If all KafkaQueue instances are connecting to one Kafka broker, it's a good idea to pre-create a KafkaClient instance and share it amongst KafkaQueue instances created from this factory by assigning it to defaultKafkaClient (see setDefaultKafkaClient(KafkaClient)).
    
    Parameters:
    
    kafkaClient -
    
    setMyOwnKafkaClient -
    
    Returns:
    
    Since:
    
    0.7.1
  - setDefaultKafkaClient
```
public KafkaQueueFactory<T,ID,DATA> setDefaultKafkaClient(com.github.ddth.kafka.KafkaClient kafkaClient)
```
    If all KafkaQueue instances are connecting to one Kafka broker, it's a good idea to pre-create a KafkaClient instance and share it amongst KafkaQueue instances created from this factory by assigning it to defaultKafkaClient (see setDefaultKafkaClient(KafkaClient)).
    
    Parameters:
    
    kafkaClient -
    
    Returns:
    
    Since:
    
    0.7.1
  - destroy
```
public void destroy()
```
    Overrides:
    
    destroy in class AbstractQueueFactory<T extends KafkaQueue<ID,DATA>,ID,DATA>
    
    Since:
    
    0.7.1
  - initQueue
```
protected void initQueue(T queue,
                         QueueSpec spec)
                  throws Exception
```
    Initialize a newly created queue instance.
    Called by AbstractQueueFactory.createAndInitQueue(QueueSpec). Sub-class may override this method to implement its own business logic.
    
    Overrides:
    
    initQueue in class AbstractQueueFactory<T extends KafkaQueue<ID,DATA>,ID,DATA>
    
    Throws:
    
    Exception

Class KafkaQueueFactory<T extends KafkaQueue<ID,​DATA>,​ID,​DATA>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.github.ddth.queue.impl.AbstractQueueFactory

Methods inherited from class java.lang.Object

Field Detail

SPEC_FIELD_BOOTSTRAP_SERVERS

SPEC_FIELD_TOPIC

SPEC_FIELD_CONSUMER_GROUP_ID

SPEC_FIELD_PRODUCER_TYPE

SPEC_FIELD_PRODUCER_PROPERTIES

SPEC_FIELD_CONSUMER_PROPERTIES

SPEC_FIELD_SEND_ASYNC

Constructor Detail

KafkaQueueFactory

Method Detail

getDefaultBootstrapServers

setDefaultBootstrapServers

getDefaultTopicName

setDefaultTopicName

getDefaultConsumerGroupId

setDefaultConsumerGroupId

getDefaultProducerType

setDefaultProducerType

getDefaultProducerProps

setDefaultProducerProps

getDefaultConsumerProps

setDefaultConsumerProps

isDefaultSendAsync

getDefaultSendAsync

setDefaultSendAsync

getDefaultKafkaClient

setDefaultKafkaClient

setDefaultKafkaClient

destroy

initQueue

Class KafkaQueueFactory<T extends KafkaQueue<ID,DATA>,ID,DATA>