DefaultPulsarClientConfiguration (javadoc 1.0.0-SNAPSHOT API)

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, TOPIC_NAME_PATTERN_VALIDATOR, TOPIC_NAME_VALIDATOR

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.apache.pulsar.client.api.Authentication`	`getAuthentication()`
`int`	`getDefaultMaxRetryDlq()`
`java.util.Optional<java.lang.Integer>`	`getIoThreads()`
`java.util.Optional<java.lang.Integer>`	`getListenerThreads()`
`java.util.Optional<java.lang.String>`	`getOauthAudience()` Must be set for usage with the OAuth2 authentication.
`java.util.Optional<java.net.URL>`	`getOauthCredentialsUrl()`
`java.net.URL`	`getOauthIssuerUrl()`
`java.lang.String`	`getServiceUrl()`
`java.util.Optional<org.apache.pulsar.client.api.ServiceUrlProvider>`	`getServiceUrlProvider()`
`boolean`	`getShutdownOnSubscriberError()`
`java.util.Optional<java.lang.String>`	`getSslProvider()`
`java.util.Optional<java.lang.Boolean>`	`getTlsAllowInsecureConnection()`
`java.util.Optional<java.lang.String>`	`getTlsCertFilePath()`
`java.util.Optional<java.util.Set<java.lang.String>>`	`getTlsCiphers()`
`java.util.Optional<java.util.Set<java.lang.String>>`	`getTlsProtocols()`
`java.util.Optional<java.lang.String>`	`getTlsTrustStorePath()`
`java.util.Optional<java.lang.Boolean>`	`getTlsVerifyHostname()`
`java.lang.Boolean`	`getUseDeadLetterQueue()`
`void`	`setAuthenticationJwt(java.lang.String authenticationJwt)`
`void`	`setDefaultMaxRetryDlq(int defaultMaxRetryDlq)` If not set defaults to 3.
`void`	`setIoThreads(java.lang.Integer ioThreads)`
`void`	`setListenerThreads(java.lang.Integer listenerThreads)`
`void`	`setOauthAudience(java.lang.String oauthAudience)`
`void`	`setOauthCredentialsUrl(java.net.URL oauthCredentialsUrl)`
`void`	`setOauthIssuerUrl(java.net.URL oauthIssuerUrl)`
`void`	`setServiceUrl(java.lang.String serviceUrl)`
`void`	`setShutdownOnSubscriberError(java.lang.Boolean shutdownOnSubscriberError)`
`void`	`setSslProvider(java.lang.String sslProvider)` Defaults to default JVM provider.
`void`	`setTlsAllowInsecureConnection(java.lang.Boolean tlsAllowInsecureConnection)`
`void`	`setTlsCertFilePath(java.lang.String tlsCertFilePath)`
`void`	`setTlsCiphers(java.util.Set<java.lang.String> tlsCiphers)`
`void`	`setTlsProtocols(java.util.Set<java.lang.String> tlsProtocols)`
`void`	`setTlsTrustStorePath(java.lang.String tlsTrustStorePath)`
`void`	`setTlsVerifyHostname(java.lang.Boolean tlsVerifyHostname)`
`void`	`setUseDeadLetterQueue(java.lang.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
                                           java.util.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 java.util.Optional<java.lang.Integer> getIoThreads()
```
    Specified by:
    
    getIoThreads in interface PulsarClientConfiguration
  - setIoThreads
```
public void setIoThreads(java.lang.Integer ioThreads)
```
    Parameters:
    
    ioThreads - Number of threads to use with read operations
  - getListenerThreads
```
public java.util.Optional<java.lang.Integer> getListenerThreads()
```
    Specified by:
    
    getListenerThreads in interface PulsarClientConfiguration
  - setListenerThreads
```
public void setListenerThreads(java.lang.Integer listenerThreads)
```
    Parameters:
    
    listenerThreads - Number of threads to use with message example.java.listeners.
  - setAuthenticationJwt
```
public void setAuthenticationJwt(@Nullable
                                 java.lang.String authenticationJwt)
```
  - getSslProvider
```
public java.util.Optional<java.lang.String> getSslProvider()
```
    Specified by:
    
    getSslProvider in interface PulsarClientConfiguration
  - setTlsTrustStorePath
```
public void setTlsTrustStorePath(java.lang.String tlsTrustStorePath)
```
  - getTlsTrustStorePath
```
public java.util.Optional<java.lang.String> getTlsTrustStorePath()
```
    Specified by:
    
    getTlsTrustStorePath in interface PulsarClientConfiguration
  - setTlsCertFilePath
```
public void setTlsCertFilePath(java.lang.String tlsCertFilePath)
```
  - getTlsCertFilePath
```
public java.util.Optional<java.lang.String> getTlsCertFilePath()
```
    Specified by:
    
    getTlsCertFilePath in interface PulsarClientConfiguration
  - setTlsVerifyHostname
```
public void setTlsVerifyHostname(java.lang.Boolean tlsVerifyHostname)
```
  - getTlsVerifyHostname
```
public java.util.Optional<java.lang.Boolean> getTlsVerifyHostname()
```
    Specified by:
    
    getTlsVerifyHostname in interface PulsarClientConfiguration
  - setTlsAllowInsecureConnection
```
public void setTlsAllowInsecureConnection(java.lang.Boolean tlsAllowInsecureConnection)
```
  - getTlsAllowInsecureConnection
```
public java.util.Optional<java.lang.Boolean> getTlsAllowInsecureConnection()
```
    Specified by:
    
    getTlsAllowInsecureConnection in interface PulsarClientConfiguration
  - setTlsCiphers
```
public void setTlsCiphers(java.util.Set<java.lang.String> tlsCiphers)
```
  - getTlsCiphers
```
public java.util.Optional<java.util.Set<java.lang.String>> getTlsCiphers()
```
    Specified by:
    
    getTlsCiphers in interface PulsarClientConfiguration
  - setTlsProtocols
```
public void setTlsProtocols(java.util.Set<java.lang.String> tlsProtocols)
```
  - getTlsProtocols
```
public java.util.Optional<java.util.Set<java.lang.String>> getTlsProtocols()
```
    Specified by:
    
    getTlsProtocols in interface PulsarClientConfiguration
  - setSslProvider
```
public void setSslProvider(java.lang.String sslProvider)
```
    Defaults to default JVM provider.
    
    Parameters:
    
    sslProvider - The name of the security provider used for SSL connections.
  - getServiceUrl
```
public java.lang.String getServiceUrl()
```
    Specified by:
    
    getServiceUrl in interface PulsarClientConfiguration
    
    Returns:
    
    Apache Pulsar cluster address (IP or domain or hostname + port)
  - setServiceUrl
```
public void setServiceUrl(@Nullable
                          java.lang.String serviceUrl)
```
    Parameters:
    
    serviceUrl - URL to Pulsar cluster
  - getServiceUrlProvider
```
public java.util.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(java.lang.Boolean shutdownOnSubscriberError)
```
    Parameters:
    
    shutdownOnSubscriberError - should application shutdown if any of subscriptions fail
  - getOauthAudience
```
public java.util.Optional<java.lang.String> getOauthAudience()
```
    Must be set for usage with the OAuth2 authentication.
    
    Returns:
    
    String representing client application willing to listen to
  - setOauthAudience
```
public void setOauthAudience(java.lang.String oauthAudience)
```
    Parameters:
    
    oauthAudience - OAuth2 audience
  - getOauthCredentialsUrl
```
public java.util.Optional<java.net.URL> getOauthCredentialsUrl()
```
  - setOauthCredentialsUrl
```
public void setOauthCredentialsUrl(java.net.URL oauthCredentialsUrl)
```
    Parameters:
    
    oauthCredentialsUrl - URL or a path to a file containing client id, client secret, and such for OAuth2 client application.
  - getOauthIssuerUrl
```
public java.net.URL getOauthIssuerUrl()
```
  - setOauthIssuerUrl
```
public void setOauthIssuerUrl(java.net.URL oauthIssuerUrl)
```
    Parameters:
    
    oauthIssuerUrl - URL of the OAuth2 Token issuer
  - getUseDeadLetterQueue
```
public java.lang.Boolean getUseDeadLetterQueue()
```
  - setUseDeadLetterQueue
```
public void setUseDeadLetterQueue(java.lang.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.

Class DefaultPulsarClientConfiguration

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

DefaultPulsarClientConfiguration

Method Detail

getIoThreads

setIoThreads

getListenerThreads

setListenerThreads

setAuthenticationJwt

getSslProvider

setTlsTrustStorePath

getTlsTrustStorePath

setTlsCertFilePath

getTlsCertFilePath

setTlsVerifyHostname

getTlsVerifyHostname

setTlsAllowInsecureConnection

getTlsAllowInsecureConnection

setTlsCiphers

getTlsCiphers

setTlsProtocols

getTlsProtocols

setSslProvider

getServiceUrl

setServiceUrl

getServiceUrlProvider

getAuthentication

getShutdownOnSubscriberError

setShutdownOnSubscriberError

getOauthAudience

setOauthAudience

getOauthCredentialsUrl

setOauthCredentialsUrl

getOauthIssuerUrl

setOauthIssuerUrl

getUseDeadLetterQueue

setUseDeadLetterQueue

getDefaultMaxRetryDlq

setDefaultMaxRetryDlq