Package io.micronaut.pulsar.config

Interface PulsarClientConfiguration

All Known Implementing Classes:
DefaultPulsarClientConfiguration
public interface PulsarClientConfiguration
Basic requirements for custom and default configuration to create Pulsar client.
Since:
1.0
Author:
Haris Secic

  • Method Details

    • getServiceUrl

      String getServiceUrl()

    • getServiceUrlProvider

      default Optional<org.apache.pulsar.client.api.ServiceUrlProvider> getServiceUrlProvider()
      Optional provider for Pulsar services URL.
      Returns:
      Optional bean for fetching Pulsar services URLs

    • getAuthentication

      org.apache.pulsar.client.api.Authentication getAuthentication()
      Returns:
      Authentication method for pulsar clients

    • getIoThreads

      default Optional<Integer> getIoThreads()
      Returns:
      Number of threads to allow for Pulsar library.

    • getListenerThreads

      default Optional<Integer> getListenerThreads()
      Returns:
      Number of threads to allow for listeners from IO threads defined for Pulsar library

    • getSslProvider

      Optional<String> getSslProvider()
      Returns:
      SSL provider if any for Pulsar to client communication encryption

    • getTlsTrustStorePath

      Optional<String> getTlsTrustStorePath()

    • getTlsTrustStorePassword

      Optional<String> getTlsTrustStorePassword()
      Returns:
      trust store password if any, trust stores don't contain any sensitive information but often work better with password in Java context.

    • getTlsCertFilePath

      Optional<String> getTlsCertFilePath()
      Returns:
      TLS certificate file path if any for TLS communication between Pulsar and clients.

    • getTlsVerifyHostname

      Optional<Boolean> getTlsVerifyHostname()
      Useful in development environment for using with local host or such.
      Returns:
      Whether to verify TLS certificate host or not.

    • getTlsAllowInsecureConnection

      Optional<Boolean> getTlsAllowInsecureConnection()
      Returns:
      Allow insecure connection when TLS certificate is set or not.

    • getTlsCiphers

      Optional<Set<String>> getTlsCiphers()
      Ciphers like TLS_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.
      Returns:
      Permitted ciphers for TLS.

    • getTlsProtocols

      Optional<Set<String>> getTlsProtocols()
      Protocols like TLSv1.3, TLSv1.2.
      Returns:
      Permitted protocols for TLS.

    • getDefaultTenant

      default Optional<String> getDefaultTenant()
      Useful for avoiding hard coding tenant name into every annotation value for producers, consumers, or readers.
      Returns:
      Default tenant name if any.