org.apache.hc.client5.http.ConnectTimeoutException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of httpclient5 Show documentation
Apache HttpComponents Client
The newest version!
/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * .
 *
 */

package org.apache.hc.client5.http;

import java.net.SocketTimeoutException;

import org.apache.hc.core5.net.NamedEndpoint;

/**
 * A timeout while connecting to an HTTP server or waiting for an available connection from a connection manager.
 *
 * @since 4.0
 */
public class ConnectTimeoutException extends SocketTimeoutException {

    private static final long serialVersionUID = -4816682903149535989L;

    private final NamedEndpoint namedEndpoint;

    /**
     * Creates a ConnectTimeoutException with the specified detail message.
     *
     * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method).
     */
    public ConnectTimeoutException(final String message) {
        super(message);
        this.namedEndpoint = null;
    }

    public ConnectTimeoutException(final String message, final NamedEndpoint namedEndpoint) {
        super(message);
        this.namedEndpoint = namedEndpoint;
    }

    /**
     * Gets the named endpoint.
     *
     * @return the named endpoint, may be {@code null}.
     * @since 5.0
     */
    public NamedEndpoint getHost() {
        return this.namedEndpoint;
    }

}