2011/08/05 - Jakarta Cactus has been retired.

For more information, please explore the Attic.

View Javadoc

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