001: /*
002: * ====================================================================
003: *
004: * The Apache Software License, Version 1.1
005: *
006: * Copyright (c) 1999 The Apache Software Foundation. All rights
007: * reserved.
008: *
009: * Redistribution and use in source and binary forms, with or without
010: * modification, are permitted provided that the following conditions
011: * are met:
012: *
013: * 1. Redistributions of source code must retain the above copyright
014: * notice, this list of conditions and the following disclaimer.
015: *
016: * 2. Redistributions in binary form must reproduce the above copyright
017: * notice, this list of conditions and the following disclaimer in
018: * the documentation and/or other materials provided with the
019: * distribution.
020: *
021: * 3. The end-user documentation included with the redistribution, if
022: * any, must include the following acknowlegement:
023: * "This product includes software developed by the
024: * Apache Software Foundation (http://www.apache.org/)."
025: * Alternately, this acknowlegement may appear in the software itself,
026: * if and wherever such third-party acknowlegements normally appear.
027: *
028: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
029: * Foundation" must not be used to endorse or promote products derived
030: * from this software without prior written permission. For written
031: * permission, please contact apache@apache.org.
032: *
033: * 5. Products derived from this software may not be called "Apache"
034: * nor may "Apache" appear in their names without prior written
035: * permission of the Apache Group.
036: *
037: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
038: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
039: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
040: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
041: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
042: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
043: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
044: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
045: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
046: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
047: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
048: * SUCH DAMAGE.
049: * ====================================================================
050: *
051: * This software consists of voluntary contributions made by many
052: * individuals on behalf of the Apache Software Foundation. For more
053: * information on the Apache Software Foundation, please see
054: * <http://www.apache.org/>.
055: *
056: * [Additional notices, if required by prior licensing conditions]
057: *
058: */
059:
060: package org.apache.catalina.net;
061:
062: import java.io.IOException;
063: import java.net.InetAddress;
064: import java.net.ServerSocket;
065: import java.security.KeyStoreException;
066: import java.security.NoSuchAlgorithmException;
067: import java.security.cert.CertificateException;
068: import java.security.UnrecoverableKeyException;
069: import java.security.KeyManagementException;
070:
071: /**
072: * Interface that describes the common characteristics of factory classes
073: * that create server sockets which may be required by a Connector. A concrete
074: * implementation of this interface will be assigned to a Connector
075: * via the <code>setFactory()</code> method.
076: *
077: * @author db@eng.sun.com
078: * @author Harish Prabandham
079: * @author Craig R. McClanahan
080: */
081: public interface ServerSocketFactory {
082:
083: // --------------------------------------------------------- Public Methods
084:
085: /**
086: * Returns a server socket which uses all network interfaces on
087: * the host, and is bound to a the specified port. The socket is
088: * configured with the socket options (such as accept timeout)
089: * given to this factory.
090: *
091: * @param port the port to listen to
092: *
093: * @exception IOException input/output or network error
094: * @exception KeyStoreException error instantiating the
095: * KeyStore from file (SSL only)
096: * @exception NoSuchAlgorithmException KeyStore algorithm unsupported
097: * by current provider (SSL only)
098: * @exception CertificateException general certificate error (SSL only)
099: * @exception UnrecoverableKeyException internal KeyStore problem with
100: * the certificate (SSL only)
101: * @exception KeyManagementException problem in the key management
102: * layer (SSL only)
103: */
104: public ServerSocket createSocket(int port) throws IOException,
105: KeyStoreException, NoSuchAlgorithmException,
106: CertificateException, UnrecoverableKeyException,
107: KeyManagementException;
108:
109: /**
110: * Returns a server socket which uses all network interfaces on
111: * the host, is bound to a the specified port, and uses the
112: * specified connection backlog. The socket is configured with
113: * the socket options (such as accept timeout) given to this factory.
114: *
115: * @param port the port to listen to
116: * @param backlog how many connections are queued
117: *
118: * @exception IOException input/output or network error
119: * @exception KeyStoreException error instantiating the
120: * KeyStore from file (SSL only)
121: * @exception NoSuchAlgorithmException KeyStore algorithm unsupported
122: * by current provider (SSL only)
123: * @exception CertificateException general certificate error (SSL only)
124: * @exception UnrecoverableKeyException internal KeyStore problem with
125: * the certificate (SSL only)
126: * @exception KeyManagementException problem in the key management
127: * layer (SSL only)
128: */
129: public ServerSocket createSocket(int port, int backlog)
130: throws IOException, KeyStoreException,
131: NoSuchAlgorithmException, CertificateException,
132: UnrecoverableKeyException, KeyManagementException;
133:
134: /**
135: * Returns a server socket which uses only the specified network
136: * interface on the local host, is bound to a the specified port,
137: * and uses the specified connection backlog. The socket is configured
138: * with the socket options (such as accept timeout) given to this factory.
139: *
140: * @param port the port to listen to
141: * @param backlog how many connections are queued
142: * @param ifAddress the network interface address to use
143: *
144: * @exception IOException input/output or network error
145: * @exception KeyStoreException error instantiating the
146: * KeyStore from file (SSL only)
147: * @exception NoSuchAlgorithmException KeyStore algorithm unsupported
148: * by current provider (SSL only)
149: * @exception CertificateException general certificate error (SSL only)
150: * @exception UnrecoverableKeyException internal KeyStore problem with
151: * the certificate (SSL only)
152: * @exception KeyManagementException problem in the key management
153: * layer (SSL only)
154: */
155: public ServerSocket createSocket(int port, int backlog,
156: InetAddress ifAddress) throws IOException,
157: KeyStoreException, NoSuchAlgorithmException,
158: CertificateException, UnrecoverableKeyException,
159: KeyManagementException;
160:
161: }
|