no.digipost.http.client.DigipostHttpClientDefaults Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of http-client-builder Show documentation
Apache HTTP Client configured with sensible defaults.
The newest version!
/**
 * Copyright (C) Posten Norge AS
 *
 * 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 no.digipost.http.client;


public final class DigipostHttpClientDefaults {

    /**
     * Socket timeout: {@value #SOCKET_TIMEOUT_MS} ms.
     */
    public static final int SOCKET_TIMEOUT_MS = 10_000;

    /**
     * Connect timeout: {@value #CONNECT_TIMEOUT_MS} ms.
     */
    public static final int CONNECT_TIMEOUT_MS = 10_000;

    /**
     * Connection request timeout: {@value #CONNECTION_REQUEST_TIMEOUT_MS} ms.
     */
    public static final int CONNECTION_REQUEST_TIMEOUT_MS = 10_000;


    /**
     * The default timeouts:
     * 
     *   {@link #SOCKET_TIMEOUT_MS}: {@value #SOCKET_TIMEOUT_MS} ms
     *   {@link #CONNECT_TIMEOUT_MS}: {@value #CONNECT_TIMEOUT_MS} ms
     *   {@link #CONNECTION_REQUEST_TIMEOUT_MS}: {@value #CONNECTION_REQUEST_TIMEOUT_MS} ms
     * 
     */
    public static final DigipostHttpClientMillisecondTimeouts DEFAULT_TIMEOUTS_MS = new DigipostHttpClientMillisecondTimeouts(SOCKET_TIMEOUT_MS, CONNECT_TIMEOUT_MS, CONNECTION_REQUEST_TIMEOUT_MS);



    /**
     * Maximum {@value #MAX_CONNECTIONS_PER_ROUTE_NORMAL} connections
     * per route for normal amount of traffic.
     * 
     * Apache HttpClient default: 2
     */
    public static final int MAX_CONNECTIONS_PER_ROUTE_NORMAL = 10;

    /**
     * Maximum {@value #MAX_CONNECTIONS_TOTAL_NORMAL}
     * total connections for normal amount of traffic.
     * 

     * Apache HttpClient default: 20
     */
    public static final int MAX_CONNECTIONS_TOTAL_NORMAL = MAX_CONNECTIONS_PER_ROUTE_NORMAL;



    /**
     * Maximum {@value #MAX_CONNECTIONS_PER_ROUTE_MEDIUM} connections
     * per route for medium amount of traffic.
     * 

     * Apache HttpClient default: 2
     */
    public static final int MAX_CONNECTIONS_PER_ROUTE_MEDIUM = 50;

    /**
     * Maximum {@value #MAX_CONNECTIONS_TOTAL_MEDIUM}
     * total connections for medium amount of traffic.
     * 

     * Apache HttpClient default: 20
     */
    public static final int MAX_CONNECTIONS_TOTAL_MEDIUM = MAX_CONNECTIONS_PER_ROUTE_MEDIUM;



    /**
     * Maximum {@value #MAX_CONNECTIONS_PER_ROUTE_HIGH} connections
     * per route for high amount of traffic.
     * 

     * Apache HttpClient default: 2
     */
    public static final int MAX_CONNECTIONS_PER_ROUTE_HIGH = 100;

    /**
     * Maximum {@value #MAX_CONNECTIONS_TOTAL_HIGH}
     * total connections for high amount of traffic.
     * 
     * Apache HttpClient default: 20
     */
    public static final int MAX_CONNECTIONS_TOTAL_HIGH = MAX_CONNECTIONS_PER_ROUTE_HIGH;




    public static final ConnectionAmount CONNECTION_AMOUNT_NORMAL = new ConnectionAmount(MAX_CONNECTIONS_TOTAL_NORMAL, MAX_CONNECTIONS_PER_ROUTE_NORMAL);
    public static final ConnectionAmount CONNECTION_AMOUNT_MEDIUM = new ConnectionAmount(MAX_CONNECTIONS_TOTAL_MEDIUM, MAX_CONNECTIONS_PER_ROUTE_MEDIUM);
    public static final ConnectionAmount CONNECTION_AMOUNT_HIGH = new ConnectionAmount(MAX_CONNECTIONS_TOTAL_HIGH, MAX_CONNECTIONS_PER_ROUTE_HIGH);


    public static final class ConnectionAmount {

        public final int maxTotal;
        public final int maxPerRoute;

        private ConnectionAmount(int maxTotal, int maxPerRoute) {
            this.maxTotal = maxTotal;
            this.maxPerRoute = maxPerRoute;
        }
    }

    private DigipostHttpClientDefaults() {}
}