Added Abort API

Author: ShreyasSinha

google-cloud-storage/src/main/java/com/google/cloud/storage/HttpStorageOptions.java

@@ -26,8 +26,6 @@
 import com.google.api.gax.rpc.HeaderProvider;
 import com.google.api.gax.tracing.ApiTracerFactory;
 import com.google.auth.Credentials;
-import com.google.cloud.storage.Retrying.DefaultRetrier;
-import com.google.cloud.storage.Retrying.HttpRetrier;
 import com.google.cloud.storage.Retrying.RetryingDependencies;
 import com.google.cloud.ServiceFactory;
 import com.google.cloud.ServiceRpc;

google-cloud-storage/src/main/java/com/google/cloud/storage/MultipartUpload.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.cloud.storage;
+
+import com.google.api.core.BetaApi;
+import com.google.api.core.InternalExtensionOnly;
+import com.google.cloud.storage.multipartupload.model.AbortMultipartUploadRequest;
+import com.google.cloud.storage.multipartupload.model.AbortMultipartUploadResponse;
+import com.google.cloud.storage.multipartupload.model.CompleteMultipartUploadRequest;
+import com.google.cloud.storage.multipartupload.model.CompleteMultipartUploadResponse;
+import com.google.cloud.storage.multipartupload.model.CreateMultipartUploadRequest;
+import com.google.cloud.storage.multipartupload.model.CreateMultipartUploadResponse;
+import com.google.cloud.storage.multipartupload.model.UploadPartRequest;
+import com.google.cloud.storage.multipartupload.model.UploadPartResponse;
+import java.io.IOException;
+import java.net.URI;
+import java.security.NoSuchAlgorithmException;
+
+@BetaApi
+@InternalExtensionOnly
+public abstract class MultipartUploadClient {
+
+  MultipartUploadClient() {}
+
+  public abstract CreateMultipartUploadResponse createMultipartUpload(CreateMultipartUploadRequest request)
+      throws IOException;
+
+  public abstract UploadPartResponse uploadPart(UploadPartRequest request, RequestBody requestBody)
+      throws IOException;
+
+  public abstract CompleteMultipartUploadResponse completeMultipartUpload(
+      CompleteMultipartUploadRequest request)
+      throws NoSuchAlgorithmException, IOException;
+
+  public abstract AbortMultipartUploadResponse abortMultipartUpload(AbortMultipartUploadRequest request)
+      throws IOException;
+
+  public static MultipartUploadClient create(MultipartUploadSettings config) {
+    HttpStorageOptions options = config.getOptions();
+    return new MultipartUploadClientImpl(
+        URI.create(options.getHost()),
+        options.getStorageRpcV1().getStorage().getRequestFactory(),
+        options.createRetrier());
+  }
+}

google-cloud-storage/src/main/java/com/google/cloud/storage/MultipartUploadClient.java

@@ -19,36 +19,49 @@
 import static com.google.cloud.storage.MultipartUploadUtility.readStream;
 import static com.google.cloud.storage.MultipartUploadUtility.signRequest;
 
-import com.google.cloud.storage.multipartupload.model.CompleteMultipartRequest;
-import com.google.cloud.storage.multipartupload.model.CompleteMultipartResponse;
+import com.google.api.client.http.AbstractHttpContent;
+import com.google.api.client.http.HttpRequestFactory;
+import com.google.api.client.util.ObjectParser;
+import com.google.api.gax.grpc.GrpcStatusCode;
+import com.google.api.gax.rpc.UnimplementedException;
+import com.google.cloud.storage.Retrying.Retrier;
+import com.google.cloud.storage.multipartupload.model.AbortMultipartUploadRequest;
+import com.google.cloud.storage.multipartupload.model.AbortMultipartUploadResponse;
+import com.google.cloud.storage.multipartupload.model.CompleteMultipartUploadRequest;
+import com.google.cloud.storage.multipartupload.model.CompleteMultipartUploadResponse;
 import com.google.cloud.storage.multipartupload.model.CompletedPart;
 import com.google.cloud.storage.multipartupload.model.CreateMultipartUploadRequest;
 import com.google.cloud.storage.multipartupload.model.CreateMultipartUploadResponse;
 import com.google.cloud.storage.multipartupload.model.UploadPartRequest;
 import com.google.cloud.storage.multipartupload.model.UploadPartResponse;
+import io.grpc.Status;
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.OutputStream;
+import java.io.Reader;
+import java.lang.reflect.Type;
 import java.net.HttpURLConnection;
