com.oracle.bmc.http.client.jersey3.Jersey3ClientProperties Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
 * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 */
package com.oracle.bmc.http.client.jersey3;

import org.glassfish.jersey.spi.ExecutorServiceProvider;

/** Properties for the Jersey HTTP client. */
public enum Jersey3ClientProperties {
    ;

    public static final Jersey3ClientProperty USE_APACHE_CONNECTOR =
            Jersey3ClientProperty.create("com.oracle.bmc.http.client.jersey3.use_apache_connector");

    /**
     * Jersey provides a default {@link ExecutorServiceProvider}, but in stand-alone applications,
     * its threads fail to terminate, because they are not daemon threads.
     *
     * By default, the OCI Java SDK uses its own {@link ExecutorServiceProvider} instead of
     * Jersey's default. Setting this property to true changes the OCI Java SDK behavior to use
     * Jersey's default and not its own.
     *
     * 
Note, this property is pointless if a specific {@link ExecutorServiceProvider} is
     * specified using EXECUTOR_SERVICE_PROVIDER.
     */
    public static final Jersey3ClientProperty
            USE_JERSEY_DEFAULT_EXECUTOR_SERVICE_PROVIDER =
                    Jersey3ClientProperty.create(
                            "com.oracle.bmc.http.client.jersey3.use_jersey_default_executor_service_provider");

    public static final Jersey3ClientProperty EXECUTOR_SERVICE_PROVIDER =
            Jersey3ClientProperty.create(
                    "com.oracle.bmc.http.client.jersey3.executor_service_provider");

    /**
     * Idle monitor thread polls the connection manager to monitor for expired and idle connections
     * and closes any such connections
     *
     * 
If the property is absent then default value of true will be used
     */
    public static final Jersey3ClientProperty
            APACHE_IDLE_CONNECTION_MONITOR_THREAD_ENABLED =
                    Jersey3ClientProperty.create(
                            "com.oracle.bmc.http.client.jersey3.apache_idle_connection_monitor_thread_enabled");

    /**
     * The time interval after which the check and closing of expired/idle connections is performed
     * by the idleMonitorThread. This is applicable only if idleConnectionMonitorThead is
     * enabled/true
     *
     * 
If the property is absent then default value of 5 seconds will be used
     */
    public static final Jersey3ClientProperty
            APACHE_IDLE_CONNECTION_MONITOR_THREAD_WAIT_TIME_SECONDS =
                    Jersey3ClientProperty.create(
                            "com.oracle.bmc.http.client.jersey3.apache_idle_connection_monitor_thread_wait_time_seconds");

    /**
     * The idle timeout - close connections that have been idle longer than
     * idleConnectionMonitorThreadIdleTimeoutInSeconds seconds by idleMonitorThread. This is
     * applicable only if idleConnectionMonitorThead is enabled/true
     *
     * If the property is absent then default value of 20 seconds will be used
     */
    public static final Jersey3ClientProperty
            APACHE_IDLE_CONNECTION_MONITOR_THREAD_IDLE_TIMEOUT_SECONDS =
                    Jersey3ClientProperty.create(
                            "com.oracle.bmc.http.client.jersey3.apache_idle_connection_monitor_thread_idle_timeout_seconds");
}