org.apache.commons.net
Interface SocketFactory

All Known Implementing Classes:

DefaultSocketFactory

public interface SocketFactory

The SocketFactory interface provides a means for the programmer to control the creation of sockets and provide his own Socket implementations for use by all classes derived from SocketClient . This allows you to provide your own Socket implementations and to perform security checks or browser capability requests before creating a Socket.

Author:

Daniel F. Savarese

See Also:

DefaultSocketFactory

Method Summary

java.net.ServerSocket	createServerSocket(int port) Creates a ServerSocket bound to a specified port.
java.net.ServerSocket	createServerSocket(int port, int backlog) Creates a ServerSocket bound to a specified port with a given maximum queue length for incoming connections.
java.net.ServerSocket	createServerSocket(int port, int backlog, java.net.InetAddress bindAddr) Creates a ServerSocket bound to a specified port on a given local address with a given maximum queue length for incoming connections.
java.net.Socket	createSocket(java.net.InetAddress address, int port) Creates a Socket connected to the given host and port.
java.net.Socket	createSocket(java.net.InetAddress address, int port, java.net.InetAddress localAddr, int localPort) Creates a Socket connected to the given host and port and originating from the specified local address and port.
java.net.Socket	createSocket(java.lang.String host, int port) Creates a Socket connected to the given host and port.
java.net.Socket	createSocket(java.lang.String host, int port, java.net.InetAddress localAddr, int localPort) Creates a Socket connected to the given host and port and originating from the specified local address and port.

Method Detail

createSocket

public java.net.Socket createSocket(java.lang.String host,
                                    int port)
                             throws java.net.UnknownHostException,
                                    java.io.IOException

Creates a Socket connected to the given host and port.

Parameters:

host - The hostname to connect to.

port - The port to connect to.

Returns:

A Socket connected to the given host and port.

Throws:

java.net.UnknownHostException - If the hostname cannot be resolved.

java.io.IOException - If an I/O error occurs while creating the Socket.

createSocket

public java.net.Socket createSocket(java.net.InetAddress address,
                                    int port)
                             throws java.io.IOException

Creates a Socket connected to the given host and port.

Parameters:

address - The address of the host to connect to.

port - The port to connect to.

Returns:

A Socket connected to the given host and port.

Throws:

java.io.IOException - If an I/O error occurs while creating the Socket.

createSocket

public java.net.Socket createSocket(java.lang.String host,
                                    int port,
                                    java.net.InetAddress localAddr,
                                    int localPort)
                             throws java.net.UnknownHostException,
                                    java.io.IOException

Creates a Socket connected to the given host and port and originating from the specified local address and port.

Parameters:

host - The hostname to connect to.

port - The port to connect to.

localAddr - The local address to use.

localPort - The local port to use.

Returns:

A Socket connected to the given host and port.

Throws:

java.net.UnknownHostException - If the hostname cannot be resolved.

java.io.IOException - If an I/O error occurs while creating the Socket.

createSocket

public java.net.Socket createSocket(java.net.InetAddress address,
                                    int port,
                                    java.net.InetAddress localAddr,
                                    int localPort)
                             throws java.io.IOException

Creates a Socket connected to the given host and port and originating from the specified local address and port.

Parameters:

address - The address of the host to connect to.

port - The port to connect to.

localAddr - The local address to use.

localPort - The local port to use.

Returns:

A Socket connected to the given host and port.

Throws:

java.io.IOException - If an I/O error occurs while creating the Socket.

createServerSocket

public java.net.ServerSocket createServerSocket(int port)
                                         throws java.io.IOException

Creates a ServerSocket bound to a specified port. A port of 0 will create the ServerSocket on a system-determined free port.

Parameters:

port - The port on which to listen, or 0 to use any free port.

Returns:

A ServerSocket that will listen on a specified port.

Throws:

java.io.IOException - If an I/O error occurs while creating the ServerSocket.

createServerSocket

public java.net.ServerSocket createServerSocket(int port,
                                                int backlog)
                                         throws java.io.IOException

Creates a ServerSocket bound to a specified port with a given maximum queue length for incoming connections. A port of 0 will create the ServerSocket on a system-determined free port.

Parameters:

port - The port on which to listen, or 0 to use any free port.

backlog - The maximum length of the queue for incoming connections.

Returns:

A ServerSocket that will listen on a specified port.

Throws:

java.io.IOException - If an I/O error occurs while creating the ServerSocket.

createServerSocket

public java.net.ServerSocket createServerSocket(int port,
                                                int backlog,
                                                java.net.InetAddress bindAddr)
                                         throws java.io.IOException

Creates a ServerSocket bound to a specified port on a given local address with a given maximum queue length for incoming connections. A port of 0 will create the ServerSocket on a system-determined free port.

Parameters:

port - The port on which to listen, or 0 to use any free port.

backlog - The maximum length of the queue for incoming connections.

bindAddr - The local address to which the ServerSocket should bind.

Returns:

A ServerSocket that will listen on a specified port.

Throws:

java.io.IOException - If an I/O error occurs while creating the ServerSocket.