SslConfigs (clients 6.2.15-ce API)

java.lang.Object
- org.apache.kafka.common.config.SslConfigs

```
public class SslConfigs
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_PRINCIPAL_BUILDER_CLASS` Deprecated. As of 1.0.0. This field will be removed in a future major release. In recent versions, the config is optional and there is no default.
`static String`	`DEFAULT_SSL_ENABLED_PROTOCOLS`
`static String`	`DEFAULT_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM`
`static String`	`DEFAULT_SSL_ENGINE_FACTORY_CLASS`
`static String`	`DEFAULT_SSL_KEYMANGER_ALGORITHM`
`static String`	`DEFAULT_SSL_KEYSTORE_TYPE`
`static String`	`DEFAULT_SSL_PROTOCOL`
`static String`	`DEFAULT_SSL_TRUSTMANAGER_ALGORITHM`
`static String`	`DEFAULT_SSL_TRUSTSTORE_TYPE`
`static String`	`KAFKA_SSL_ENGINE_FACTORY_CLASS`
`static String`	`NETTY_SSL_ENGINE_FACTORY_CLASS`
`static Set<String>`	`NON_RECONFIGURABLE_CONFIGS`
`static String`	`PRINCIPAL_BUILDER_CLASS_CONFIG` Deprecated. As of 1.0.0. This field will be removed in a future major release.
`static String`	`PRINCIPAL_BUILDER_CLASS_DOC` Deprecated. As of 1.0.0. This field will be removed in a future major release.
`static Set<String>`	`RECONFIGURABLE_CONFIGS`
`static String`	`SSL_CIPHER_SUITES_CONFIG`
`static String`	`SSL_CIPHER_SUITES_DOC`
`static String`	`SSL_CLIENT_AUTH_CONFIG` Deprecated. As of 1.0.0. This field will be removed in a future major release.
`static String`	`SSL_CLIENT_AUTH_DOC` Deprecated. As of 1.0.0. This field will be removed in a future major release.
`static String`	`SSL_ENABLED_PROTOCOLS_CONFIG`
`static String`	`SSL_ENABLED_PROTOCOLS_DOC`
`static String`	`SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG`
`static String`	`SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_DOC`
`static String`	`SSL_ENGINE_BUILDER_CLASS_DOC`
`static String`	`SSL_ENGINE_FACTORY_CLASS_CONFIG`
`static String`	`SSL_ENGINE_FACTORY_CLASS_DOC`
`static String`	`SSL_KEY_PASSWORD_CONFIG`
`static String`	`SSL_KEY_PASSWORD_DOC`
`static String`	`SSL_KEYMANAGER_ALGORITHM_CONFIG`
`static String`	`SSL_KEYMANAGER_ALGORITHM_DOC`
`static String`	`SSL_KEYSTORE_CERTIFICATE_CHAIN_CONFIG`
`static String`	`SSL_KEYSTORE_CERTIFICATE_CHAIN_DOC`
`static String`	`SSL_KEYSTORE_KEY_CONFIG`
`static String`	`SSL_KEYSTORE_KEY_DOC`
`static String`	`SSL_KEYSTORE_LOCATION_CONFIG`
`static String`	`SSL_KEYSTORE_LOCATION_DOC`
`static String`	`SSL_KEYSTORE_PASSWORD_CONFIG`
`static String`	`SSL_KEYSTORE_PASSWORD_DOC`
`static String`	`SSL_KEYSTORE_TYPE_CONFIG`
`static String`	`SSL_KEYSTORE_TYPE_DOC`
`static String`	`SSL_PROTOCOL_CONFIG`
`static String`	`SSL_PROTOCOL_DOC`
`static String`	`SSL_PROVIDER_CONFIG`
`static String`	`SSL_PROVIDER_DOC`
`static String`	`SSL_SECURE_RANDOM_IMPLEMENTATION_CONFIG`
`static String`	`SSL_SECURE_RANDOM_IMPLEMENTATION_DOC`
`static String`	`SSL_TRUSTMANAGER_ALGORITHM_CONFIG`
`static String`	`SSL_TRUSTMANAGER_ALGORITHM_DOC`
`static String`	`SSL_TRUSTSTORE_CERTIFICATES_CONFIG`
`static String`	`SSL_TRUSTSTORE_CERTIFICATES_DOC`
`static String`	`SSL_TRUSTSTORE_LOCATION_CONFIG`
`static String`	`SSL_TRUSTSTORE_LOCATION_DOC`
`static String`	`SSL_TRUSTSTORE_PASSWORD_CONFIG`
`static String`	`SSL_TRUSTSTORE_PASSWORD_DOC`
`static String`	`SSL_TRUSTSTORE_TYPE_CONFIG`
`static String`	`SSL_TRUSTSTORE_TYPE_DOC`

