How to migration ssl connection from Apache httpClient 4.2.6 to httpclient 4.5.14 in bean xml (Spring application)

Hi there,

Migrating your Spring application’s configuration from Apache HttpClient 4.2.6 to 4.5.14 involves updating the beans to use the new classes and methods provided in the newer version.

Since Apache HttpClient 4.5.x has deprecated some of the classes like Scheme and SSLSocketFactory, you need to use the SSLContextBuilder and RegistryBuilder for setting up SSL connections:

https://hc.apache.org/httpcomponents-client-4.5.x/index.html

Here’s a general idea on how to refactor your bean configuration in XML to be compatible with HttpClient 4.5.14:

1. SSLSocketFactory Replacement: Use SSLContextBuilder to create an SSLContext, and then create an SSLConnectionSocketFactory from the SSLContext.

2. Scheme and SchemeRegistry Replacement: Instead of Scheme and SchemeRegistry, use RegistryBuilder to create a Registry<ConnectionSocketFactory>.

3. HttpClient Creation: Finally, create the HttpClient using HttpClientBuilder and set the Registry<ConnectionSocketFactory>.

Here’s a revised version of your beans configuration:

<beans>
    <!-- SSLContext configuration -->
    <bean id="sslContext" class="org.apache.http.ssl.SSLContextBuilder" factory-method="create">
        <property name="loadTrustMaterial" ref="trustStore" />
        <!-- Add other SSL configurations if needed -->
    </bean>

    <bean id="trustStore" class="org.apache.http.ssl.TrustSelfSignedStrategy"/>

    <bean id="sslSocketFactory" class="org.apache.http.conn.ssl.SSLConnectionSocketFactory">
        <constructor-arg ref="sslContext"/>
        <property name="supportedProtocols" value="${RAM.enabledSSLProtocols}"/>
        <property name="supportedCipherSuites" value="${RAM.enabledCiphers}"/>
    </bean>

    <!-- Registry for connection socket factories -->
    <bean id="registry" class="org.apache.http.config.RegistryBuilder" factory-method="create">
        <property name="register">
            <list>
                <bean class="org.apache.http.config.RegistryBuilder$SchemeRegistryBuilder">
                    <constructor-arg value="https"/>
                    <constructor-arg value="443"/>
                    <constructor-arg ref="sslSocketFactory"/>
                </bean>
            </list>
        </property>
    </bean>

    <!-- HttpClient creation -->
    <bean id="httpClient" class="org.apache.http.impl.client.HttpClients" factory-method="custom">
        <property name="setDefaultSocketConfig">
            <!-- Configure socket config if needed -->
        </property>
        <property name="setConnectionManager">
            <bean class="org.apache.http.impl.conn.PoolingHttpClientConnectionManager">
                <constructor-arg ref="registry"/>
            </bean>
        </property>
        <!-- Add other configurations as needed -->
    </bean>
</beans>

In this configuration:

• The SSLContextBuilder is used to create an SSLContext.
• TrustSelfSignedStrategy is an example; you may need to implement your trust strategy based on your application needs.
• SSLConnectionSocketFactory is created with the SSLContext.
• A Registry of connection socket factories is created.
• The HttpClient is built with the custom configurations.

Ensure that all the placeholders like ${RAM.enabledSSLProtocols} are correctly configured in your properties file.

Also, make sure to always test thoroughly after making these changes to ensure that your application’s SSL connections are functioning as expected with the new HttpClient version.

Best,

Bobby