Package org.apache.pulsar.client.api.v5.config

Class TlsPolicy

java.lang.Object

org.apache.pulsar.client.api.v5.config.TlsPolicy

public final class TlsPolicy
extends Object

TLS configuration for the Pulsar client connection.

Construct via builder(), or use ofInsecure() for development.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TlsPolicy.Builder	Builder for TlsPolicy.

Method Summary

Modifier and Type	Method	Description
boolean	allowInsecureConnection()
static TlsPolicy.Builder	builder()
String	certificateFilePath()
boolean	enableHostnameVerification()
String	keyFilePath()
static TlsPolicy	ofInsecure()	Create an insecure TLS policy that accepts any certificate (for development only).
String	trustCertsFilePath()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

trustCertsFilePath

public String trustCertsFilePath()

Returns:

path to the trusted CA certificate file (PEM), or null when not set

keyFilePath

public String keyFilePath()

Returns:

path to the client private key file (PEM), or null when not using mTLS

certificateFilePath

public String certificateFilePath()

Returns:

path to the client certificate file (PEM), or null when not using mTLS

allowInsecureConnection

public boolean allowInsecureConnection()

Returns:

whether connections to brokers with untrusted certificates are allowed

enableHostnameVerification

public boolean enableHostnameVerification()

Returns:

whether the broker hostname is verified against the certificate

ofInsecure

public static TlsPolicy ofInsecure()

Create an insecure TLS policy that accepts any certificate (for development only).

Returns:

a TlsPolicy with insecure connections allowed and hostname verification disabled

builder

public static TlsPolicy.Builder builder()

Returns:

a new builder for constructing a TlsPolicy