io.axual.client

Class AxualClient

java.lang.Object

io.axual.client.AxualClient

All Implemented Interfaces:

java.lang.AutoCloseable

public class AxualClient
extends java.lang.Object
implements java.lang.AutoCloseable

The AxualClient class represents a client application's connection to Axual Platform. Through this class the application can create Producers and Consumers to send/receive messages. The general assumption is that an application only requires one instance of this class, which is configured by passing a ClientConfig object to the constructor. The configuration passed in is automatically applied to all created Producers and Consumers.

Constructor Summary

Constructors

Constructor and Description
AxualClient(io.axual.common.config.ClientConfig config) Instantiates a new Axual client with given configuration.

Method Summary

Modifier and Type	Method and Description
<K,V> Consumer<K,V>	buildConsumer(ConsumerConfig<K,V> consumerConfig, Processor<K,V> processor) Build a new Consumer with any key/value type.
Consumer<org.apache.avro.generic.GenericRecord,org.apache.avro.generic.GenericRecord>	buildConsumer(GenericAvroConsumerConfig consumerConfig, Processor<org.apache.avro.generic.GenericRecord,org.apache.avro.generic.GenericRecord> processor) Build a new Consumer that consumes generic Avro messages.
<K extends org.apache.avro.specific.SpecificRecord,V extends org.apache.avro.specific.SpecificRecord> Consumer<K,V>	buildConsumer(SpecificAvroConsumerConfig<K,V> consumerConfig, Processor<K,V> processor) Build a new Consumer that consumes specific Avro messages.
Producer<org.apache.avro.generic.GenericRecord,org.apache.avro.generic.GenericRecord>	buildProducer(GenericAvroProducerConfig producerConfig) Build a new Producer that produces generic Avro messages.
<K,V> Producer<K,V>	buildProducer(ProducerConfig<K,V> producerConfig) Build a new Producer with any key/value type.
<K extends org.apache.avro.specific.SpecificRecord,V extends org.apache.avro.specific.SpecificRecord> Producer<K,V>	buildProducer(SpecificAvroProducerConfig<K,V> producerConfig) Build a new Producer that produces specific Avro messages.
void	close()
io.axual.common.config.ClientConfig	getConfig() Gets the client configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

AxualClient

public AxualClient(io.axual.common.config.ClientConfig config)

Instantiates a new Axual client with given configuration.

Parameters:

config - the configuration of the application's connection to Axual Platform.

Method Detail

getConfig

public io.axual.common.config.ClientConfig getConfig()

Gets the client configuration.

Returns:

the configuration

buildConsumer

public <K,V> Consumer<K,V> buildConsumer(ConsumerConfig<K,V> consumerConfig,
                                         Processor<K,V> processor)

Build a new Consumer with any key/value type.

Type Parameters:

K - the key type of consumed messages

V - the value type of consumed messages

Parameters:

consumerConfig - the consumer configuration

processor - the processor that receives callbacks for every message received

Returns:

the consumer

buildConsumer

public Consumer<org.apache.avro.generic.GenericRecord,org.apache.avro.generic.GenericRecord> buildConsumer(GenericAvroConsumerConfig consumerConfig,
                                                                                                           Processor<org.apache.avro.generic.GenericRecord,org.apache.avro.generic.GenericRecord> processor)

Build a new Consumer that consumes generic Avro messages.

Parameters:

consumerConfig - the consumer configuration

processor - the processor that receives callbacks for every message received

Returns:

the consumer

buildConsumer

public <K extends org.apache.avro.specific.SpecificRecord,V extends org.apache.avro.specific.SpecificRecord> Consumer<K,V> buildConsumer(SpecificAvroConsumerConfig<K,V> consumerConfig,
                                                                                                                                         Processor<K,V> processor)

Build a new Consumer that consumes specific Avro messages.

Type Parameters:

K - the specific key type of consumed Avro messages

V - the specific value type of consumed Avro messages

Parameters:

consumerConfig - the consumer configuration

processor - the processor that receives callbacks for every message received

Returns:

the consumer

buildProducer

public <K,V> Producer<K,V> buildProducer(ProducerConfig<K,V> producerConfig)

Build a new Producer with any key/value type.

Type Parameters:

K - the key type of produced messages

V - the value type of produced messages

Parameters:

producerConfig - An instance of ProducerConfig containing the necessary configuration to create this producer

Returns:

the producer

buildProducer

public Producer<org.apache.avro.generic.GenericRecord,org.apache.avro.generic.GenericRecord> buildProducer(GenericAvroProducerConfig producerConfig)

Build a new Producer that produces generic Avro messages.

Parameters:

producerConfig - An instance of GenericAvroProducerConfig containing the necessary configuration to create this producer

Returns:

the producer

buildProducer

public <K extends org.apache.avro.specific.SpecificRecord,V extends org.apache.avro.specific.SpecificRecord> Producer<K,V> buildProducer(SpecificAvroProducerConfig<K,V> producerConfig)

Build a new Producer that produces specific Avro messages.

Type Parameters:

K - the specific key type of produced Avro messages

V - the specific value type of produced Avro messages

Parameters:

producerConfig - An instance of SpecificAvroProducerConfig containing the necessary configuration to create this producer

Returns:

Producer

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable