org.apache.pulsar.client.admin

Interface PulsarAdminBuilder

All Known Implementing Classes:

PulsarAdminBuilderImpl

public interface PulsarAdminBuilder

Builder class for a PulsarAdmin instance.

Method Summary

Modifier and Type	Method and Description
PulsarAdminBuilder	allowTlsInsecureConnection(boolean allowTlsInsecureConnection) Configure whether the Pulsar admin client accept untrusted TLS certificate from broker (default: false)
PulsarAdminBuilder	authentication(Authentication authentication) Set the authentication provider to use in the Pulsar admin instance.
PulsarAdminBuilder	authentication(String authPluginClassName, Map<String,String> authParams) Set the authentication provider to use in the Pulsar client instance.
PulsarAdminBuilder	authentication(String authPluginClassName, String authParamsString) Set the authentication provider to use in the Pulsar client instance.
PulsarAdmin	build()
PulsarAdminBuilder	clone() Create a copy of the current client builder.
PulsarAdminBuilder	enableTlsHostnameVerification(boolean enableTlsHostnameVerification) It allows to validate hostname verification when client connects to broker over TLS.
PulsarAdminBuilder	serviceHttpUrl(String serviceHttpUrl) Set the Pulsar service HTTP URL for the admin endpoint (eg.
PulsarAdminBuilder	tlsTrustCertsFilePath(String tlsTrustCertsFilePath) Set the path to the trusted TLS certificate file

Method Detail

build

PulsarAdmin build()
           throws PulsarClientException

Returns:

the new PulsarAdmin instance

Throws:

PulsarClientException

clone

PulsarAdminBuilder clone()

Create a copy of the current client builder.

Cloning the builder can be used to share an incomplete configuration and specialize it multiple times. For example:

 PulsarAdminBuilder builder = PulsarAdmin.builder().allowTlsInsecureConnection(false);

 PulsarAdmin client1 = builder.clone().serviceHttpUrl(URL_1).build();
 PulsarAdmin client2 = builder.clone().serviceHttpUrl(URL_2).build();
 

serviceHttpUrl

PulsarAdminBuilder serviceHttpUrl(String serviceHttpUrl)

Set the Pulsar service HTTP URL for the admin endpoint (eg. "http://my-broker.example.com:8080", or "https://my-broker.example.com:8443" for TLS)

authentication

PulsarAdminBuilder authentication(String authPluginClassName,
                                  String authParamsString)
                           throws PulsarClientException.UnsupportedAuthenticationException

Set the authentication provider to use in the Pulsar client instance.

Example:

 
 String AUTH_CLASS = "org.apache.pulsar.client.impl.auth.AuthenticationTls";
 String AUTH_PARAMS = "tlsCertFile:/my/cert/file,tlsKeyFile:/my/key/file";

 PulsarAdmin client = PulsarAdmin.builder()
          .serviceHttpUrl(SERVICE_HTTP_URL)
          .authentication(AUTH_CLASS, AUTH_PARAMS)
          .build();
 ....
 
 

Parameters:

authPluginClassName - name of the Authentication-Plugin you want to use

authParamsString - string which represents parameters for the Authentication-Plugin, e.g., "key1:val1,key2:val2"

Throws:

PulsarClientException.UnsupportedAuthenticationException - failed to instantiate specified Authentication-Plugin

authentication

PulsarAdminBuilder authentication(String authPluginClassName,
                                  Map<String,String> authParams)
                           throws PulsarClientException.UnsupportedAuthenticationException

Set the authentication provider to use in the Pulsar client instance.

Example:

 
 String AUTH_CLASS = "org.apache.pulsar.client.impl.auth.AuthenticationTls";

 Map conf = new TreeMap<>();
 conf.put("tlsCertFile", "/my/cert/file");
 conf.put("tlsKeyFile", "/my/key/file");

 PulsarAdmin client = PulsarAdmin.builder()
          .serviceHttpUrl(SERVICE_HTTP_URL)
          .authentication(AUTH_CLASS, conf)
          .build();
 ....
 

Parameters:

authPluginClassName - name of the Authentication-Plugin you want to use

authParams - map which represents parameters for the Authentication-Plugin

Throws:

PulsarClientException.UnsupportedAuthenticationException - failed to instantiate specified Authentication-Plugin

authentication

PulsarAdminBuilder authentication(Authentication authentication)

Set the authentication provider to use in the Pulsar admin instance.

Example:

 
 String AUTH_CLASS = "org.apache.pulsar.client.impl.auth.AuthenticationTls";

 Map conf = new TreeMap<>();
 conf.put("tlsCertFile", "/my/cert/file");
 conf.put("tlsKeyFile", "/my/key/file");

 Authentication auth = AuthenticationFactor.create(AUTH_CLASS, conf);

 PulsarAdmin admin = PulsarAdmin.builder()
          .serviceHttpUrl(SERVICE_URL)
          .authentication(auth)
          .build();
 ....
 
 

Parameters:

authentication - an instance of the Authentication provider already constructed

tlsTrustCertsFilePath

PulsarAdminBuilder tlsTrustCertsFilePath(String tlsTrustCertsFilePath)

Set the path to the trusted TLS certificate file

Parameters:

tlsTrustCertsFilePath -

allowTlsInsecureConnection

PulsarAdminBuilder allowTlsInsecureConnection(boolean allowTlsInsecureConnection)

Configure whether the Pulsar admin client accept untrusted TLS certificate from broker (default: false)

Parameters:

allowTlsInsecureConnection -

enableTlsHostnameVerification

PulsarAdminBuilder enableTlsHostnameVerification(boolean enableTlsHostnameVerification)

It allows to validate hostname verification when client connects to broker over TLS. It validates incoming x509 certificate and matches provided hostname(CN/SAN) with expected broker's host name. It follows RFC 2818, 3.1. Server Identity hostname verification.

Parameters:

enableTlsHostnameVerification -

See Also:

rfc2818