Interface ClusterData.Builder

Enclosing interface:

ClusterData

public static interface ClusterData.Builder

Method Summary

Modifier and Type	Method	Description
ClusterData.Builder	authenticationParameters(String authenticationParameters)
ClusterData.Builder	authenticationPlugin(String authenticationPlugin)
ClusterData.Builder	brokerClientCertificateFilePath(String certificateFilePath)
ClusterData.Builder	brokerClientKeyFilePath(String keyFilePath)
ClusterData.Builder	brokerClientSslFactoryPlugin(String sslFactoryPlugin)	Deprecated. since 5.0.0: the PIP-337 SSL factory plugin is removed (PIP-478).
ClusterData.Builder	brokerClientSslFactoryPluginParams(String sslFactoryPluginParams)	Deprecated. since 5.0.0: the PIP-337 SSL factory plugin is removed (PIP-478).
ClusterData.Builder	brokerClientTlsEnabled(boolean enabled)
ClusterData.Builder	brokerClientTlsEnabledWithKeyStore(boolean enabled)
ClusterData.Builder	brokerClientTlsFactoryClassName(String tlsFactoryClassName)	Select the PulsarTlsFactory used for outbound connections to this cluster (PIP-478) — the binary-protocol replication client and the cross-cluster admin (HTTPS) client, the two legs whose configuration is built from this cluster entry (see ClusterData.getBrokerClientTlsFactoryClassName() for the leg it does not reach).
ClusterData.Builder	brokerClientTlsFactoryConfig(String tlsFactoryConfig)	Configuration passed to brokerClientTlsFactoryClassName(String) as its init params (a JSON object or a key=value list).
ClusterData.Builder	brokerClientTlsKeyStore(String keyStore)
ClusterData.Builder	brokerClientTlsKeyStorePassword(String keyStorePassword)
ClusterData.Builder	brokerClientTlsKeyStoreType(String keyStoreType)
ClusterData.Builder	brokerClientTlsTrustStore(String tlsTrustStore)
ClusterData.Builder	brokerClientTlsTrustStorePassword(String trustStorePassword)
ClusterData.Builder	brokerClientTlsTrustStoreType(String trustStoreType)
ClusterData.Builder	brokerClientTrustCertsFilePath(String trustCertsFilePath)
ClusterData.Builder	brokerServiceUrl(String brokerServiceUrl)
ClusterData.Builder	brokerServiceUrlTls(String brokerServiceUrlTls)
ClusterData	build()
ClusterData.Builder	listenerName(String listenerName)
ClusterData.Builder	peerClusterNames(LinkedHashSet<String> peerClusterNames)
ClusterData.Builder	proxyProtocol(org.apache.pulsar.client.api.ProxyProtocol proxyProtocol)
ClusterData.Builder	proxyServiceUrl(String proxyServiceUrl)
ClusterData.Builder	serviceUrl(String serviceUrl)
ClusterData.Builder	serviceUrlTls(String serviceUrlTls)
ClusterData.Builder	tlsAllowInsecureConnection(boolean enabled)

Method Details

serviceUrl

ClusterData.Builder serviceUrl(String serviceUrl)

serviceUrlTls

ClusterData.Builder serviceUrlTls(String serviceUrlTls)

brokerServiceUrl

ClusterData.Builder brokerServiceUrl(String brokerServiceUrl)

brokerServiceUrlTls

ClusterData.Builder brokerServiceUrlTls(String brokerServiceUrlTls)

proxyServiceUrl

ClusterData.Builder proxyServiceUrl(String proxyServiceUrl)

proxyProtocol

ClusterData.Builder proxyProtocol(org.apache.pulsar.client.api.ProxyProtocol proxyProtocol)

authenticationPlugin

ClusterData.Builder authenticationPlugin(String authenticationPlugin)

authenticationParameters

ClusterData.Builder authenticationParameters(String authenticationParameters)

peerClusterNames

ClusterData.Builder peerClusterNames(LinkedHashSet<String> peerClusterNames)

brokerClientTlsEnabled

ClusterData.Builder brokerClientTlsEnabled(boolean enabled)

tlsAllowInsecureConnection

ClusterData.Builder tlsAllowInsecureConnection(boolean enabled)

brokerClientTlsEnabledWithKeyStore

ClusterData.Builder brokerClientTlsEnabledWithKeyStore(boolean enabled)

brokerClientTlsTrustStoreType

ClusterData.Builder brokerClientTlsTrustStoreType(String trustStoreType)

brokerClientTlsTrustStore

ClusterData.Builder brokerClientTlsTrustStore(String tlsTrustStore)

brokerClientTlsTrustStorePassword

ClusterData.Builder brokerClientTlsTrustStorePassword(String trustStorePassword)

brokerClientTrustCertsFilePath

ClusterData.Builder brokerClientTrustCertsFilePath(String trustCertsFilePath)

brokerClientCertificateFilePath

ClusterData.Builder brokerClientCertificateFilePath(String certificateFilePath)

brokerClientKeyFilePath

ClusterData.Builder brokerClientKeyFilePath(String keyFilePath)

brokerClientTlsKeyStoreType

ClusterData.Builder brokerClientTlsKeyStoreType(String keyStoreType)

brokerClientTlsKeyStorePassword

ClusterData.Builder brokerClientTlsKeyStorePassword(String keyStorePassword)

brokerClientTlsKeyStore

ClusterData.Builder brokerClientTlsKeyStore(String keyStore)

listenerName

ClusterData.Builder listenerName(String listenerName)

brokerClientTlsFactoryClassName

ClusterData.Builder brokerClientTlsFactoryClassName(String tlsFactoryClassName)

Select the PulsarTlsFactory used for outbound connections to this cluster (PIP-478) — the binary-protocol replication client and the cross-cluster admin (HTTPS) client, the two legs whose configuration is built from this cluster entry (see ClusterData.getBrokerClientTlsFactoryClassName() for the leg it does not reach). Leave blank to inherit the broker-level brokerClientTlsFactoryClassName.

Parameters:

tlsFactoryClassName - the factory class name, or blank to inherit the broker-level setting

Returns:

this builder

brokerClientTlsFactoryConfig

ClusterData.Builder brokerClientTlsFactoryConfig(String tlsFactoryConfig)

Configuration passed to brokerClientTlsFactoryClassName(String) as its init params (a JSON object or a key=value list).

It follows the class name rather than inheriting on its own: setting a class name here means this configuration is used even when blank, so one factory's parameters are never handed to another. It is ignored — with a warning — when no class name is set on this cluster.

Parameters:

tlsFactoryConfig - the factory configuration for this cluster's factory

Returns:

this builder

brokerClientSslFactoryPlugin

@Deprecated
ClusterData.Builder brokerClientSslFactoryPlugin(String sslFactoryPlugin)

Deprecated.

since 5.0.0: the PIP-337 SSL factory plugin is removed (PIP-478). Setting it writes a metadata field retained only for compatibility; the value is ignored (with a WARN). Use brokerClientTlsFactoryClassName(String) instead.

brokerClientSslFactoryPluginParams

@Deprecated
ClusterData.Builder brokerClientSslFactoryPluginParams(String sslFactoryPluginParams)

Deprecated.

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

build

ClusterData build()