org.mariadb.jdbc.tls

Interface TlsSocketPlugin

All Known Implementing Classes:

DefaultTlsSocketPlugin

public interface TlsSocketPlugin

Method Summary

Modifier and Type	Method and Description
default javax.net.ssl.SSLSocket	createSocket(java.net.Socket socket, javax.net.ssl.SSLSocketFactory sslSocketFactory) Returns a socket layered over an existing socket negotiating the use of SSL over an existing socket.
javax.net.ssl.SSLSocketFactory	getSocketFactory(Options options) Get socket factory.
java.lang.String	name() plugin name.
java.lang.String	type() plugin type.
void	verify(java.lang.String host, javax.net.ssl.SSLSession sslSession, Options options, long serverThreadId) Host name verifier implementation.

Method Detail

name

java.lang.String name()

plugin name.

Returns:

plugin name. ex: Mysql native password

type

java.lang.String type()

plugin type.

Returns:

plugin type

getSocketFactory

javax.net.ssl.SSLSocketFactory getSocketFactory(Options options)
                                         throws java.sql.SQLException

Get socket factory.

Parameters:

options - connection string option. Non standard option are stored in `nonMappedOptions` if any specific option is needed.

Returns:

custom SSL socket factory

Throws:

java.sql.SQLException - if socket factory configuration failed.

createSocket

default javax.net.ssl.SSLSocket createSocket(java.net.Socket socket,
                                             javax.net.ssl.SSLSocketFactory sslSocketFactory)
                                      throws java.io.IOException

Returns a socket layered over an existing socket negotiating the use of SSL over an existing socket.

Parameters:

socket - existing socket

sslSocketFactory - SSL socket factory

Returns:

SSL socket

Throws:

java.io.IOException - if any socket error occurs.

verify

void verify(java.lang.String host,
            javax.net.ssl.SSLSession sslSession,
            Options options,
            long serverThreadId)
     throws javax.net.ssl.SSLException

Host name verifier implementation.

Parameters:

host - hostname

sslSession - ssl session

options - connection string option. Non standard option are stored in * `nonMappedOptions` if any specific option is needed.

serverThreadId - current server threadId

Throws:

javax.net.ssl.SSLException - if verification fail