io.micronaut.pulsar.config

Class DefaultPulsarClientConfiguration

java.lang.Object

io.micronaut.pulsar.config.AbstractPulsarConfiguration

io.micronaut.pulsar.config.DefaultPulsarClientConfiguration

All Implemented Interfaces:

PulsarClientConfiguration

@ConfigurationProperties(value="pulsar")
 @Requires(value="pulsar") @Requires(missingBeans=PulsarClientConfiguration.class)
public final class DefaultPulsarClientConfiguration
extends AbstractPulsarConfiguration
implements PulsarClientConfiguration

Default properties holder for Pulsar client configuration.

Since:

1.0

Author:

Haris Secic

Field Summary

Fields inherited from class io.micronaut.pulsar.config.AbstractPulsarConfiguration

DEFAULT_BOOTSTRAP_SERVER, DEFAULT_PULSAR_AUTHENTICATION, DEFAULT_PULSAR_MESSAGING_PORT, DEFAULT_SERVER_HOST_ADDRESS, PREFIX, TENANT_NAME_VALIDATOR, TOPIC_NAME_PATTERN_VALIDATOR, TOPIC_NAME_VALIDATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultPulsarClientConfiguration(io.micronaut.context.env.Environment environment, Optional<org.apache.pulsar.client.api.ServiceUrlProvider> serviceUrlProvider) Constructs the default Pulsar Client configuration.

Method Summary

Modifier and Type	Method and Description
org.apache.pulsar.client.api.Authentication	getAuthentication()
int	getDefaultMaxRetryDlq()
Optional<String>	getDefaultTenant()
Optional<Integer>	getIoThreads()
Optional<Integer>	getListenerThreads()
Optional<String>	getOauthAudience() Must be set for usage with the OAuth2 authentication.
Optional<URL>	getOauthCredentialsUrl()
URL	getOauthIssuerUrl()
String	getServiceUrl()
Optional<org.apache.pulsar.client.api.ServiceUrlProvider>	getServiceUrlProvider()
boolean	getShutdownOnSubscriberError()
Optional<String>	getSslProvider()
Optional<Boolean>	getTlsAllowInsecureConnection()
Optional<String>	getTlsCertFilePath()
Optional<Set<String>>	getTlsCiphers()
Optional<Set<String>>	getTlsProtocols()
Optional<String>	getTlsTrustStorePath()
Optional<Boolean>	getTlsVerifyHostname()
Boolean	getUseDeadLetterQueue()
void	setAuthenticationJwt(String authenticationJwt)
void	setDefaultMaxRetryDlq(int defaultMaxRetryDlq) If not set defaults to 3.
void	setDefaultTenant(String defaultTenant) Use in combination with ${tenant} placeholder in PulsarConsumer.topic(), PulsarConsumer.topics(), PulsarConsumer.topicsPattern(), PulsarReader.topic(), PulsarProducer.topic() to avoid hardcoding tenant name into source code through mentioned annotations.
void	setIoThreads(Integer ioThreads)
void	setListenerThreads(Integer listenerThreads)
void	setOauthAudience(String oauthAudience)
void	setOauthCredentialsUrl(URL oauthCredentialsUrl)
void	setOauthIssuerUrl(URL oauthIssuerUrl)
void	setServiceUrl(String serviceUrl)
void	setShutdownOnSubscriberError(Boolean shutdownOnSubscriberError)
void	setSslProvider(String sslProvider) Defaults to default JVM provider.
void	setTlsAllowInsecureConnection(Boolean tlsAllowInsecureConnection)
void	setTlsCertFilePath(String tlsCertFilePath)
void	setTlsCiphers(Set<String> tlsCiphers)
void	setTlsProtocols(Set<String> tlsProtocols)
void	setTlsTrustStorePath(String tlsTrustStorePath)
void	setTlsVerifyHostname(Boolean tlsVerifyHostname)
void	setUseDeadLetterQueue(Boolean useDeadLetterQueue) If not set defaults to true which means that after max number of retries failed message is sent to DLQ and won't be resent again.

Methods inherited from class io.micronaut.pulsar.config.AbstractPulsarConfiguration

getConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPulsarClientConfiguration

protected DefaultPulsarClientConfiguration(io.micronaut.context.env.Environment environment,
                                           @PulsarServiceUrlProvider
                                           Optional<org.apache.pulsar.client.api.ServiceUrlProvider> serviceUrlProvider)

Constructs the default Pulsar Client configuration.

Parameters:

environment - Environment

serviceUrlProvider - Pulsars service URL provider

Method Detail

getIoThreads

public Optional<Integer> getIoThreads()

Specified by:

getIoThreads in interface PulsarClientConfiguration

setIoThreads

public void setIoThreads(Integer ioThreads)

Parameters:

ioThreads - Number of threads to use with read operations

getListenerThreads

public Optional<Integer> getListenerThreads()

Specified by:

getListenerThreads in interface PulsarClientConfiguration

setListenerThreads

public void setListenerThreads(Integer listenerThreads)

Parameters:

listenerThreads - Number of threads to use with message example.java.listeners.

setAuthenticationJwt

public void setAuthenticationJwt(@Nullable
                                 String authenticationJwt)

