io.debezium.connector.mysql

Enum MySqlConnectorConfig.SecureConnectionMode

java.lang.Object

java.lang.Enum<MySqlConnectorConfig.SecureConnectionMode>

io.debezium.connector.mysql.MySqlConnectorConfig.SecureConnectionMode

All Implemented Interfaces:

EnumeratedValue, Serializable, Comparable<MySqlConnectorConfig.SecureConnectionMode>

Enclosing class:

MySqlConnectorConfig

public static enum MySqlConnectorConfig.SecureConnectionMode
extends Enum<MySqlConnectorConfig.SecureConnectionMode>
implements EnumeratedValue

The set of predefined SecureConnectionMode options or aliases.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Establish an unencrypted connection.
PREFERRED Establish a secure (encrypted) connection if the server supports secure connections.
REQUIRED Establish a secure connection if the server supports secure connections.
VERIFY_CA Like REQUIRED, but additionally verify the server TLS certificate against the configured Certificate Authority (CA) certificates.
VERIFY_IDENTITY Like VERIFY_CA, but additionally verify that the server certificate matches the host to which the connection is attempted.

Field Summary

Fields

Modifier and Type	Field and Description
private String	value

Method Summary

Modifier and Type	Method and Description
String	getValue()
static MySqlConnectorConfig.SecureConnectionMode	parse(String value) Determine if the supplied value is one of the predefined options.
static MySqlConnectorConfig.SecureConnectionMode	parse(String value, String defaultValue) Determine if the supplied value is one of the predefined options.
static MySqlConnectorConfig.SecureConnectionMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static MySqlConnectorConfig.SecureConnectionMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISABLED

public static final MySqlConnectorConfig.SecureConnectionMode DISABLED

Establish an unencrypted connection.

PREFERRED

public static final MySqlConnectorConfig.SecureConnectionMode PREFERRED

Establish a secure (encrypted) connection if the server supports secure connections. Fall back to an unencrypted connection otherwise.

REQUIRED

public static final MySqlConnectorConfig.SecureConnectionMode REQUIRED

Establish a secure connection if the server supports secure connections. The connection attempt fails if a secure connection cannot be established.

VERIFY_CA

public static final MySqlConnectorConfig.SecureConnectionMode VERIFY_CA

Like REQUIRED, but additionally verify the server TLS certificate against the configured Certificate Authority (CA) certificates. The connection attempt fails if no valid matching CA certificates are found.

VERIFY_IDENTITY

public static final MySqlConnectorConfig.SecureConnectionMode VERIFY_IDENTITY

Like VERIFY_CA, but additionally verify that the server certificate matches the host to which the connection is attempted.

Field Detail

value

private final String value

Method Detail

values

public static MySqlConnectorConfig.SecureConnectionMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MySqlConnectorConfig.SecureConnectionMode c : MySqlConnectorConfig.SecureConnectionMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MySqlConnectorConfig.SecureConnectionMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Specified by:

getValue in interface EnumeratedValue

parse

public static MySqlConnectorConfig.SecureConnectionMode parse(String value)

Determine if the supplied value is one of the predefined options.

Parameters:

value - the configuration property value; may not be null

Returns:

the matching option, or null if no match is found

parse

public static MySqlConnectorConfig.SecureConnectionMode parse(String value,
                                                              String defaultValue)

Determine if the supplied value is one of the predefined options.

Parameters:

value - the configuration property value; may not be null

defaultValue - the default value; may be null

Returns:

the matching option, or null if no match is found and the non-null default is invalid