01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: * This interface will be implemented by any object that
22: * uses TcpConnections. It is supported by the pool tcp
23: * connection manager and should be supported by future
24: * managers.
25: * The goal is to decouple the connection handler from
26: * the thread, socket and pooling complexity.
27: */
28: public interface TcpConnectionHandler {
29:
30: /** Add informations about the a "controler" object
31: * specific to the server. In tomcat it will be a
32: * ContextManager.
33: * @deprecated This has nothing to do with TcpHandling,
34: * was used as a workaround
35: */
36: public void setServer(Object manager);
37:
38: /** Used to pass config informations to the handler.
39: *
40: * @deprecated This has nothing to do with Tcp,
41: * was used as a workaround.
42: */
43: public void setAttribute(String name, Object value);
44:
45: /** Called before the call to processConnection.
46: * If the thread is reused, init() should be called once per thread.
47: *
48: * It may look strange, but it's a _very_ good way to avoid synchronized
49: * methods and keep per thread data.
50: *
51: * Assert: the object returned from init() will be passed to
52: * all processConnection() methods happening in the same thread.
53: *
54: */
55: public Object[] init();
56:
57: /**
58: * Assert: connection!=null
59: * Assert: connection.getSocket() != null
60: * Assert: thData != null and is the result of calling init()
61: * Assert: thData is preserved per Thread.
62: */
63: public void processConnection(TcpConnection connection,
64: Object thData[]);
65: }
|