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.hc.client5.http;
29
30 import java.net.SocketTimeoutException;
31
32 import org.apache.hc.core5.net.NamedEndpoint;
33
34 /**
35 * A timeout while connecting to an HTTP server or waiting for an available connection from a connection manager.
36 *
37 * @since 4.0
38 */
39 public class ConnectTimeoutException extends SocketTimeoutException {
40
41 private static final long serialVersionUID = -4816682903149535989L;
42
43 private final NamedEndpoint namedEndpoint;
44
45 /**
46 * Creates a ConnectTimeoutException with the specified detail message.
47 *
48 * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method).
49 */
50 public ConnectTimeoutException(final String message) {
51 super(message);
52 this.namedEndpoint = null;
53 }
54
55 public ConnectTimeoutException(final String message, final NamedEndpoint namedEndpoint) {
56 super(message);
57 this.namedEndpoint = namedEndpoint;
58 }
59
60 /**
61 * Gets the named endpoint.
62 *
63 * @return the named endpoint, may be {@code null}.
64 * @since 5.0
65 */
66 public NamedEndpoint getHost() {
67 return this.namedEndpoint;
68 }
69
70 }