1
2
3 /*
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
5 *
6 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
7 *
8 * Portions Copyright Apache Software Foundation.
9 *
10 * The contents of this file are subject to the terms of either the GNU
11 * General Public License Version 2 only ("GPL") or the Common Development
12 * and Distribution License("CDDL") (collectively, the "License"). You
13 * may not use this file except in compliance with the License. You can obtain
14 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
15 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
16 * language governing permissions and limitations under the License.
17 *
18 * When distributing the software, include this License Header Notice in each
19 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
20 * Sun designates this particular file as subject to the "Classpath" exception
21 * as provided by Sun in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the License
23 * Header, with the fields enclosed by brackets [] replaced by your own
24 * identifying information: "Portions Copyrighted [year]
25 * [name of copyright owner]"
26 *
27 * Contributor(s):
28 *
29 * If you wish your version of this file to be governed by only the CDDL or
30 * only the GPL Version 2, indicate your decision by adding "[Contributor]
31 * elects to include this software in this distribution under the [CDDL or GPL
32 * Version 2] license." If you don't indicate a single choice of license, a
33 * recipient has the option to distribute your version of this file under
34 * either the CDDL, the GPL Version 2 or to extend the choice of license to
35 * its licensees as provided above. However, if you add GPL Version 2 code
36 * and therefore, elected the GPL Version 2 license, then the option applies
37 * only if the new code is made subject to such option by the copyright
38 * holder.
39 */
40
41 package org.apache.tomcat.util.net;
42
43 import java.io;
44 import java.net;
45 import java.util;
46 import org.apache.tomcat.util;
47
48 /**
49 * This interface will be implemented by any object that
50 * uses TcpConnections. It is supported by the pool tcp
51 * connection manager and should be supported by future
52 * managers.
53 * The goal is to decouple the connection handler from
54 * the thread, socket and pooling complexity.
55 */
56 public interface TcpConnectionHandler {
57
58 /** Add informations about the a "controler" object
59 * specific to the server. In tomcat it will be a
60 * ContextManager.
61 * @deprecated This has nothing to do with TcpHandling,
62 * was used as a workaround
63 */
64 public void setServer(Object manager);
65
66
67 /** Used to pass config informations to the handler
68 * @deprecated. This has nothing to do with Tcp,
69 * was used as a workaround
70 */
71 public void setAttribute(String name, Object value );
72
73 /** Called before the call to processConnection.
74 * If the thread is reused, init() should be called once per thread.
75 *
76 * It may look strange, but it's a _very_ good way to avoid synchronized
77 * methods and keep per thread data.
78 *
79 * Assert: the object returned from init() will be passed to
80 * all processConnection() methods happening in the same thread.
81 *
82 */
83 public Object[] init( );
84
85 /**
86 * Assert: connection!=null
87 * Assert: connection.getSocket() != null
88 * Assert: thData != null and is the result of calling init()
89 * Assert: thData is preserved per Thread.
90 */
91 public void processConnection(TcpConnection connection, Object thData[]);
92 }
Save This Page