com.ibm.cloud.objectstorage.ApacheHttpClientConfig Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ibm-cos-java-sdk-bundle Show documentation

A single bundled dependency that includes all service and dependent JARs with third-party libraries relocated to different namespaces.

There is a newer version: 2.13.4

Show newest version

/*
 * Copyright 2010-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file 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 com.ibm.cloud.objectstorage;

import com.ibm.cloud.objectstorage.annotation.NotThreadSafe;

import org.apache.http.conn.socket.ConnectionSocketFactory;

/**
 * Used for Apache HTTP client specific custom configurations.
 */
@NotThreadSafe
public final class ApacheHttpClientConfig {
    private ConnectionSocketFactory sslSocketFactory;

    ApacheHttpClientConfig() {}

    ApacheHttpClientConfig(ApacheHttpClientConfig that) {
        this.sslSocketFactory = that.sslSocketFactory;
    }

    /**
     * Returns a custom Apache HTTP client specific SSL socket factory; 
     * or null if there is none.
     */
    public ConnectionSocketFactory getSslSocketFactory() {
        return sslSocketFactory;
    }

    /**
     * Sets a custom Apache HTTP client specific SSL socket factory.
     * 
     * @param sslSocketFactory a custom Apache HTTP client specific SSL socket 
     * factory; or null if there is none.
     */
    public void setSslSocketFactory(ConnectionSocketFactory sslSocketFactory) {
        this.sslSocketFactory = sslSocketFactory;
    }

    /**
     * Fluent API for setting a custom Apache HTTP client specific SSL socket
     * factory.
     * 
     * @param sslSocketFactory a custom Apache HTTP client specific SSL socket 
     * factory; or null if there is none.
     */
    public ApacheHttpClientConfig withSslSocketFactory(
            ConnectionSocketFactory sslSocketFactory) {
        this.sslSocketFactory = sslSocketFactory;
        return this;
    }
}