Skip to content

[Java][native] support InputStream mappings for binary payloads #24295

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.

Sign up for GitHub

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
wingwogus wants to merge 5 commits into
base: master
Choose a base branch
from
Open

[Java][native] support InputStream mappings for binary payloads #24295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dad5d0f
Honor InputStream ownership in Java native clients
wingwogus Jul 14, 2026
d3d3d92
Prevent mapped JSON from bypassing native serialization
wingwogus Jul 14, 2026
3a00805
Prevent stream ownership loss across native async races
wingwogus Jul 14, 2026
a5b4028
Prove convenience stream cleanup at the delivery boundary
wingwogus Jul 14, 2026
d21fad3
Synchronize Java native InputStream samples
wingwogus Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions ...openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1011,6 +1011,16 @@ public int compare(CodegenParameter one, CodegenParameter another) {
if ("String".equals(op.returnType) && op.producesTextPlain()) {
op.vendorExtensions.put("x-java-text-plain-string", true);
}
if (isLibrary(NATIVE)) {
if ((op.isResponseBinary || op.isResponseFile) && mapsToInputStream(op.returnType)) {
op.vendorExtensions.put("x-java-native-response-input-stream", true);
}
if (op.bodyParam != null
&& (op.bodyParam.isBinary || op.bodyParam.isFile)
&& mapsToInputStream(op.bodyParam.dataType)) {
op.vendorExtensions.put("x-java-native-body-input-stream", true);
}
}
}
}

Expand Down Expand Up @@ -1045,6 +1055,11 @@ public int compare(CodegenParameter one, CodegenParameter another) {
return objs;
}

private boolean mapsToInputStream(String dataType) {
return "java.io.InputStream".equals(dataType)
|| "java.io.InputStream".equals(importMapping.get(dataType));
}

