io.micronaut.configuration.kafka.scope

Class KafkaClientScope

java.lang.Object

io.micronaut.configuration.kafka.scope.KafkaClientScope

All Implemented Interfaces:

KafkaProducerRegistry, LifeCycle<KafkaClientScope>, CustomScope<KafkaClient>, Closeable, AutoCloseable

@Singleton
public class KafkaClientScope
extends Object
implements CustomScope<KafkaClient>, LifeCycle<KafkaClientScope>, KafkaProducerRegistry

A scope implementation for injecting KafkaProducer instances.

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors

Constructor and Description
KafkaClientScope(BeanContext beanContext, SerdeRegistry serdeRegistry) Constructs a new client scope.

Method Summary

Modifier and Type	Method and Description
Class<KafkaClient>	annotationType()
<T> T	get(BeanResolutionContext resolutionContext, BeanDefinition<T> beanDefinition, BeanIdentifier identifier, Provider<T> provider) Resolve an object from the given scope.
<K,V> KafkaProducer	getProducer(String id, Argument<K> keyType, Argument<V> valueType) Returns a managed Producer.
boolean	isRunning()
<T> Optional<T>	remove(BeanIdentifier identifier) Remove a bean definition from the scope.
KafkaClientScope	stop() Stops the life cycle component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.context.scope.CustomScope

findBeanRegistration

Methods inherited from interface io.micronaut.context.LifeCycle

close, refresh, start

Constructor Detail

KafkaClientScope

public KafkaClientScope(BeanContext beanContext,
                        SerdeRegistry serdeRegistry)

Constructs a new client scope.

Parameters:

beanContext - The bean context

serdeRegistry - The serde registry

Method Detail

isRunning

public boolean isRunning()

Specified by:

isRunning in interface LifeCycle<KafkaClientScope>

Returns:

Whether the component is running

annotationType

public Class<KafkaClient> annotationType()

Specified by:

annotationType in interface CustomScope<KafkaClient>

Returns:

The scope annotation type

get

public <T> T get(BeanResolutionContext resolutionContext,
                 BeanDefinition<T> beanDefinition,
                 BeanIdentifier identifier,
                 Provider<T> provider)

Description copied from interface: CustomScope

Resolve an object from the given scope.

Specified by:

get in interface CustomScope<KafkaClient>

Type Parameters:

T - The bean generic type

Parameters:

resolutionContext - The bean resolution context

beanDefinition - The bean definition

identifier - The BeanIdentifier

provider - The provider that will build the bean definition

Returns:

The bean instance

getProducer

@Nonnull
public <K,V> KafkaProducer getProducer(String id,
                                                Argument<K> keyType,
                                                Argument<V> valueType)

Description copied from interface: KafkaProducerRegistry

Returns a managed Producer.

Specified by:

getProducer in interface KafkaProducerRegistry

Type Parameters:

K - The key generic type

V - The value generic type

Parameters:

id - The id of the producer.

keyType - The key type

valueType - The value type

Returns:

The producer

stop

public KafkaClientScope stop()

Description copied from interface: LifeCycle

Stops the life cycle component.

Specified by:

stop in interface LifeCycle<KafkaClientScope>

Returns:

This lifecycle component

remove

public <T> Optional<T> remove(BeanIdentifier identifier)

Description copied from interface: CustomScope

Remove a bean definition from the scope.

Specified by:

remove in interface CustomScope<KafkaClient>

Type Parameters:

T - The generic type

Parameters:

identifier - The BeanIdentifier

Returns:

An Optional of the instance if it exists