KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tomcat > util > net > TcpConnectionHandler


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 package org.apache.tomcat.util.net;
19
20
21 /**
22  * This interface will be implemented by any object that
23  * uses TcpConnections. It is supported by the pool tcp
24  * connection manager and should be supported by future
25  * managers.
26  * The goal is to decouple the connection handler from
27  * the thread, socket and pooling complexity.
28  */
29 public interface TcpConnectionHandler {
30     
31     /** Add informations about the a "controler" object
32      * specific to the server. In tomcat it will be a
33      * ContextManager.
34      * @deprecated This has nothing to do with TcpHandling,
35      * was used as a workaround
36      */
37     public void setServer(Object JavaDoc manager);
38
39     
40     /** Used to pass config informations to the handler.
41      *
42      * @deprecated This has nothing to do with Tcp,
43      * was used as a workaround.
44      */
45     public void setAttribute(String JavaDoc name, Object JavaDoc value );
46     
47     /** Called before the call to processConnection.
48      * If the thread is reused, init() should be called once per thread.
49      *
50      * It may look strange, but it's a _very_ good way to avoid synchronized
51      * methods and keep per thread data.
52      *
53      * Assert: the object returned from init() will be passed to
54      * all processConnection() methods happening in the same thread.
55      *
56      */
57     public Object JavaDoc[] init( );
58
59     /**
60      * Assert: connection!=null
61      * Assert: connection.getSocket() != null
62      * Assert: thData != null and is the result of calling init()
63      * Assert: thData is preserved per Thread.
64      */
65     public void processConnection(TcpConnection connection, Object JavaDoc thData[]);
66 }
67
Popular Tags