Merge commit 'b459e462a5c3447d0693674253c40bc7385a4f66'

[fanfix.git] / serial / server / ConnectActionClientString.java

package be.nikiroo.utils.serial.server;

import java.io.IOException;
import java.net.Socket;
import java.net.UnknownHostException;

import be.nikiroo.utils.Version;

/**
 * Class used for the client basic handling.
 * <p>
 * It represents a single action: a client is expected to only execute one
 * action.
 * 
 * @author niki
 */
public class ConnectActionClientString extends ConnectActionClient {
	/**
	 * Create a new {@link ConnectActionClientString}.
	 * 
	 * @param s
	 *            the socket to bind to
	 * @param key
	 *            an optional key to encrypt all the communications (if NULL,
	 *            everything will be sent in clear text)
	 */
	public ConnectActionClientString(Socket s, String key) {
		super(s, key);
	}

	/**
	 * Create a new {@link ConnectActionClientString}.
	 * 
	 * @param s
	 *            the socket to bind to
	 * @param key
	 *            an optional key to encrypt all the communications (if NULL,
	 *            everything will be sent in clear text)
	 * @param clientVersion
	 *            the version of this client
	 */
	public ConnectActionClientString(Socket s, String key, Version clientVersion) {
		super(s, key, clientVersion);
	}

	/**
	 * Create a new {@link ConnectActionClientString}.
	 * 
	 * @param host
	 *            the host to bind to
	 * @param port
	 *            the port to bind to
	 * @param key
	 *            an optional key to encrypt all the communications (if NULL,
	 *            everything will be sent in clear text)
	 * 
	 * @throws IOException
	 *             in case of I/O error
	 * @throws UnknownHostException
	 *             if the IP address of the host could not be determined
	 * @throws IllegalArgumentException
	 *             if the port parameter is outside the specified range of valid
	 *             port values, which is between 0 and 65535, inclusive
	 */
	public ConnectActionClientString(String host, int port, String key)
			throws IOException {
		super(host, port, key);
	}

	/**
	 * Create a new {@link ConnectActionClientString}.
	 * 
	 * @param host
	 *            the host to bind to
	 * @param port
	 *            the port to bind to
	 * @param key
	 *            an optional key to encrypt all the communications (if NULL,
	 *            everything will be sent in clear text)
	 * @param clientVersion
	 *            the version of this client
	 * 
	 * @throws IOException
	 *             in case of I/O error
	 * @throws UnknownHostException
	 *             if the IP address of the host could not be determined
	 * @throws IllegalArgumentException
	 *             if the port parameter is outside the specified range of valid
	 *             port values, which is between 0 and 65535, inclusive
	 */
	public ConnectActionClientString(String host, int port, String key,
			Version clientVersion) throws IOException {
		super(host, port, key, clientVersion);
	}

	/**
	 * Send the given object to the server (and return the answer).
	 * 
	 * @param data
	 *            the data to send
	 * 
	 * @return the answer, which can be NULL
	 * 
	 * @throws IOException
	 *             in case of I/O error
	 */
	public String send(String data) throws IOException {
		return action.sendString(data);
	}

	// Deprecated //

	/**
	 * @deprecated SSL support has been replaced by key-based encryption.
	 *             <p>
	 *             Please use the version with key encryption (this deprecated
	 *             version uses an empty key when <tt>ssl</tt> is TRUE and no
	 *             key (NULL) when <tt>ssl</tt> is FALSE).
	 */
	@Deprecated
	public ConnectActionClientString(String host, int port, boolean ssl)
			throws IOException {
		this(host, port, ssl ? "" : null);
	}

	/**
	 * @deprecated SSL support has been replaced by key-based encryption.
	 *             <p>
	 *             Please use the version with key encryption (this deprecated
	 *             version uses an empty key when <tt>ssl</tt> is TRUE and no
	 *             key (NULL) when <tt>ssl</tt> is FALSE).
	 */
	@Deprecated
	public ConnectActionClientString(String host, int port, boolean ssl,
			Version version) throws IOException {
		this(host, port, ssl ? "" : null, version);
	}

	/**
	 * @deprecated SSL support has been replaced by key-based encryption.
	 *             <p>
	 *             Please use the version with key encryption (this deprecated
	 *             version uses an empty key when <tt>ssl</tt> is TRUE and no
	 *             key (NULL) when <tt>ssl</tt> is FALSE).
	 */
	@SuppressWarnings("unused")
	@Deprecated
	public ConnectActionClientString(Socket s, boolean ssl) throws IOException {
		this(s, ssl ? "" : null);
	}

	/**
	 * @deprecated SSL support has been replaced by key-based encryption.
	 *             <p>
	 *             Please use the version with key encryption (this deprecated
	 *             version uses an empty key when <tt>ssl</tt> is TRUE and no
	 *             key (NULL) when <tt>ssl</tt> is FALSE).
	 */
	@SuppressWarnings("unused")
	@Deprecated
	public ConnectActionClientString(Socket s, boolean ssl, Version version)
			throws IOException {
		this(s, ssl ? "" : null, version);
	}
}