Fix HttpClient 5 migration compilation errors

[Copilot]

Resolves compilation errors from HttpClient 4.5 to 5.x migration by updating all type references and API usages to v5.

Changes

Deleted custom HTTP method classes

• HttpDelete.java, HttpOptions.java - HttpClient 5 natively supports entity bodies on all HTTP methods

Renamed for v5 API compatibility

• HtmlUnitRedirectStrategie → HtmlUnitRedirectStrategy
• HtmlUnitCookieSpecProvider → HtmlUnitCookieSpecFactory

Updated to v5 APIs

• All imports: org.apache.http.* → org.apache.hc.client5.* / org.apache.hc.core5.*
• AuthScope: constructor → builder pattern
• CredentialsProvider.getCredentials(): added HttpContext parameter
• CookieStore.clearExpired(): Date → Instant
• Type changes: HttpRequestBase → HttpUriRequestBase, RouteInfo → HttpRoute
• Credentials: String password → char[] for security

Created compatibility shims

• BasicCommentHandler - replacement for removed v5 class
• SM cookie constants replaced with string literals

Example

// v4
final AuthScope authScope = new AuthScope(host, port, realm, scheme);
final Credentials creds = provider.getCredentials(authScope);

// v5
final AuthScope authScope = new AuthScope.Builder()
    .setHost(host)
    .setPort(port)
    .setRealm(realm)
    .setScheme(scheme)
    .build();
final Credentials creds = provider.getCredentials(authScope, context);

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• central.sonatype.com
  • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.12/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.12/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.12 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.12/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/htmlunit/htmlunit org.codehaus.plexus.classworlds.launcher.Launcher clean compile (dns block)
  • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.12/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.12/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.12 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.12/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/htmlunit/htmlunit org.codehaus.plexus.classworlds.launcher.Launcher compile (dns block)
  • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.12/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.12/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.12 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.12/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/htmlunit/htmlunit org.codehaus.plexus.classworlds.launcher.Launcher clean compile -q (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

Fix HttpClient 5 Migration Compilation Errors

Overview

Fix all compilation errors introduced in the HttpClient 4.5 to 5.x migration by ensuring consistent use of HttpClient 5 types throughout the codebase.

Compilation Errors to Fix

1. Type Mismatches in HttpWebConnection.java

Error: Incompatible conditional operand types HttpRequestBase and HttpDelete/HttpOptions

Fix: Remove custom HttpDelete and HttpOptions classes and use HttpClient 5 native classes:

// DELETE these files:
- src/main/java/org/htmlunit/httpclient/HttpDelete.java
- src/main/java/org/htmlunit/httpclient/HttpOptions.java

// In buildHttpMethod(), change from:
case DELETE -> new org.htmlunit.httpclient.HttpDelete(uri);
case OPTIONS -> new org.htmlunit.httpclient.HttpOptions(uri);

// To:
case DELETE -> new HttpDelete(uri);
case OPTIONS -> new HttpOptions(uri);

// With imports:
import org.apache.hc.client5.http.classic.methods.HttpDelete;
import org.apache.hc.client5.http.classic.methods.HttpOptions;

Reason: HttpClient 5 natively supports entity bodies on DELETE and OPTIONS, so custom classes are no longer needed.

2. ConnectionSocketFactory Type Mismatch

Error: The method register(String, ConnectionSocketFactory) is not applicable for (String, SocksConnectionSocketFactory)

Fix: Update SocksConnectionSocketFactory to implement HttpClient 5 interfaces:

// In SocksConnectionSocketFactory.java, change:
import org.apache.http.conn.socket.ConnectionSocketFactory;

// To:
import org.apache.hc.client5.http.socket.ConnectionSocketFactory;

// Update class declaration and all method signatures to match v5 interface

3. CookieSpecProvider Type Mismatch

Error: The method register(String, CookieSpecProvider) is not applicable for (String, HtmlUnitCookieSpecProvider)

Fix: Rename and update cookie spec provider to factory:

Step 1: Rename file:

src/main/java/org/htmlunit/httpclient/HtmlUnitCookieSpecProvider.java 
→ 
src/main/java/org/htmlunit/httpclient/HtmlUnitCookieSpecFactory.java

Step 2: Update class:

// Change from:
import org.apache.http.cookie.CookieSpecProvider;
public class HtmlUnitCookieSpecProvider implements CookieSpecProvider {
    @Override
    public CookieSpec create(final HttpContext context) {
        return new HtmlUnitBrowserCompatCookieSpec(browserVersion_);
    }
}

// To:
import org.apache.hc.client5.http.cookie.CookieSpecFactory;
import org.apache.hc.core5.http.protocol.HttpContext;

public class HtmlUnitCookieSpecFactory implements CookieSpecFactory {
    @Override
    public CookieSpec create(final HttpContext context) {
        return new HtmlUnitBrowserCompatCookieSpec(browserVersion_);
    }
}

Step 3: Update registration in HttpWebConnection.java:

// Change from:
import org.apache.http.cookie.CookieSpecProvider;
final RegistryBuilder<CookieSpecProvider> registryBuilder = 
    RegistryBuilder.<CookieSpecProvider>create()
        .register(HACKED_COOKIE_POLICY, htmlUnitCookieSpecProvider_);

// To:
import org.apache.hc.client5.http.cookie.CookieSpecFactory;
final RegistryBuilder<CookieSpecFactory> registryBuilder = 
    RegistryBuilder.<CookieSpecFactory>create()
        .register(HACKED_COOKIE_POLICY, htmlUnitCookieSpecFactory_);

4. CookieStore Type Mismatch

Error: The method setDefaultCookieStore(CookieStore) is not applicable for (HtmlUnitCookieStore)

Fix: Update HtmlUnitCookieStore to implement HttpClient 5 interface:

// In HtmlUnitCookieStore.java, change:
import org.apache.http.client.CookieStore;
import org.apache.http.cookie.Cookie;

public final class HtmlUnitCookieStore implements CookieStore {
    @Override
    public synchronized boolean clearExpired(final Date date) {
        return manager_.clearExpired(date);
    }
}

// To:
import org.apache.hc.client5.http.cookie.CookieStore;
import org.apache.hc.client5.http.cookie.Cookie;
import java.time.Instant;

public final class HtmlUnitCookieStore implements CookieStore {
    @Override
    public synchronized boolean clearExpired(final Instant date) {
        return manager_.clearExpired(Date.from(date));
    }
}

5. RedirectStrategy Type Mismatch

Error: The method setRedirectStrategy(RedirectStrategy) is not applicable for (HtmlUnitRedirectStrategie)

Fix: Rename class and update to HttpClient 5:

Step 1: Rename file:

src/main/java/org/htmlunit/httpclient/HtmlUnitRedirectStrategie.java
→
src/main/java/org/htmlunit/httpclient/HtmlUnitRedirectStrategy.java

Step 2: Update class:

// Change from:
import org.apache.http.HttpRequest;
import org.apache.http.HttpResponse;
import org.apache.http.ProtocolException;
import org.apache.http.impl.client.DefaultRedirectStrategy;
import org.apache.http.protocol.HttpContext;

public final class HtmlUnitRedirectStrategie extends DefaultRedirectStrategy {
    @Override
    public boolean isRedirected(final HttpRequest request, final HttpRes...

</details>



<!-- START COPILOT CODING AGENT SUFFIX -->

*This pull request was created from Copilot chat.*
>

<!-- START COPILOT CODING AGENT TIPS -->
---

✨ Let Copilot coding agent [set things up for you](https://github.com/HtmlUnit/htmlunit/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud