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