Skip to content

8329829: HttpClient: Add a BodyPublishers.ofFileChannel method #26155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

vy
Copy link
Contributor

@vy vy commented Jul 7, 2025

Adds a new ofFileChannel(FileChannel channel, long offset, long length) method to java.net.HttpRequest.BodyPublishers to provide an HttpClient publisher to upload a certain region of a file. The new publisher does not modify the state of the passed FileChannel, streams the file channel bytes as it publishes (i.e., avoids reading the entire file into the memory), and can be leveraged to implement sliced uploads. As noted in the Javadoc:

The file channel will not be closed upon completion. The caller is
expected to manage the life cycle of the channel, and close it
appropriately when not needed anymore.

Implementation notes

  • FileChannel is preferred over {Readable,Seekable}ByteChannel, since the latter does not provide a positional read without modifying the state of the FileChannel, which is necessary to use a single FileChannel instance to implement sliced uploads.
  • ofFileChannel(FileChannel,long,long) is preferred over ofPath(Path,long,long) to avoid overloading the maximum file descriptor limit of the platform.

Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8329829: HttpClient: Add a BodyPublishers.ofFileChannel method (Enhancement - P4)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/26155/head:pull/26155
$ git checkout pull/26155

Update a local copy of the PR:
$ git checkout pull/26155
$ git pull https://git.openjdk.org/jdk.git pull/26155/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 26155

View PR using the GUI difftool:
$ git pr show -t 26155

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/26155.diff

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Jul 7, 2025

👋 Welcome back vyazici! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented Jul 7, 2025

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

@openjdk openjdk bot added the rfr Pull request is ready for review label Jul 7, 2025
@openjdk
Copy link

openjdk bot commented Jul 7, 2025

@vy The following label will be automatically applied to this pull request:

  • net

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added the net net-dev@openjdk.org label Jul 7, 2025
@mlbridge
Copy link

mlbridge bot commented Jul 7, 2025

Webrevs

Co-authored-by: Daniel Fuchs <67001856+dfuch@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
net net-dev@openjdk.org rfr Pull request is ready for review
Development

Successfully merging this pull request may close these issues.

2 participants