01: /*
02: * $HeadURL: https://svn.apache.org/repos/asf/httpcomponents/httpcore/tags/4.0-beta1/module-nio/src/main/java/org/apache/http/nio/protocol/HttpRequestExecutionHandler.java $
03: * $Revision: 613298 $
04: * $Date: 2008-01-18 23:09:22 +0100 (Fri, 18 Jan 2008) $
05: *
06: * ====================================================================
07: * Licensed to the Apache Software Foundation (ASF) under one
08: * or more contributor license agreements. See the NOTICE file
09: * distributed with this work for additional information
10: * regarding copyright ownership. The ASF licenses this file
11: * to you under the Apache License, Version 2.0 (the
12: * "License"); you may not use this file except in compliance
13: * with the License. You may obtain a copy of the License at
14: *
15: * http://www.apache.org/licenses/LICENSE-2.0
16: *
17: * Unless required by applicable law or agreed to in writing,
18: * software distributed under the License is distributed on an
19: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20: * KIND, either express or implied. See the License for the
21: * specific language governing permissions and limitations
22: * under the License.
23: * ====================================================================
24: *
25: * This software consists of voluntary contributions made by many
26: * individuals on behalf of the Apache Software Foundation. For more
27: * information on the Apache Software Foundation, please see
28: * <http://www.apache.org/>.
29: *
30: */
31:
32: package org.apache.http.nio.protocol;
33:
34: import java.io.IOException;
35:
36: import org.apache.http.HttpRequest;
37: import org.apache.http.HttpResponse;
38: import org.apache.http.nio.reactor.ConnectingIOReactor;
39: import org.apache.http.protocol.HttpContext;
40:
41: /**
42: * HTTP request execution handler can be used by client-side protocol handlers
43: * to trigger the submission of a new HTTP request and the processing of an
44: * HTTP response.
45: *
46: * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
47: *
48: */
49: public interface HttpRequestExecutionHandler {
50:
51: /**
52: * Triggered when a new connection has been established and the
53: * HTTP context needs to be initialized.
54: *
55: * <p>The attachment object is the same object which was passed
56: * to the connecting I/O reactor when the connection request was
57: * made. The attachment may optionally contain some state information
58: * required in order to correctly initalize the HTTP context.
59: *
60: * @see ConnectingIOReactor#connect
61: *
62: * @param context the actual HTTP context
63: * @param attachment the object passed to the connecting I/O reactor
64: * upon the request for a new connection.
65: */
66: void initalizeContext(HttpContext context, Object attachment);
67:
68: /**
69: * Triggered when the underlying connection is ready to send a new
70: * HTTP request to the target host. This method may return
71: * <code>null</null> if the client is not yet ready to send a
72: * request. In this case the connection will remain open and
73: * can be activated at a later point.
74: *
75: * @param context the actual HTTP context
76: * @return an HTTP request to be sent or <code>null</null> if no
77: * request needs to be sent
78: */
79: HttpRequest submitRequest(HttpContext context);
80:
81: /**
82: * Triggered when an HTTP response is ready to be processed.
83: *
84: * @param response the HTTP response to be processed
85: * @param context the actual HTTP context
86: */
87: void handleResponse(HttpResponse response, HttpContext context)
88: throws IOException;
89:
90: /**
91: * Triggered when the connection is terminated. This event can be used
92: * to release objects stored in the context or perform some other kind
93: * of cleanup.
94: *
95: * @param context the actual HTTP context
96: */
97: void finalizeContext(HttpContext context);
98:
99: }
|