io.asyncer.r2dbc.mysql.constant

Enum SslMode

java.lang.Object

java.lang.Enum<SslMode>

io.asyncer.r2dbc.mysql.constant.SslMode

All Implemented Interfaces:

Serializable, Comparable<SslMode>

public enum SslMode
extends Enum<SslMode>

The mode of SSL considers the security of MySQL connections.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Establish an unencrypted connection.
PREFERRED Establish an encrypted connection if the server supports encrypted connections, otherwise fallback to an unencrypted connection.
REQUIRED Establish an encrypted connection if the server supports encrypted connections, otherwise the connection fails.
TUNNEL Establish an encrypted connection based on VERIFY_CA, additionally perform identity verification by checking the hostname.
VERIFY_CA Establish an encrypted connection based on REQUIRED with verify the server Certificate Authority (CA) certificates.
VERIFY_IDENTITY Establish an encrypted connection based on VERIFY_CA, additionally perform identity verification by checking the hostname.

Method Summary

Modifier and Type	Method and Description
boolean	requireSsl() Check if SSL is required.
boolean	startSsl() Check if need prepare SSL after connection has created.
static SslMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SslMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
boolean	verifyCertificate() Check if the client will verify the server certificate.
boolean	verifyIdentity() Check if the client will verify the server certificate and hostname/ip in the certificate.

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 SslMode DISABLED

Establish an unencrypted connection.

In other words: I don't care about security and don't want to pay the overhead for encryption.

PREFERRED

public static final SslMode PREFERRED

Establish an encrypted connection if the server supports encrypted connections, otherwise fallback to an unencrypted connection.

In other words: I don't care about encryption but will pay the overhead of encryption if the server supports it.

REQUIRED

public static final SslMode REQUIRED

Establish an encrypted connection if the server supports encrypted connections, otherwise the connection fails.

In other words: I want my data to be encrypted, and I accept the overhead. I trust that the network will make sure I always connect to the server I want.

VERIFY_CA

public static final SslMode VERIFY_CA

Establish an encrypted connection based on REQUIRED with verify the server Certificate Authority (CA) certificates. The connection attempt fails if CA certificates mismatched.

In other words: I want my data encrypted, and I accept the overhead. I want to be sure that I connect to a server that I trust.

VERIFY_IDENTITY

public static final SslMode VERIFY_IDENTITY

Establish an encrypted connection based on VERIFY_CA, additionally perform identity verification by checking the hostname. The connection attempt fails if the identity mismatched.

In other words: I want my data encrypted, and I accept the overhead. I want to be sure that I connect to a server I trust, and that it's the one I specify.

TUNNEL

public static final SslMode TUNNEL

Establish an encrypted connection based on VERIFY_CA, additionally perform identity verification by checking the hostname. The connection attempt fails if the identity mismatched.

In other words: I want to connect to a SSL proxy without using MySQL's SSL protocol.

Method Detail

values

public static SslMode[] 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 (SslMode c : SslMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static SslMode 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

requireSsl

public final boolean requireSsl()

Check if SSL is required.

Returns:

if SSL is required.

startSsl

public final boolean startSsl()

Check if need prepare SSL after connection has created.

Returns:

if need prepare SSL.

verifyCertificate

public final boolean verifyCertificate()

Check if the client will verify the server certificate.

Returns:

if driver will verify.

verifyIdentity

public final boolean verifyIdentity()

Check if the client will verify the server certificate and hostname/ip in the certificate.

Returns:

if driver will verify.