@Override
public CodegenOperation fromOperation(String path, String httpMethod, Operation operation, List<Server> servers) {
CodegenOperation op = super.fromOperation(path, httpMethod, operation, servers);
Expand Down
9 changes: 7 additions & 2 deletions modules/openapi-generator/src/main/resources/Java/libraries/native/ApiClient.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,10 @@ public class ApiClient {
*/
public static HttpRequest.BodyPublisher gzipRequestBody(Supplier<InputStream> bodySupplier) {
Objects.requireNonNull(bodySupplier, "bodySupplier must not be null");
return HttpRequest.BodyPublishers.ofInputStream(() -> new GzipCompressingInputStream(bodySupplier));
return HttpRequest.BodyPublishers.ofInputStream(() -> {
InputStream body = bodySupplier.get();
return body == null ? null : new GzipCompressingInputStream(() -> body);
});
}

private static final class GzipCompressingInputStream extends InputStream {
Expand All @@ -565,15 +568,17 @@ public class ApiClient {
private boolean fillBuffer() throws IOException {
while (chunkPosition >= currentChunk.length) {
buffer.reset();
ensureInitialized();
if (finished) {
return false;
}
ensureInitialized();
int bytesRead = source.read(readBuffer);
if (bytesRead == -1) {
gzipStream.finish();
gzipStream.close();
gzipStream = null;
source.close();
source = null;
finished = true;
} else {
gzipStream.write(readBuffer, 0, bytesRead);
Expand Down
107 changes: 104 additions & 3 deletions modules/openapi-generator/src/main/resources/Java/libraries/native/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,12 @@ import java.util.Set;
import java.util.function.UnaryOperator;
{{/useUnaryInterceptor}}
import java.util.function.Consumer;
{{#useGzipFeature}}
import java.util.function.Supplier;
{{/useGzipFeature}}
{{#asyncNative}}

import java.util.concurrent.CompletableFuture;
{{/asyncNative}}
import java.util.concurrent.atomic.AtomicReference;

{{>generatedAnnotation}}

Expand Down Expand Up @@ -384,8 +383,46 @@ public class {{classname}} {
{{/asyncNative}}
{{#asyncNative}}
try {
{{#vendorExtensions.x-java-native-response-input-stream}}
CompletableFuture<ApiResponse<{{{returnType}}}>> localVarHttpInfoFuture =
{{operationId}}WithHttpInfo({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#hasParams}}, {{/hasParams}}headers);
class LocalVarResultFuture extends CompletableFuture<{{{returnType}}}> {
@Override
public boolean cancel(boolean mayInterruptIfRunning) {
boolean localVarCancelled = super.cancel(mayInterruptIfRunning);
if (localVarCancelled) {
localVarHttpInfoFuture.cancel(mayInterruptIfRunning);
}
return localVarCancelled;
}

boolean completeResponse({{{returnType}}} localVarResponseBody) {
boolean localVarCompleted = super.complete(localVarResponseBody);
if (!localVarCompleted && localVarResponseBody != null) {
try {
localVarResponseBody.close();
} catch (IOException ignored) {
// The result is already terminal, so cleanup failure has no receiver.
}
}
return localVarCompleted;
}
}
LocalVarResultFuture localVarResult = new LocalVarResultFuture();
localVarHttpInfoFuture.whenComplete((localVarApiResponse, localVarThrowable) -> {
if (localVarThrowable != null) {
localVarResult.completeExceptionally(localVarThrowable);
} else {
{{{returnType}}} localVarResponseBody = localVarApiResponse.getData();
localVarResult.completeResponse(localVarResponseBody);
}
});
return localVarResult;
{{/vendorExtensions.x-java-native-response-input-stream}}
{{^vendorExtensions.x-java-native-response-input-stream}}
return {{operationId}}WithHttpInfo({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#hasParams}}, {{/hasParams}}headers)
.thenApply(ApiResponse::getData);
{{/vendorExtensions.x-java-native-response-input-stream}}
}
catch (ApiException e) {
return CompletableFuture.failedFuture(e);
Expand Down Expand Up @@ -492,6 +529,11 @@ public class {{classname}} {
);
}

{{#vendorExtensions.x-java-native-response-input-stream}}
{{{returnType}}} responseValue = localVarResponseBody;
localVarResponseBody = null;
{{/vendorExtensions.x-java-native-response-input-stream}}
{{^vendorExtensions.x-java-native-response-input-stream}}
{{^isResponseFile}}{{#isResponseBinary}}
Byte[] responseValue = localVarResponseBody.readAllBytes();
{{/isResponseBinary}}{{/isResponseFile}}
Expand All @@ -503,6 +545,7 @@ public class {{classname}} {
String responseBody = new String(localVarResponseBody.readAllBytes());
{{{returnType}}} responseValue = responseBody.isBlank()? null: memberVarObjectMapper.readValue(responseBody, new TypeReference<{{{returnType}}}>() {});
{{/isResponseFile}}{{/isResponseBinary}}
{{/vendorExtensions.x-java-native-response-input-stream}}

return new ApiResponse<{{{returnType}}}>(
localVarResponse.statusCode(),
Expand Down Expand Up @@ -538,9 +581,17 @@ public class {{classname}} {
{{#asyncNative}}
try {
HttpRequest.Builder localVarRequestBuilder = {{operationId}}RequestBuilder({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{#hasParams}}, {{/hasParams}}headers);
{{#vendorExtensions.x-java-native-response-input-stream}}
CompletableFuture<HttpResponse<InputStream>> localVarTransportFuture = memberVarHttpClient.sendAsync(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
CompletableFuture<ApiResponse<{{{returnType}}}>> localVarProcessingFuture = localVarTransportFuture.thenComposeAsync(localVarResponse -> {
{{/vendorExtensions.x-java-native-response-input-stream}}
{{^vendorExtensions.x-java-native-response-input-stream}}
return memberVarHttpClient.sendAsync(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream()).thenComposeAsync(localVarResponse -> {
{{/vendorExtensions.x-java-native-response-input-stream}}
if (memberVarAsyncResponseInterceptor != null) {
{{#useUnaryInterceptor}}
localVarResponse = memberVarAsyncResponseInterceptor.apply(localVarResponse);
Expand Down Expand Up @@ -582,6 +633,11 @@ public class {{classname}} {
)
);
}
{{#vendorExtensions.x-java-native-response-input-stream}}
{{{returnType}}} responseValue = localVarResponseBody;
localVarResponseBody = null;
{{/vendorExtensions.x-java-native-response-input-stream}}
{{^vendorExtensions.x-java-native-response-input-stream}}
{{^isResponseFile}}{{#isResponseBinary}}
Byte[] responseValue = localVarResponseBody.readAllBytes();
{{/isResponseBinary}}{{/isResponseFile}}
Expand All @@ -592,6 +648,7 @@ public class {{classname}} {
String responseBody = new String(localVarResponseBody.readAllBytes());
{{{returnType}}} responseValue = responseBody.isBlank()? null: memberVarObjectMapper.readValue(responseBody, new TypeReference<{{{returnType}}}>() {});
{{/isResponseFile}}{{/isResponseBinary}}
{{/vendorExtensions.x-java-native-response-input-stream}}
return CompletableFuture.completedFuture(
new ApiResponse<{{{returnType}}}>(
localVarResponse.statusCode(),
Expand Down Expand Up @@ -619,6 +676,34 @@ public class {{classname}} {
}
}
);
{{#vendorExtensions.x-java-native-response-input-stream}}
CompletableFuture<ApiResponse<{{{returnType}}}>> localVarResult =
new CompletableFuture<ApiResponse<{{{returnType}}}>>() {
@Override
public boolean cancel(boolean mayInterruptIfRunning) {
boolean localVarCancelled = super.cancel(mayInterruptIfRunning);
if (localVarCancelled) {
localVarTransportFuture.cancel(mayInterruptIfRunning);
}
return localVarCancelled;
}
};
localVarProcessingFuture.whenComplete((localVarApiResponse, localVarThrowable) -> {
if (localVarThrowable != null) {
localVarResult.completeExceptionally(localVarThrowable);
} else if (!localVarResult.complete(localVarApiResponse)) {
{{{returnType}}} localVarUndeliveredBody = localVarApiResponse.getData();
if (localVarUndeliveredBody != null) {
try {
localVarUndeliveredBody.close();
} catch (IOException ignored) {
// The result is already terminal, so cleanup failure has no receiver.
}
}
}
});
return localVarResult;
{{/vendorExtensions.x-java-native-response-input-stream}}
}
catch (ApiException e) {
return CompletableFuture.failedFuture(e);
Expand Down Expand Up @@ -723,6 +808,21 @@ public class {{classname}} {
localVarRequestBuilder.header("Accept-Encoding", "gzip");
{{/useGzipFeature}}

{{#vendorExtensions.x-java-native-body-input-stream}}
{{#bodyParam}}
// Caller-provided InputStream bodies are one-shot; repeated sends fail deterministically.
AtomicReference<InputStream> localVarRequestBody = new AtomicReference<>({{paramName}});
Supplier<InputStream> localVarRequestBodySupplier = () -> localVarRequestBody.getAndSet(null);
{{#useGzipFeature}}
localVarRequestBuilder.header("Content-Encoding", "gzip");
localVarRequestBuilder.method("{{httpMethod}}", ApiClient.gzipRequestBody(localVarRequestBodySupplier));
{{/useGzipFeature}}
{{^useGzipFeature}}
localVarRequestBuilder.method("{{httpMethod}}", HttpRequest.BodyPublishers.ofInputStream(localVarRequestBodySupplier));
{{/useGzipFeature}}
{{/bodyParam}}
{{/vendorExtensions.x-java-native-body-input-stream}}
{{^vendorExtensions.x-java-native-body-input-stream}}
{{#bodyParam}}
{{#isString}}
{{#useGzipFeature}}
Expand Down Expand Up @@ -750,6 +850,7 @@ public class {{classname}} {
}
{{/isString}}
{{/bodyParam}}
{{/vendorExtensions.x-java-native-body-input-stream}}
{{^bodyParam}}
{{#hasFormParams}}
{{#isMultipart}}
Expand Down Expand Up @@ -956,4 +1057,4 @@ public class {{classname}} {
{{/vendorExtensions.x-group-parameters}}
{{/operation}}
}
{{/operations}}
{{/operations}}
Loading