1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with 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,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.http.conn;
29
30 import java.util.concurrent.TimeUnit;
31
32 /**
33 * Encapsulates a request for a {@link ManagedClientConnection}.
34 *
35 * @since 4.0
36 *
37 * @deprecated (4.3) replaced by {@link ConnectionRequest}.
38 */
39 @Deprecated
40 public interface ClientConnectionRequest {
41
42 /**
43 * Obtains a connection within a given time.
44 * This method will block until a connection becomes available,
45 * the timeout expires, or the connection manager is
46 * {@link ClientConnectionManager#shutdown() shut down}.
47 * Timeouts are handled with millisecond precision.
48 *
49 * If {@link #abortRequest()} is called while this is blocking or
50 * before this began, an {@link InterruptedException} will
51 * be thrown.
52 *
53 * @param timeout the timeout, 0 or negative for no timeout
54 * @param timeUnit the unit for the {@code timeout},
55 * may be {@code null} only if there is no timeout
56 *
57 * @return a connection that can be used to communicate
58 * along the given route
59 *
60 * @throws ConnectionPoolTimeoutException
61 * in case of a timeout
62 * @throws InterruptedException
63 * if the calling thread is interrupted while waiting
64 */
65 ManagedClientConnection getConnection(long timeout, TimeUnit timeUnit)
66 throws InterruptedException, ConnectionPoolTimeoutException;
67
68 /**
69 * Aborts the call to {@link #getConnection(long, TimeUnit)},
70 * causing it to throw an {@link InterruptedException}.
71 */
72 void abortRequest();
73
74 }