org.apache.commons.net

Interface SocketFactory

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 {@link org.apache.commons.net.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:

Method Summary
ServerSocketcreateServerSocket(int port)
Creates a ServerSocket bound to a specified port.
ServerSocketcreateServerSocket(int port, int backlog)
Creates a ServerSocket bound to a specified port with a given maximum queue length for incoming connections.
ServerSocketcreateServerSocket(int port, int backlog, InetAddress bindAddr)
Creates a ServerSocket bound to a specified port on a given local address with a given maximum queue length for incoming connections.
SocketcreateSocket(String host, int port)
Creates a Socket connected to the given host and port.
SocketcreateSocket(InetAddress address, int port)
Creates a Socket connected to the given host and port.
SocketcreateSocket(String host, int port, InetAddress localAddr, int localPort)
Creates a Socket connected to the given host and port and originating from the specified local address and port.
SocketcreateSocket(InetAddress address, int port, 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

createServerSocket

public ServerSocket createServerSocket(int port)
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: IOException If an I/O error occurs while creating the ServerSocket.

createServerSocket

public ServerSocket createServerSocket(int port, int backlog)
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: IOException If an I/O error occurs while creating the ServerSocket.

createServerSocket

public ServerSocket createServerSocket(int port, int backlog, InetAddress bindAddr)
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: IOException If an I/O error occurs while creating the ServerSocket.

createSocket

public Socket createSocket(String host, int port)
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: UnknownHostException If the hostname cannot be resolved. IOException If an I/O error occurs while creating the Socket.

createSocket

public Socket createSocket(InetAddress address, int port)
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: IOException If an I/O error occurs while creating the Socket.

createSocket

public Socket createSocket(String host, int port, InetAddress localAddr, int localPort)
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: UnknownHostException If the hostname cannot be resolved. IOException If an I/O error occurs while creating the Socket.

createSocket

public Socket createSocket(InetAddress address, int port, InetAddress localAddr, int localPort)
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: IOException If an I/O error occurs while creating the Socket.