Constructor Summary

Constructors
Constructor and Description

SslConfigs()

Constructors
Constructor and Description
`SslConfigs()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static void addClientSslSupport(ConfigDef config)
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addClientSslSupport(ConfigDef config)`

- Field Detail
  - PRINCIPAL_BUILDER_CLASS_CONFIG
```
@Deprecated
public static final String PRINCIPAL_BUILDER_CLASS_CONFIG
```
    Deprecated. As of 1.0.0. This field will be removed in a future major release.
    
    See Also:
    
    Constant Field Values
  - PRINCIPAL_BUILDER_CLASS_DOC
```
@Deprecated
public static final String PRINCIPAL_BUILDER_CLASS_DOC
```
    Deprecated. As of 1.0.0. This field will be removed in a future major release.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PRINCIPAL_BUILDER_CLASS
```
@Deprecated
public static final String DEFAULT_PRINCIPAL_BUILDER_CLASS
```
    Deprecated. As of 1.0.0. This field will be removed in a future major release. In recent versions, the config is optional and there is no default.
  - SSL_PROTOCOL_CONFIG
```
public static final String SSL_PROTOCOL_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_PROTOCOL_DOC
```
public static final String SSL_PROTOCOL_DOC
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_PROTOCOL
```
public static final String DEFAULT_SSL_PROTOCOL
```
  - KAFKA_SSL_ENGINE_FACTORY_CLASS
```
public static final String KAFKA_SSL_ENGINE_FACTORY_CLASS
```
    See Also:
    
    Constant Field Values
  - NETTY_SSL_ENGINE_FACTORY_CLASS
```
public static final String NETTY_SSL_ENGINE_FACTORY_CLASS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_ENGINE_FACTORY_CLASS
```
public static final String DEFAULT_SSL_ENGINE_FACTORY_CLASS
```
    See Also:
    
    Constant Field Values
  - SSL_ENGINE_BUILDER_CLASS_DOC
```
public static final String SSL_ENGINE_BUILDER_CLASS_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_PROVIDER_CONFIG
```
public static final String SSL_PROVIDER_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_PROVIDER_DOC
```
public static final String SSL_PROVIDER_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_CIPHER_SUITES_CONFIG
```
public static final String SSL_CIPHER_SUITES_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_CIPHER_SUITES_DOC
```
public static final String SSL_CIPHER_SUITES_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_ENABLED_PROTOCOLS_CONFIG
```
public static final String SSL_ENABLED_PROTOCOLS_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_ENABLED_PROTOCOLS_DOC
```
public static final String SSL_ENABLED_PROTOCOLS_DOC
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_ENABLED_PROTOCOLS
```
public static final String DEFAULT_SSL_ENABLED_PROTOCOLS
```
  - SSL_KEYSTORE_TYPE_CONFIG
