KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cactus > internal > client > connector > http > ConnectionHelper


1 /*
2  * ========================================================================
3  *
4  * Copyright 2001-2004 The Apache Software Foundation.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *
18  * ========================================================================
19  */
20 package org.apache.cactus.internal.client.connector.http;
21
22 import java.net.HttpURLConnection JavaDoc;
23
24 import org.apache.cactus.WebRequest;
25 import org.apache.cactus.internal.configuration.Configuration;
26
27 /**
28  * Helper class to open an HTTP connection to the server redirector and pass
29  * to it HTTP parameters, Cookies and HTTP headers. It enables different
30  * possible implementations of an HTTP connection (ex: using the JDK
31  * <code>HttpURLConnection</code> or using Jakarta HttpClient).
32  *
33  * @version $Id: ConnectionHelper.java,v 1.1 2004/05/22 11:34:46 vmassol Exp $
34  */
35 public interface ConnectionHelper
36 {
37     /**
38      * Connects to the Cactus Redirector using HTTP.
39      *
40      * @param theRequest the request containing all data to pass to the
41      * server redirector.
42      * @param theConfiguration the Cactus configuration
43      * @return the HTTP Connection used to connect to the redirector.
44      * @exception Throwable if an unexpected error occured
45      */
46     HttpURLConnection JavaDoc connect(WebRequest theRequest,
47         Configuration theConfiguration) throws Throwable JavaDoc;
48 }
49
Popular Tags