getSslProvider

public Optional<String> getSslProvider()

Specified by:

getSslProvider in interface PulsarClientConfiguration

setTlsTrustStorePath

public void setTlsTrustStorePath(String tlsTrustStorePath)

getTlsTrustStorePath

public Optional<String> getTlsTrustStorePath()

Specified by:

getTlsTrustStorePath in interface PulsarClientConfiguration

setTlsCertFilePath

public void setTlsCertFilePath(String tlsCertFilePath)

getTlsCertFilePath

public Optional<String> getTlsCertFilePath()

Specified by:

getTlsCertFilePath in interface PulsarClientConfiguration

setTlsVerifyHostname

public void setTlsVerifyHostname(Boolean tlsVerifyHostname)

getTlsVerifyHostname

public Optional<Boolean> getTlsVerifyHostname()

Specified by:

getTlsVerifyHostname in interface PulsarClientConfiguration

setTlsAllowInsecureConnection

public void setTlsAllowInsecureConnection(Boolean tlsAllowInsecureConnection)

getTlsAllowInsecureConnection

public Optional<Boolean> getTlsAllowInsecureConnection()

Specified by:

getTlsAllowInsecureConnection in interface PulsarClientConfiguration

setTlsCiphers

public void setTlsCiphers(Set<String> tlsCiphers)

getTlsCiphers

public Optional<Set<String>> getTlsCiphers()

Specified by:

getTlsCiphers in interface PulsarClientConfiguration

setTlsProtocols

public void setTlsProtocols(Set<String> tlsProtocols)

getTlsProtocols

public Optional<Set<String>> getTlsProtocols()

Specified by:

getTlsProtocols in interface PulsarClientConfiguration

setSslProvider

public void setSslProvider(String sslProvider)

Defaults to default JVM provider.

Parameters:

sslProvider - The name of the security provider used for SSL connections.

getServiceUrl

public String getServiceUrl()

Specified by:

getServiceUrl in interface PulsarClientConfiguration

Returns:

Apache Pulsar cluster address (IP or domain or hostname + port)

setServiceUrl

public void setServiceUrl(@Nullable
                          String serviceUrl)

Parameters:

serviceUrl - URL to Pulsar cluster

getServiceUrlProvider

public Optional<org.apache.pulsar.client.api.ServiceUrlProvider> getServiceUrlProvider()

Specified by:

getServiceUrlProvider in interface PulsarClientConfiguration

getAuthentication

public org.apache.pulsar.client.api.Authentication getAuthentication()

Specified by:

getAuthentication in interface PulsarClientConfiguration

getShutdownOnSubscriberError

public boolean getShutdownOnSubscriberError()

Specified by:

getShutdownOnSubscriberError in interface PulsarClientConfiguration

setShutdownOnSubscriberError

public void setShutdownOnSubscriberError(Boolean shutdownOnSubscriberError)

Parameters:

shutdownOnSubscriberError - should application shutdown if any of subscriptions fail

getOauthAudience

public Optional<String> getOauthAudience()

Must be set for usage with the OAuth2 authentication.

Returns:

String representing client application willing to listen to

setOauthAudience

public void setOauthAudience(String oauthAudience)

Parameters:

oauthAudience - OAuth2 audience

getOauthCredentialsUrl

public Optional<URL> getOauthCredentialsUrl()

setOauthCredentialsUrl

public void setOauthCredentialsUrl(URL oauthCredentialsUrl)

Parameters:

oauthCredentialsUrl - URL or a path to a file containing client id, client secret, and such for OAuth2 client application.

getOauthIssuerUrl

public URL getOauthIssuerUrl()

setOauthIssuerUrl

public void setOauthIssuerUrl(URL oauthIssuerUrl)

Parameters:

oauthIssuerUrl - URL of the OAuth2 Token issuer

getUseDeadLetterQueue

public Boolean getUseDeadLetterQueue()

setUseDeadLetterQueue

public void setUseDeadLetterQueue(Boolean useDeadLetterQueue)

If not set defaults to true which means that after max number of retries failed message is sent to DLQ and won't be resent again.

Parameters:

useDeadLetterQueue - Use DLQ for Pulsar Consumers by default or not.

getDefaultMaxRetryDlq

public int getDefaultMaxRetryDlq()

setDefaultMaxRetryDlq

public void setDefaultMaxRetryDlq(int defaultMaxRetryDlq)

If not set defaults to 3. #useDeadLetterQueue must be enabled or else this value is ignored.

Parameters:

defaultMaxRetryDlq - Deafult max number of retries before sending message to DLQ for all consumers.

getDefaultTenant

public Optional<String> getDefaultTenant()

Specified by:

getDefaultTenant in interface PulsarClientConfiguration

setDefaultTenant

public void setDefaultTenant(String defaultTenant)

Use in combination with ${tenant} placeholder in PulsarConsumer.topic(), PulsarConsumer.topics(), PulsarConsumer.topicsPattern(), PulsarReader.topic(), PulsarProducer.topic() to avoid hardcoding tenant name into source code through mentioned annotations. This property will be ignored if multi-tenancy module is enabled.

Parameters:

defaultTenant - Default Apache Pulsar tenant name to apply on dynamic topic names.