org.apache.catalina.net

Interface ServerSocketFactory

All Known Implementing Classes:

CoyoteServerSocketFactory, DefaultServerSocketFactory, SSLSocketFactory

public interface ServerSocketFactory

Interface that describes the common characteristics of factory classes that create server sockets which may be required by a Connector. A concrete implementation of this interface will be assigned to a Connector via the setFactory() method.

Author:

[email protected], Harish Prabandham, Craig R. McClanahan

Method Summary

Modifier and Type	Method and Description
ServerSocket	createSocket(int port) Returns a server socket which uses all network interfaces on the host, and is bound to a the specified port.
ServerSocket	createSocket(int port, int backlog) Returns a server socket which uses all network interfaces on the host, is bound to a the specified port, and uses the specified connection backlog.
ServerSocket	createSocket(int port, int backlog, InetAddress ifAddress) Returns a server socket which uses only the specified network interface on the local host, is bound to a the specified port, and uses the specified connection backlog.

Method Detail

createSocket

ServerSocket createSocket(int port)
                   throws IOException,
                          KeyStoreException,
                          NoSuchAlgorithmException,
                          CertificateException,
                          UnrecoverableKeyException,
                          KeyManagementException

Returns a server socket which uses all network interfaces on the host, and is bound to a the specified port. The socket is configured with the socket options (such as accept timeout) given to this factory.

Parameters:

port - the port to listen to

Throws:

IOException - input/output or network error

KeyStoreException - error instantiating the KeyStore from file (SSL only)

NoSuchAlgorithmException - KeyStore algorithm unsupported by current provider (SSL only)

CertificateException - general certificate error (SSL only)

UnrecoverableKeyException - internal KeyStore problem with the certificate (SSL only)

KeyManagementException - problem in the key management layer (SSL only)

createSocket

ServerSocket createSocket(int port,
                          int backlog)
                   throws IOException,
                          KeyStoreException,
                          NoSuchAlgorithmException,
                          CertificateException,
                          UnrecoverableKeyException,
                          KeyManagementException

Returns a server socket which uses all network interfaces on the host, is bound to a 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.

Parameters:

port - the port to listen to

backlog - how many connections are queued

Throws:

IOException - input/output or network error

KeyStoreException - error instantiating the KeyStore from file (SSL only)

NoSuchAlgorithmException - KeyStore algorithm unsupported by current provider (SSL only)

CertificateException - general certificate error (SSL only)

UnrecoverableKeyException - internal KeyStore problem with the certificate (SSL only)

KeyManagementException - problem in the key management layer (SSL only)

createSocket

ServerSocket createSocket(int port,
                          int backlog,
                          InetAddress ifAddress)
                   throws IOException,
                          KeyStoreException,
                          NoSuchAlgorithmException,
                          CertificateException,
                          UnrecoverableKeyException,
                          KeyManagementException

Returns a server socket which uses only the specified network interface on the local host, is bound to a 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.

Parameters:

port - the port to listen to

backlog - how many connections are queued

ifAddress - the network interface address to use

Throws:

IOException - input/output or network error

KeyStoreException - error instantiating the KeyStore from file (SSL only)

NoSuchAlgorithmException - KeyStore algorithm unsupported by current provider (SSL only)

CertificateException - general certificate error (SSL only)

UnrecoverableKeyException - internal KeyStore problem with the certificate (SSL only)

KeyManagementException - problem in the key management layer (SSL only)