Interface ClusterData

public interface ClusterData

  • Method Details

    • getServiceUrl

      String getServiceUrl()

    • getServiceUrlTls

      String getServiceUrlTls()

    • getBrokerServiceUrl

      String getBrokerServiceUrl()

    • getBrokerServiceUrlTls

      String getBrokerServiceUrlTls()

    • getProxyServiceUrl

      String getProxyServiceUrl()

    • getProxyProtocol

      org.apache.pulsar.client.api.ProxyProtocol getProxyProtocol()

    • getPeerClusterNames

      LinkedHashSet<String> getPeerClusterNames()

    • getAuthenticationPlugin

      String getAuthenticationPlugin()

    • getAuthenticationParameters

      String getAuthenticationParameters()

    • isBrokerClientTlsEnabled

      boolean isBrokerClientTlsEnabled()

    • isTlsAllowInsecureConnection

      boolean isTlsAllowInsecureConnection()

    • isBrokerClientTlsEnabledWithKeyStore

      boolean isBrokerClientTlsEnabledWithKeyStore()

    • getBrokerClientTlsTrustStoreType

      String getBrokerClientTlsTrustStoreType()

    • getBrokerClientTlsTrustStore

      String getBrokerClientTlsTrustStore()

    • getBrokerClientTlsTrustStorePassword

      String getBrokerClientTlsTrustStorePassword()

    • getBrokerClientTrustCertsFilePath

      String getBrokerClientTrustCertsFilePath()

    • getBrokerClientCertificateFilePath

      String getBrokerClientCertificateFilePath()

    • getBrokerClientKeyFilePath

      String getBrokerClientKeyFilePath()

    • getBrokerClientTlsKeyStoreType

      String getBrokerClientTlsKeyStoreType()

    • getBrokerClientTlsKeyStorePassword

      String getBrokerClientTlsKeyStorePassword()

    • getBrokerClientTlsKeyStore

      String getBrokerClientTlsKeyStore()

    • getBrokerClientTlsFactoryClassName

      String getBrokerClientTlsFactoryClassName()
      The PulsarTlsFactory class name used for outbound connections to this cluster (PIP-478), or blank to inherit the broker-level brokerClientTlsFactoryClassName. It applies to the two outbound legs whose client configuration is built from this cluster entry: the binary-protocol replication client and the cross-cluster admin (HTTPS) client.

      It does not reach the peer-cluster lookup client (NamespaceService.getNamespaceClient), which takes only the service URL from the cluster entry and all of its TLS configuration — material and factory alike — from the broker-level brokerClient* settings. That leg was already broker-level in 4.x (it read the broker-level brokerClientSslFactoryPlugin, never the per-cluster one), so this is unchanged behaviour rather than a PIP-478 narrowing.

      Returns:
      the per-cluster TLS factory class name, or blank/null to inherit the broker-level setting

    • getBrokerClientTlsFactoryConfig

      String getBrokerClientTlsFactoryConfig()
      The configuration parameters passed to getBrokerClientTlsFactoryClassName() as its init params (a JSON object or a key=value list).

      This value follows the class name rather than inheriting on its own: when this cluster names a factory, this configuration is used even when blank, so factory A's parameters can never be handed to factory B. Only when the class name is blank — so the broker-level factory applies — does the broker-level brokerClientTlsFactoryConfig apply too.

      Returns:
      the per-cluster TLS factory configuration; used verbatim when this cluster names a factory

    • getBrokerClientSslFactoryPlugin

      @Deprecated String getBrokerClientSslFactoryPlugin()
      Deprecated.
      since 5.0.0: the PIP-337 SSL factory plugin is removed (PIP-478). Retained in the cluster metadata schema for wire/metadata compatibility, but a configured value is ignored (with a WARN). Use getBrokerClientTlsFactoryClassName() instead.

    • getBrokerClientSslFactoryPluginParams

      @Deprecated String getBrokerClientSslFactoryPluginParams()
      Deprecated.
      since 5.0.0: the PIP-337 SSL factory plugin is removed (PIP-478). Retained for metadata compatibility but ignored. Use getBrokerClientTlsFactoryConfig() instead.

    • getListenerName

      String getListenerName()

    • clone

      ClusterData.Builder clone()

    • builder

      static ClusterData.Builder builder()