io.micronaut.pulsar.annotation

Annotation Type PulsarReader

@Documented
 @Retention(value=RUNTIME)
 @Target(value={PARAMETER,FIELD,METHOD})
 @Around
 @Introduction
public @interface PulsarReader

Create and inject Pulsar reader into field.

Since:

1.0

Author:

Haris Secic

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
org.apache.pulsar.common.schema.KeyValueEncodingType	keyEncoding If argument annotated with PulsarReader is of KeyValue it's possible to choose where to get the message key from.
MessageSchema	keySchema If argument annotated with PulsarReader is of KeyValue it's possible to choose different schema for key transfer.
String	readerName
@Min(value=0L) int	readTimeout Ignored on Reader.readNextAsync().
MessageSchema	schema Defaults to MessageSchema.BYTES as default value for Pulsar Schema is byte[].
boolean	startMessageLatest
boolean	subscribeAsync By default, reader should subscribe in non-blocking manner using default CompletableFuture of ConsumerBuilder.subscribeAsync().
String	subscriptionName
TimeUnit	timeoutUnit Ignored on Reader.readNextAsync() or if readTimeout() is 0.
@Pattern(regexp="((non-)?persistent://)?((\\w+(-|\\w+)*\\w/)|(\\$\\{tenant\\}))(\\w+(-|\\w+)*\\w/)\\w+(-|\\w+)*\\w") String	topic Only single topic subscription possible for readers.
String	value

Element Detail

value

@AliasFor(member="topic") @AliasFor(annotation=io.micronaut.messaging.annotation.MessageMapping.class,member="value")
public abstract String value

Returns:

topic name to listen to

See Also:

topic()

Default:

""

topic

@AliasFor(member="value") @AliasFor(annotation=io.micronaut.messaging.annotation.MessageMapping.class,member="value")
 @Pattern(regexp="((non-)?persistent://)?((\\w+(-|\\w+)*\\w/)|(\\$\\{tenant\\}))(\\w+(-|\\w+)*\\w/)\\w+(-|\\w+)*\\w")
public abstract @Pattern(regexp="((non-)?persistent://)?((\\w+(-|\\w+)*\\w/)|(\\$\\{tenant\\}))(\\w+(-|\\w+)*\\w/)\\w+(-|\\w+)*\\w") String topic

Only single topic subscription possible for readers.

Returns:

topic name to listen to

Default:

""

subscriptionName

public abstract String subscriptionName

Returns:

Subscription to connect to.

Default:

""

schema

public abstract MessageSchema schema

Defaults to MessageSchema.BYTES as default value for Pulsar Schema is byte[].

Returns:

Schema to use with pulsar topic consumer

Default:

io.micronaut.pulsar.MessageSchema.BYTES

keySchema

public abstract MessageSchema keySchema

If argument annotated with PulsarReader is of KeyValue it's possible to choose different schema for key transfer.

Returns:

Schema to use while parsing message key from Pulsar message

Default:

io.micronaut.pulsar.MessageSchema.BYTES

keyEncoding

public abstract org.apache.pulsar.common.schema.KeyValueEncodingType keyEncoding

If argument annotated with PulsarReader is of KeyValue it's possible to choose where to get the message key from. Otherwise, this attribute is ignored.

Returns:

Whether to read key from the message payload or separately.

Default:

org.apache.pulsar.common.schema.KeyValueEncodingType.INLINE

readerName

public abstract String readerName

Returns:

Reader name.

Default:

""

subscribeAsync

public abstract boolean subscribeAsync

By default, reader should subscribe in non-blocking manner using default CompletableFuture of ConsumerBuilder.subscribeAsync().

If blocking is set to false, application thread initializing it will block until consumer is successfully subscribed.

Returns:

Should the consumer subscribe in async manner or blocking

Default:

true

startMessageLatest

public abstract boolean startMessageLatest

Returns:

Whether to position reader to the newest available message in queue or not.

Default:

true

readTimeout

@Min(value=0L)
public abstract @Min(value=0L) int readTimeout

Ignored on Reader.readNextAsync(). Use -1 for no timeout (default).

Returns:

Maximum allowed read time.

Default:

0

timeoutUnit

public abstract TimeUnit timeoutUnit

Ignored on Reader.readNextAsync() or if readTimeout() is 0.

Returns:

Time unit for readTimeout().

Default:

java.util.concurrent.TimeUnit.SECONDS