NIFI-13982 - Web client - body as string and get request URI for response entity

[pvillard31]

Summary

NIFI-13982 - Web client - body as string and get request URI for response entity

In the web client API, we currently have in HttpRequestBodySpec:

HttpRequestHeadersSpec body(InputStream inputStream, OptionalLong contentLength) 

It would be convenient to also have:

HttpRequestHeadersSpec body(String body); 

Especially when the payload is very small and easy to craft.

In addition, in HttpResponseEntity, there is no way to know what endpoint has been accessed to generate that response. Having the possibility to retrieved the requested endpoint from the response entity might be useful when there is a separation between processors and controller services, in particular when generating the provenance events at processor level where adding the transit URI is useful for data lineage.

Tracking

Please complete the following tracking steps prior to pull request creation.

Issue Tracking

• Apache NiFi Jira issue created

Pull Request Tracking

• Pull Request title starts with Apache NiFi Jira issue number, such as NIFI-00000
• Pull Request commit message starts with Apache NiFi Jira issue number, as such NIFI-00000

Pull Request Formatting

• Pull Request based on current revision of the main branch
• Pull Request refers to a feature branch with one commit containing changes

Verification

Please indicate the verification steps performed prior to pull request creation.

Build

• Build completed using mvn clean install -P contrib-check
  • JDK 21

Licensing

• New dependencies are compatible with the Apache License 2.0 according to the License Policy
• New dependencies are documented in applicable LICENSE and NOTICE files

Documentation

• Documentation formatting appears as expected in rendered files

[exceptionfactory]

Thanks for putting together this improvement @pvillard31. The general changes look good. I noted the importance of highlighting that the String request body will be encoded as UTF-8. I also noted some suggestions on the URI for the response.

[pvillard31]

Thanks @exceptionfactory - committed the suggested changes. I didn't realize that response also had the URI available.

[exceptionfactory]

Thanks for the updates @pvillard31. This looks close to completion, I just noticed one more method naming issue that should be adjusted for consistency with the others in HttpResponseEntity.

[pvillard31]

Pushed a commit with your suggested changes. Thanks @exceptionfactory

[exceptionfactory]

Thanks again @pvillard31, looks good! +1 merging