```
public static final String SSL_KEYSTORE_TYPE_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_TYPE_DOC
```
public static final String SSL_KEYSTORE_TYPE_DOC
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_KEYSTORE_TYPE
```
public static final String DEFAULT_SSL_KEYSTORE_TYPE
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_KEY_CONFIG
```
public static final String SSL_KEYSTORE_KEY_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_KEY_DOC
```
public static final String SSL_KEYSTORE_KEY_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_CERTIFICATE_CHAIN_CONFIG
```
public static final String SSL_KEYSTORE_CERTIFICATE_CHAIN_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_CERTIFICATE_CHAIN_DOC
```
public static final String SSL_KEYSTORE_CERTIFICATE_CHAIN_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTSTORE_CERTIFICATES_CONFIG
```
public static final String SSL_TRUSTSTORE_CERTIFICATES_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTSTORE_CERTIFICATES_DOC
```
public static final String SSL_TRUSTSTORE_CERTIFICATES_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_LOCATION_CONFIG
```
public static final String SSL_KEYSTORE_LOCATION_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_LOCATION_DOC
```
public static final String SSL_KEYSTORE_LOCATION_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_PASSWORD_CONFIG
```
public static final String SSL_KEYSTORE_PASSWORD_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_PASSWORD_DOC
```
public static final String SSL_KEYSTORE_PASSWORD_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_KEY_PASSWORD_CONFIG
```
public static final String SSL_KEY_PASSWORD_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_KEY_PASSWORD_DOC
```
public static final String SSL_KEY_PASSWORD_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTSTORE_TYPE_CONFIG
```
public static final String SSL_TRUSTSTORE_TYPE_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTSTORE_TYPE_DOC
```
public static final String SSL_TRUSTSTORE_TYPE_DOC
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_TRUSTSTORE_TYPE
```
public static final String DEFAULT_SSL_TRUSTSTORE_TYPE
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTSTORE_LOCATION_CONFIG
```
public static final String SSL_TRUSTSTORE_LOCATION_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTSTORE_LOCATION_DOC
```
public static final String SSL_TRUSTSTORE_LOCATION_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTSTORE_PASSWORD_CONFIG
```
public static final String SSL_TRUSTSTORE_PASSWORD_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTSTORE_PASSWORD_DOC
```
public static final String SSL_TRUSTSTORE_PASSWORD_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_KEYMANAGER_ALGORITHM_CONFIG
```
public static final String SSL_KEYMANAGER_ALGORITHM_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_KEYMANAGER_ALGORITHM_DOC
```
public static final String SSL_KEYMANAGER_ALGORITHM_DOC
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_KEYMANGER_ALGORITHM
```
public static final String DEFAULT_SSL_KEYMANGER_ALGORITHM
```
  - SSL_TRUSTMANAGER_ALGORITHM_CONFIG
```
public static final String SSL_TRUSTMANAGER_ALGORITHM_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTMANAGER_ALGORITHM_DOC
```
public static final String SSL_TRUSTMANAGER_ALGORITHM_DOC
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_TRUSTMANAGER_ALGORITHM
```
public static final String DEFAULT_SSL_TRUSTMANAGER_ALGORITHM
```
  - SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG
```
public static final String SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_DOC
```
public static final String SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_DOC
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM
```
public static final String DEFAULT_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM
```
    See Also:
    
    Constant Field Values
  - SSL_SECURE_RANDOM_IMPLEMENTATION_CONFIG
