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.coyote;
19
20 import java.util.Iterator;
21
22
23 /**
24 * Abstract the protocol implementation, including threading, etc.
25 * Processor is single threaded and specific to stream-based protocols,
26 * will not fit Jk protocols like JNI.
27 *
28 * This is the main interface to be implemented by a coyoute connector.
29 * Adapter is the main interface to be impleneted by a coyote servlet container.
30 *
31 * @author Remy Maucherat
32 * @author Costin Manolache
33 * @see Adapter
34 */
35 public interface ProtocolHandler {
36
37
38 /**
39 * Pass config info.
40 */
41 public void setAttribute(String name, Object value);
42
43
44 public Object getAttribute(String name);
45 public Iterator getAttributeNames();
46
47 /**
48 * The adapter, used to call the connector.
49 */
50 public void setAdapter(Adapter adapter);
51
52
53 public Adapter getAdapter();
54
55
56 /**
57 * Init the protocol.
58 */
59 public void init()
60 throws Exception;
61
62
63 /**
64 * Start the protocol.
65 */
66 public void start()
67 throws Exception;
68
69 /**
70 * Pause the protocol (optional).
71 */
72 public void pause()
73 throws Exception;
74
75 /**
76 * Resume the protocol (optional).
77 */
78 public void resume()
79 throws Exception;
80
81 public void destroy()
82 throws Exception;
83
84
85 }
Save This Page