Resolving Invalid HTTP Method: PATCH in Java HttpURLConnection

Introduction

In Java development, when attempting to use non-standard HTTP methods like PATCH with HttpURLConnection, developers often encounter a ProtocolException: "Invalid HTTP method: PATCH". This article addresses this problem and provides effective solutions, with a focus on the X-HTTP-Method-Override workaround.

Primary Solution: Using X-HTTP-Method-Override Header

The most straightforward and widely accepted workaround is to use the X-HTTP-Method-Override header. This technique involves sending a POST request with an additional header that specifies the intended HTTP method, such as PATCH.

HttpURLConnection conn = (HttpURLConnection) new URL("http://example.com").openConnection();
conn.setRequestProperty("X-HTTP-Method-Override", "PATCH");
conn.setRequestMethod("POST");
// Add code for setting request body, headers, and handling response

This approach is compatible with most servers that support HTTP method overriding and avoids the need for modifying internal Java classes.

Alternative Methods

Other solutions include:

• Reflection Method: Modifying the static methods field in HttpURLConnection using reflection, as shown in some answers. However, this is not recommended due to potential compatibility issues and security concerns, especially with newer JDK versions.
• Third-Party Libraries: Libraries like Apache Http-Components Client provide built-in support for PATCH and other HTTP methods. For example:

CloseableHttpClient httpClient = HttpClients.createDefault();
HttpPatch httpPatch = new HttpPatch("http://example.com");
CloseableHttpResponse response = httpClient.execute(httpPatch);

This method is more robust and adheres to HTTP standards.

• Modern Java HTTP Client: In Java 11 and above, the new HTTP client introduced in the java.net.http package supports custom methods:

HttpRequest request = HttpRequest.newBuilder()
               .uri(URI.create("http://example.com"))
               .method("PATCH", HttpRequest.BodyPublishers.ofString("body"))
               .build();
// Use HttpClient to send the request

Conclusion

For applications using the legacy HttpURLConnection, the X-HTTP-Method-Override header is a practical and simple workaround to send PATCH requests. However, for new development, it is advisable to use third-party libraries like Apache Http-Components or the modern Java HTTP client to ensure better compatibility and adherence to HTTP protocols.