io.rxmicro.rest.client.HttpClientTimeoutException Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2020. https://rxmicro.io
 *
 * Licensed 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.
 */

package io.rxmicro.rest.client;

import io.rxmicro.common.util.Formats;
import io.rxmicro.http.error.HttpErrorException;
import io.rxmicro.rest.client.detail.HttpClient;

import static io.rxmicro.http.HttpStatuses.GATEWAY_TIMEOUT_504;

/**
 * A class signaling that the HTTP client didn’t receive a response from the server in given time.
 *
 * @author nedis
 * @see HttpClient
 * @since 0.1
 */
public final class HttpClientTimeoutException extends HttpErrorException {

    /**
     * Status code for the all instances of the current exception type.
     */
    public static final int STATUS_CODE = GATEWAY_TIMEOUT_504;

    private static final long serialVersionUID = -2004797069034953753L;

    /**
     * Creates a HTTP error with error message.
     *
     * 
     * For all child classes which extend the HttpErrorException class, when creating an exception instance the stack trace is not filled,
     * as this information is redundant.
     *
     * 

     * (This behavior is achieved by using the {@link RuntimeException#RuntimeException(String, Throwable, boolean, boolean)}.)
     *
     * 
     * (FYI: This constructor uses {@link Formats#format(String, Object...)} method to format error message.)
     *
     * @param message the error message template
     * @param args the error message template argument
     */
    public HttpClientTimeoutException(final String message,
                                      final Object... args) {
        super(STATUS_CODE, message, args);
    }
}