Home » apache-tomcat-6.0.26-src » org.apache » tomcat » util » net » [javadoc | source]
org.apache.tomcat.util.net
abstract public class: ServerSocketFactory [javadoc | source]
java.lang.Object
   org.apache.tomcat.util.net.ServerSocketFactory

All Implemented Interfaces:
    Cloneable

Direct Known Subclasses:
    JSSE14SocketFactory, JSSE15SocketFactory, PureTLSSocketFactory, JSSESocketFactory, DefaultServerSocketFactory, JSSE13SocketFactory

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 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 two categories of methods. First are methods used to create sockets. Second are methods which set properties used in the production of sockets, such as networking options. There is also an environment specific default server socket factory; frameworks will often use their own customized factory.


It may be desirable to move this interface into the java.net package, so that is not an extension but the preferred interface. Should this be serializable, making it a JavaBean which can be saved along with its networking configuration?
Field Summary
protected  Hashtable attributes     
Constructor:
 protected ServerSocketFactory() 
Method from org.apache.tomcat.util.net.ServerSocketFactory Summary:
acceptSocket,   createSocket,   createSocket,   createSocket,   getDefault,   handshake,   initSocket,   setAttribute
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.tomcat.util.net.ServerSocketFactory Detail:
 abstract public Socket acceptSocket(ServerSocket socket) throws IOException
    Wrapper function for accept(). This allows us to trap and translate exceptions if necessary
 abstract public ServerSocket createSocket(int port) throws IOException, InstantiationException
    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.
 abstract public ServerSocket createSocket(int port,
    int backlog) throws IOException, InstantiationException
    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.
 abstract public ServerSocket createSocket(int port,
    int backlog,
    InetAddress ifAddress) throws IOException, InstantiationException
    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.
 public static synchronized ServerSocketFactory getDefault() 
    Returns a copy of the environment's default socket factory.
 abstract public  void handshake(Socket sock) throws IOException
    Extra function to initiate the handshake. Sometimes necessary for SSL
 public  void initSocket(Socket s) 
 public  void setAttribute(String name,
    Object value) 
    General mechanism to pass attributes from the ServerConnector to the socket factory. Note that the "prefered" mechanism is to use bean setters and explicit methods, but this allows easy configuration via server.xml or simple Properties