com.mysql.cj.protocol

Class SocksProxySocketFactory

java.lang.Object

com.mysql.cj.protocol.StandardSocketFactory

com.mysql.cj.protocol.SocksProxySocketFactory

All Implemented Interfaces:

SocketFactory, SocketMetadata

public class SocksProxySocketFactory
extends StandardSocketFactory

A socket factory used to create sockets connecting through a SOCKS proxy. The socket still supports all the same TCP features as the "standard" socket.

Field Summary

Fields inherited from class com.mysql.cj.protocol.StandardSocketFactory

host, loginTimeoutCheckTimestamp, loginTimeoutCountdown, port, rawSocket, socketTimeoutBackup, sslSocket

Constructor Summary

Constructors

Constructor and Description
SocksProxySocketFactory()

Method Summary

Modifier and Type	Method and Description
<T extends java.io.Closeable> T	connect(java.lang.String hostname, int portNumber, PropertySet pset, int loginTimeout) Creates a new socket or channel using the given properties.
protected java.net.Socket	createSocket(PropertySet props) Create the raw socket.

Methods inherited from class com.mysql.cj.protocol.StandardSocketFactory

afterHandshake, beforeHandshake, configureSocket, getRealTimeout, performTlsHandshake, performTlsHandshake, resetLoginTimeCountdown

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mysql.cj.protocol.SocketMetadata

isLocallyConnected, isLocallyConnected

Constructor Detail

SocksProxySocketFactory

public SocksProxySocketFactory()

Method Detail

createSocket

protected java.net.Socket createSocket(PropertySet props)

Description copied from class: StandardSocketFactory

Create the raw socket.

Overrides:

createSocket in class StandardSocketFactory

Parameters:

props - properties available to affect behaviour during socket creation.

Returns:

socket

connect

public <T extends java.io.Closeable> T connect(java.lang.String hostname,
                                               int portNumber,
                                               PropertySet pset,
                                               int loginTimeout)
                                        throws java.io.IOException

Description copied from interface: SocketFactory

Creates a new socket or channel using the given properties. Properties are parsed by the driver from the URL. All properties other than sensitive ones (user and password) are passed to this method. The driver will instantiate the socket factory with the class name given in the property "socketFactory", where the standard is com.mysql.cj.protocol.StandardSocketFactory Implementing classes are responsible for handling synchronization of this method (if needed).

Specified by:

connect in interface SocketFactory

Overrides:

connect in class StandardSocketFactory

Type Parameters:

T - result type

Parameters:

hostname - the hostname passed in the URL. It will be a single hostname, as the driver parses multi-hosts (for failover) and calls this method for each host connection attempt.

portNumber - the port number to connect to (if required).

pset - properties passed to the driver via the URL and/or properties instance.

loginTimeout - login timeout in milliseconds

Returns:

a socket connected to the given host

Throws:

java.io.IOException - if an I/O error occurs