SocketFactory.java

/*
   Copyright (C) 2002 MySQL AB

      This program is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published by
      the Free Software Foundation; either version 2 of the License, or
      (at your option) any later version.

      This program is distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      GNU General Public License for more details.

      You should have received a copy of the GNU General Public License
      along with this program; if not, write to the Free Software
      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */
package com.mysql.jdbc;

import java.io.IOException;

import java.net.Socket;
import java.net.SocketException;

import java.util.Properties;


/**
 * Interface to allow pluggable socket creation in the driver
 *
 * @author Mark Matthews
 */
public interface SocketFactory {
    /**
     * Called by the driver after issuing the MySQL protocol handshake and
     * reading the results of the handshake.
     *
     * @throws SocketException if a socket error occurs
     * @throws IOException if an I/O error occurs
     *
     * @return the socket to use after the handshake
     */
    Socket afterHandshake() throws SocketException, IOException;

    /**
     * Called by the driver before issuing the MySQL protocol handshake.
     * Should return the socket instance that should be used during
     * the handshake.
     *
     * @throws SocketException if a socket error occurs
     * @throws IOException if an I/O error occurs
     *
     * @return the socket to use before the handshake
     */
    Socket beforeHandshake() throws SocketException, IOException;

    /**
     * Creates a new socket 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
     * <code>com.mysql.jdbc.StandardSocketFactory</code>  Implementing classes
     * are responsible for handling synchronization of this method (if
     * needed).
     *
     * @param host the hostname passed in the JDBC URL. It will be a single
     * hostname, as the driver parses multi-hosts (for failover) and calls this
     * method for each host connection attempt.
     *
     * @param props properties passed to the driver via the URL and/or properties
     *               instance.
     *
     * @return a socket connected to the given host
     * @throws SocketException if a socket error occurs
     * @throws IOException if an I/O error occurs
     */
    Socket connect(String host, Properties props)
        throws SocketException, IOException;
}