+import java.net.URI;
 import java.net.URL;
+import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
 import java.util.Base64;
 
-public class MultipartUploadImpl implements MultipartUpload {
-
-  private static final String BUCKET_NAME = "shreyassinha";
-  private static final String OBJECT_NAME = "5mb"; // The name for the object in GCS
-  private static final String FILE_PATH = "5mb-examplefile-com.txt"; // The local file to upload
+public class MultipartUploadClientImpl extends MultipartUploadClient {
 
   // Add HMAC keys from GCS Settings > Interoperability
 
   // --- End Configuration ---
   private static final String GCS_ENDPOINT = "https://storage.googleapis.com";
 
+  public MultipartUploadClientImpl(URI uri, HttpRequestFactory requestFactory, Retrier retrier) {
+  }
+
   public CreateMultipartUploadResponse createMultipartUpload(CreateMultipartUploadRequest request)
       throws IOException {
-    String resourcePath = "/" + request.getBucket() + "/" + request.getKey();
+    String resourcePath = "/" + request.bucket() + "/" + request.key();
     String uri = GCS_ENDPOINT + resourcePath + "?uploads";
     String date = getRfc1123Date();
     String contentType = "application/x-www-form-urlencoded";
@@ -74,13 +87,13 @@ public CreateMultipartUploadResponse createMultipartUpload(CreateMultipartUpload
     int start = responseBody.indexOf(uploadIdTag) + uploadIdTag.length();
     int end = responseBody.indexOf("</UploadId>");
     String uploadId = responseBody.substring(start, end);
-    return CreateMultipartUploadResponse.newBuilder().setUploadId(uploadId).build();
+    return CreateMultipartUploadResponse.builder().uploadId(uploadId).build();
   }
 
   public UploadPartResponse uploadPart(UploadPartRequest request, RequestBody requestBody)
       throws IOException {
-    String resourcePath = "/" + request.getBucket() + "/" + request.getKey();
-    String queryString = "?partNumber=" + request.getPartNumber() + "&uploadId=" + request.getUploadId();
+    String resourcePath = "/" + request.bucket() + "/" + request.key();
+    String queryString = "?partNumber=" + request.partNumber() + "&uploadId=" + request.uploadId();
     String uri = GCS_ENDPOINT + resourcePath + queryString;
     String date = getRfc1123Date();
     String contentType = "application/octet-stream";
@@ -94,32 +107,32 @@ public UploadPartResponse uploadPart(UploadPartRequest request, RequestBody requ
     connection.setRequestProperty("Date", date);
     connection.setRequestProperty("Authorization", authHeader);
     connection.setRequestProperty("Content-Type", contentType);
-    connection.setFixedLengthStreamingMode(requestBody.getPartDate().length);
+    connection.setFixedLengthStreamingMode(requestBody.getPartData().length);
     connection.setDoOutput(true);
 
     try (OutputStream os = connection.getOutputStream()) {
-      os.write(requestBody.getPartDate());
+      os.write(requestBody.getPartData());
     }
 
     if (connection.getResponseCode() != 200) {
       String error = readStream(connection.getErrorStream());
-        throw new RuntimeException("Failed to upload part " + request.getPartNumber() + ": " + connection.getResponseCode() + " " + error);
+        throw new RuntimeException("Failed to upload part " + request.partNumber() + ": " + connection.getResponseCode() + " " + error);
     }
     String eTag = connection.getHeaderField("ETag");
-    return UploadPartResponse.newBuilder().setEtag(eTag).build();
+    return UploadPartResponse.builder().etag(eTag).build();
   }
 
-  public CompleteMultipartResponse completeMultipartUpload(CompleteMultipartRequest request)
+  public CompleteMultipartUploadResponse completeMultipartUpload(CompleteMultipartUploadRequest request)
       throws NoSuchAlgorithmException, IOException {
-    String resourcePath = "/" + request.getBucket() + "/" + request.getKey();
-    String queryString = "?uploadId=" + request.getUploadId();
+    String resourcePath = "/" + request.bucket() + "/" + request.key();
+    String queryString = "?uploadId=" + request.uploadId();
     String uri = GCS_ENDPOINT + resourcePath + queryString;
 
     StringBuilder xmlBodyBuilder = new StringBuilder("<CompleteMultipartUpload>\n");
-    for (CompletedPart part : request.getCompletedMultipartUpload().getCompletedPartList()) {
+    for (CompletedPart part : request.completedMultipartUpload().completedPartList()) {
       xmlBodyBuilder.append("  <Part>\n");
-      xmlBodyBuilder.append("    <PartNumber>").append(part.getPartNumber()).append("</PartNumber>\n");
-      xmlBodyBuilder.append("    <ETag>").append(part.getEtag()).append("</ETag>\n");
+      xmlBodyBuilder.append("    <PartNumber>").append(part.partNumber()).append("</PartNumber>\n");
+      xmlBodyBuilder.append("    <ETag>").append(part.etag()).append("</ETag>\n");
       xmlBodyBuilder.append("  </Part>\n");
     }
     xmlBodyBuilder.append("</CompleteMultipartUpload>");
@@ -153,4 +166,89 @@ public CompleteMultipartResponse completeMultipartUpload(CompleteMultipartReques
     }
     return null;
   }
+
+  @Override
+  public AbortMultipartUploadResponse abortMultipartUpload(AbortMultipartUploadRequest request) throws IOException{
+    String resourcePath = "/" + request.bucket() + "/" + request.key();
+    String queryString = "?uploadId=" + request.uploadId();
+    String uri = GCS_ENDPOINT + resourcePath + queryString;
+    String date = getRfc1123Date();
+
+    // GCS Signature Rule #4: The query string IS NOT included for the DELETE abort request.
+    String signature = signRequest("DELETE", "", "", date, resourcePath, GOOGLE_SECRET_KEY);
+
+    String authHeader = "GOOG1 " + GOOGLE_ACCESS_KEY + ":" + signature;
+
+    HttpURLConnection connection = (HttpURLConnection) new URL(uri).openConnection();
+    connection.setRequestMethod("DELETE");
+    connection.setRequestProperty("Date", date);
+    connection.setRequestProperty("Authorization", authHeader);
+
+    if (connection.getResponseCode() != 204) {
+      String error = readStream(connection.getErrorStream());
+      throw new RuntimeException("Failed to abort upload: " + connection.getResponseCode() + " " + error);
+    }
+    return new AbortMultipartUploadResponse();
+  }
+
+  private static final class Utf8StringRequestContent extends AbstractHttpContent {
+
+    private final byte[] xml;
+
+    private Utf8StringRequestContent(byte[] xml) {
+      // https://www.ietf.org/rfc/rfc2376.txt#:~:text=6.1%20text/xml%20with%20UTF%2D8%20Charset
+      super("text/xml;charset=utf-8");
+      this.xml = xml;
+    }
+
+    @Override
+    public long getLength() throws IOException {
+      return super.getLength();
+    }
+
+    @Override
+    public void writeTo(OutputStream out) throws IOException {
+      out.write(xml);
+    }
+
+    public static Utf8StringRequestContent of(String xml) {
+      return new Utf8StringRequestContent(xml.getBytes(StandardCharsets.UTF_8));
+    }
+  }
+
+  private static class XmlObjectParser implements ObjectParser {
+
+    @Override
+    public <T> T parseAndClose(InputStream in, Charset charset, Class<T> dataClass)
+        throws IOException {
+      try (InputStream is = in) {
+        return todo();
+      }
+    }
+
+    @Override
+    public Object parseAndClose(InputStream in, Charset charset, Type dataType) throws IOException {
+      try (InputStream is = in) {
+        return todo();
+      }
+    }
+
+    @Override
+    public <T> T parseAndClose(Reader reader, Class<T> dataClass) throws IOException {
+      try (Reader r = reader) {
+        return todo();
+      }
+    }
+
+    @Override
+    public Object parseAndClose(Reader reader, Type dataType) throws IOException {
+      try (Reader r = reader) {
+        return todo();
+      }
+    }
+
+    private static <T> T todo() {
+      throw new UnimplementedException("todo", null, GrpcStatusCode.of(Status.Code.UNIMPLEMENTED), false);
+    }
+  }
 }

google-cloud-storage/src/main/java/com/google/cloud/storage/MultipartUploadImpl.java renamed to google-cloud-storage/src/main/java/com/google/cloud/storage/MultipartUploadClientImpl.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.google.cloud.storage;
+
+public final class MultipartUploadSettings {
+  private final HttpStorageOptions options;
+
+  private MultipartUploadSettings(HttpStorageOptions options) {
+    this.options = options;
+  }
+
+  public HttpStorageOptions getOptions() {
+    return options;
+  }
+
+  public static MultipartUploadSettings of(HttpStorageOptions options) {
+    return new MultipartUploadSettings(options);
+  }
+}