```
public static final String SSL_SECURE_RANDOM_IMPLEMENTATION_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_SECURE_RANDOM_IMPLEMENTATION_DOC
```
public static final String SSL_SECURE_RANDOM_IMPLEMENTATION_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_ENGINE_FACTORY_CLASS_CONFIG
```
public static final String SSL_ENGINE_FACTORY_CLASS_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_ENGINE_FACTORY_CLASS_DOC
```
public static final String SSL_ENGINE_FACTORY_CLASS_DOC
```
    See Also:
    
    Constant Field Values
  - SSL_CLIENT_AUTH_CONFIG
```
@Deprecated
public static final String SSL_CLIENT_AUTH_CONFIG
```
    Deprecated. As of 1.0.0. This field will be removed in a future major release.
    
    See Also:
    
    Constant Field Values
  - SSL_CLIENT_AUTH_DOC
```
@Deprecated
public static final String SSL_CLIENT_AUTH_DOC
```
    Deprecated. As of 1.0.0. This field will be removed in a future major release.
    
    See Also:
    
    Constant Field Values
  - RECONFIGURABLE_CONFIGS
```
public static final Set<String> RECONFIGURABLE_CONFIGS
```
  - NON_RECONFIGURABLE_CONFIGS
```
public static final Set<String> NON_RECONFIGURABLE_CONFIGS
```
- Constructor Detail
  - SslConfigs
```
public SslConfigs()
```
- Method Detail
  - addClientSslSupport
```
public static void addClientSslSupport(ConfigDef config)
```

Class SslConfigs

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRINCIPAL_BUILDER_CLASS_CONFIG

PRINCIPAL_BUILDER_CLASS_DOC

DEFAULT_PRINCIPAL_BUILDER_CLASS

SSL_PROTOCOL_CONFIG

SSL_PROTOCOL_DOC

DEFAULT_SSL_PROTOCOL

KAFKA_SSL_ENGINE_FACTORY_CLASS

NETTY_SSL_ENGINE_FACTORY_CLASS

DEFAULT_SSL_ENGINE_FACTORY_CLASS

SSL_ENGINE_BUILDER_CLASS_DOC

SSL_PROVIDER_CONFIG

SSL_PROVIDER_DOC

SSL_CIPHER_SUITES_CONFIG

SSL_CIPHER_SUITES_DOC

SSL_ENABLED_PROTOCOLS_CONFIG

SSL_ENABLED_PROTOCOLS_DOC

DEFAULT_SSL_ENABLED_PROTOCOLS

SSL_KEYSTORE_TYPE_CONFIG

SSL_KEYSTORE_TYPE_DOC

DEFAULT_SSL_KEYSTORE_TYPE

SSL_KEYSTORE_KEY_CONFIG

SSL_KEYSTORE_KEY_DOC

SSL_KEYSTORE_CERTIFICATE_CHAIN_CONFIG

SSL_KEYSTORE_CERTIFICATE_CHAIN_DOC

SSL_TRUSTSTORE_CERTIFICATES_CONFIG

SSL_TRUSTSTORE_CERTIFICATES_DOC

SSL_KEYSTORE_LOCATION_CONFIG

SSL_KEYSTORE_LOCATION_DOC

SSL_KEYSTORE_PASSWORD_CONFIG

SSL_KEYSTORE_PASSWORD_DOC

SSL_KEY_PASSWORD_CONFIG

SSL_KEY_PASSWORD_DOC

SSL_TRUSTSTORE_TYPE_CONFIG

SSL_TRUSTSTORE_TYPE_DOC

DEFAULT_SSL_TRUSTSTORE_TYPE

SSL_TRUSTSTORE_LOCATION_CONFIG

SSL_TRUSTSTORE_LOCATION_DOC

SSL_TRUSTSTORE_PASSWORD_CONFIG

SSL_TRUSTSTORE_PASSWORD_DOC

SSL_KEYMANAGER_ALGORITHM_CONFIG

SSL_KEYMANAGER_ALGORITHM_DOC

DEFAULT_SSL_KEYMANGER_ALGORITHM

SSL_TRUSTMANAGER_ALGORITHM_CONFIG

SSL_TRUSTMANAGER_ALGORITHM_DOC

DEFAULT_SSL_TRUSTMANAGER_ALGORITHM

SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG

SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_DOC

DEFAULT_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM

SSL_SECURE_RANDOM_IMPLEMENTATION_CONFIG

SSL_SECURE_RANDOM_IMPLEMENTATION_DOC

SSL_ENGINE_FACTORY_CLASS_CONFIG

SSL_ENGINE_FACTORY_CLASS_DOC

SSL_CLIENT_AUTH_CONFIG

SSL_CLIENT_AUTH_DOC

RECONFIGURABLE_CONFIGS

NON_RECONFIGURABLE_CONFIGS

Constructor Detail

SslConfigs

Method Detail

addClientSslSupport