Add save/export functionality to the API

[thomas-melville]

Hi,

I would like to update the API to include the functionality to save/export several images to a tar ball
https://docs.docker.com/engine/api/v1.30/#operation/ImageGetAll

[0crat]

@amihaiemil/z please, pay attention to this issue

[0crat]

@thomas-melville/z this project will fix the problem faster if you donate a few dollars to it; just click here and pay via Stripe, it's very fast, convenient and appreciated; thanks a lot!

[amihaiemil]

@thomas-melville I see, thanks. Did you study this library and understood the architecture and principles behind it?

For instance, the way I think this should go is the following:

1. have method Images : Images.filter(...), which would return only the Images that respect the given filter. Basically this method would return an instance of FilteredImages.

2. have method InputStream : Images.save() which would save the given images.

It would be used as follows:

Docker docker = ...;
Images all = docker.images();
Images filtered = all.filter(...);
InputStream tar = filtered.save();

It would be up to the client to handle that InputStream and read it however they like.

So you see, it's more object-oriented, Images represents the Images API and at the same time, through polymorphism, it represents more instances of Image (Images extends Iterable<Image>). I wouldn't simply go with Images.save(String[] names) -- that would result in a more procedural usage of the library.

What do you think?

[thomas-melville]

@amihaiemil no, not yet. I will read them and read through the code.

Yes, I agree that the InputStream should be returned and the user handle it however they like, just like the command line.
Yes I see, through encapsulation of the iteration.
Sounds good.

[amihaiemil]

@thomas-melville I will start with this functionality as it will involve some redesign of the code (I imagine RtImages will become abstract, for instance). I'll do it this week sometime, when I find some free slot for it. Then, when the design is clear, you can proceed with the rest.

Keep in mind that PRs to this repo should be small (ideally, 30min of work tops). We are using http://xdsd.org (this project has no funds, so there are no payments sadly) and Puzzle Driven Development.

[0crat]

Thanks for your contribution, @thomas-melville/z! If you would be a member of the project, you would now earn +15 reputation points, as explained in §29. You can join and apply to it, see §2.

[0crat]

The job #144 assigned to @amihaiemil/z, here is why; the budget is 30 minutes, see §4; please, read §8 and §9; if the task is not clear, read this and this; there will be no monetary reward for this job

[0crat]

Job gh:amihaiemil/docker-java-api#144 already assigned to @amihaiemil, can't assign to @amihaiemil

[0crat]

Manual assignment of issues is discouraged, see §19: -5 point(s) just awarded to @amihaiemil/z