ServerSocketFactory

public abstract class ServerSocketFactory extends Object

Known Direct Subclasses SSLServerSocketFactory SSLServerSocketFactory SSLServerSocketFactorys create SSLServerSockets.

This class creates server sockets. It may be subclassed by other factories, which create particular types of server sockets. This provides a general framework for the addition of public socket-level functionality. It is the server side analogue of a socket factory, and similarly provides a way to capture a variety of policies related to the sockets being constructed.

Like socket factories, server Socket factory instances have methods used to create sockets. There is also an environment specific default server socket factory; frameworks will often use their own customized factory.

See Also

• SocketFactory

Protected Constructor Summary

ServerSocketFactory() Creates a server socket factory.

Public Method Summary

abstract ServerSocket	createServerSocket(int port) Returns a server socket bound to the specified port.
ServerSocket	createServerSocket() Returns an unbound server socket.
abstract ServerSocket	createServerSocket(int port, int backlog, InetAddress ifAddress) Returns a server socket bound to the specified port, with a specified listen backlog and local IP.
abstract ServerSocket	createServerSocket(int port, int backlog) Returns a server socket bound to the specified port, and uses the specified connection backlog.
static ServerSocketFactory	getDefault() Returns a copy of the environment's default socket factory.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Protected Constructors

protected ServerSocketFactory ()

Creates a server socket factory.

Public Methods

public abstract ServerSocket createServerSocket (int port)

Returns a server socket bound to the specified port. The socket is configured with the socket options (such as accept timeout) given to this factory.

If there is a security manager, its checkListen method is called with the port argument as its argument to ensure the operation is allowed. This could result in a SecurityException.

Parameters

port	the port to listen to

Returns

• the ServerSocket

Throws

IOException	for networking errors
SecurityException	if a security manager exists and its checkListen method doesn't allow the operation.
IllegalArgumentException	if the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive.

See Also

• SecurityManager.checkListen(int)
• ServerSocket.ServerSocket(int)

public ServerSocket createServerSocket ()

Returns an unbound server socket. The socket is configured with the socket options (such as accept timeout) given to this factory.

Returns

• the unbound socket

Throws

IOException	if the socket cannot be created

See Also

• ServerSocket.bind(java.net.SocketAddress)
• ServerSocket.bind(java.net.SocketAddress, int)
• ServerSocket.ServerSocket()

public abstract ServerSocket createServerSocket (int port, int backlog, InetAddress ifAddress)

Returns a server socket bound to the specified port, with a specified listen backlog and local IP.

The ifAddress argument can be used on a multi-homed host for a ServerSocket that will only accept connect requests to one of its addresses. If ifAddress is null, it will accept connections on all local addresses. The socket is configured with the socket options (such as accept timeout) given to this factory.

The backlog argument must be a positive value greater than 0. If the value passed if equal or less than 0, then the default value will be assumed.

If there is a security manager, its checkListen method is called with the port argument as its argument to ensure the operation is allowed. This could result in a SecurityException.

Parameters

port	the port to listen to
backlog	how many connections are queued
ifAddress	the network interface address to use

Returns

• the ServerSocket

Throws

IOException	for networking errors
SecurityException	if a security manager exists and its checkListen method doesn't allow the operation.
IllegalArgumentException	if the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive.

See Also

• SecurityManager.checkListen(int)
• ServerSocket.ServerSocket(int, int, java.net.InetAddress)

public abstract ServerSocket createServerSocket (int port, int backlog)

Returns a server socket bound to the specified port, and uses the specified connection backlog. The socket is configured with the socket options (such as accept timeout) given to this factory.

The backlog argument must be a positive value greater than 0. If the value passed if equal or less than 0, then the default value will be assumed.

If there is a security manager, its checkListen method is called with the port argument as its argument to ensure the operation is allowed. This could result in a SecurityException.

Parameters

port	the port to listen to
backlog	how many connections are queued

Returns

• the ServerSocket

Throws

IOException	for networking errors
SecurityException	if a security manager exists and its checkListen method doesn't allow the operation.
IllegalArgumentException	if the port parameter is outside the specified range of valid port values, which is between 0 and 65535, inclusive.

See Also

• SecurityManager.checkListen(int)
• ServerSocket.ServerSocket(int, int)

public static ServerSocketFactory getDefault ()

Returns a copy of the environment's default socket factory.

Returns

• the ServerSocketFactory