001: /****************************************************************
002: * Licensed to the Apache Software Foundation (ASF) under one *
003: * or more contributor license agreements. See the NOTICE file *
004: * distributed with this work for additional information *
005: * regarding copyright ownership. The ASF licenses this file *
006: * to you under the Apache License, Version 2.0 (the *
007: * "License"); you may not use this file except in compliance *
008: * with the License. You may obtain a copy of the License at *
009: * *
010: * http://www.apache.org/licenses/LICENSE-2.0 *
011: * *
012: * Unless required by applicable law or agreed to in writing, *
013: * software distributed under the License is distributed on an *
014: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
015: * KIND, either express or implied. See the License for the *
016: * specific language governing permissions and limitations *
017: * under the License. *
018: ****************************************************************/package org.apache.james.services;
019:
020: import org.apache.avalon.cornerstone.services.connection.ConnectionManager;
021: import java.net.ServerSocket;
022: import org.apache.excalibur.thread.ThreadPool;
023: import org.apache.avalon.cornerstone.services.connection.ConnectionHandlerFactory;
024:
025: /**
026: * This interface extends the standard ConnectionManager interface to allow
027: * connectionLimits to be specified on a per service basis
028: **/
029: public interface JamesConnectionManager extends ConnectionManager {
030: /**
031: * The component role used by components implementing this service
032: */
033: String ROLE = "org.apache.james.services.JamesConnectionManager";
034:
035: /**
036: * Returns the default maximum number of open connections supported by this
037: * SimpleConnectionManager
038: *
039: * @return the maximum number of connections
040: */
041: int getMaximumNumberOfOpenConnections();
042:
043: /**
044: * Start managing a connection.
045: * Management involves accepting connections and farming them out to threads
046: * from pool to be handled.
047: *
048: * @param name the name of connection
049: * @param socket the ServerSocket from which to
050: * @param handlerFactory the factory from which to acquire handlers
051: * @param threadPool the thread pool to use
052: * @param maxOpenConnections the maximum number of open connections allowed for this server socket.
053: * @exception Exception if an error occurs
054: */
055: void connect(String name, ServerSocket socket,
056: ConnectionHandlerFactory handlerFactory,
057: ThreadPool threadPool, int maxOpenConnections)
058: throws Exception;
059:
060: /**
061: * Start managing a connection.
062: * This is similar to other connect method except that it uses default thread pool.
063: *
064: * @param name the name of connection
065: * @param socket the ServerSocket from which to
066: * @param handlerFactory the factory from which to acquire handlers
067: * @param maxOpenConnections the maximum number of open connections allowed for this server socket.
068: * @exception Exception if an error occurs
069: */
070: void connect(String name, ServerSocket socket,
071: ConnectionHandlerFactory handlerFactory,
072: int maxOpenConnections) throws Exception;
073:
074: /**
075: * Start managing a connection.
076: * Management involves accepting connections and farming them out to threads
077: * from pool to be handled.
078: *
079: * @param name the name of connection
080: * @param socket the ServerSocket from which to
081: * @param handlerFactory the factory from which to acquire handlers
082: * @param threadPool the thread pool to use
083: * @exception Exception if an error occurs
084: */
085: void connect(String name, ServerSocket socket,
086: ConnectionHandlerFactory handlerFactory,
087: ThreadPool threadPool) throws Exception;
088:
089: /**
090: * Start managing a connection.
091: * Management involves accepting connections and farming them out to threads
092: * from pool to be handled.
093: *
094: * @param name the name of connection
095: * @param socket the ServerSocket from which to
096: * @param handlerFactory the factory from which to acquire handlers
097: * @exception Exception if an error occurs
098: */
099: void connect(String name, ServerSocket socket,
100: ConnectionHandlerFactory handlerFactory) throws Exception;
101:
102: }
|