Phase I: Bulk Operation Support by kqarryzada · Pull Request #288 · pingidentity/scim2

kqarryzada · 2026-03-10T21:06:26Z

This commit adds phase I of support for SCIM bulk request management for client and server applications. This initial phase focuses on the object models for bulk entities. This also includes a BulkResourceMapper, which will help provide an API for obtaining the "data" and "response" fields of bulk requests/responses as Java POJOs, simplifying object handling for client applications.

This commit also includes updates for the exception package. New errors related to bulk requests (HTTP 413 and HTTP 429) have been added. Additionally, HTTP status values can now be obtained from exception objects.

Reviewer: braveulysses
Reviewer: dougbulkley
Reviewer: selliott512
Reviewer: vyhhuang

JiraIssue: DS-39451

Resolves #107

This commit adds phase I of support for SCIM bulk request management for client and server applications. This initial phase focuses on the object models for bulk entities. This also includes a BulkResourceMapper, which will help provide an API for obtaining the "data" and "response" fields of bulk requests/responses as Java POJOs, simplifying object handling for client applications. This commit also includes updates for the exception package. New errors related to bulk requests (HTTP 413 and HTTP 429) have been added. Additionally, HTTP status values can now be obtained from exception objects. Reviewer: braveulysses Reviewer: dougbulkley Reviewer: selliott512 Reviewer: vyhhuang JiraIssue: DS-39451

kqarryzada · 2026-03-10T21:16:00Z

scim2-sdk-client/src/main/java/com/unboundid/scim2/client/requests/BulkRequestBuilder.java

+   * @throws ScimException If the SCIM service responded with an error.
+   */
+  @NotNull
+  public BulkResponse invoke() throws ScimException


The layout of this class largely follows the other builders. However, the invoke() method is somewhat unique because any SCIM resources will be included within the BulkResponse, so the returned object is never typed. This is why we'll need to have the mapper class in Phase 2.

kqarryzada · 2026-03-10T21:16:44Z

scim2-sdk-common/src/main/java/com/unboundid/scim2/common/bulk/BulkOperation.java

+
+package com.unboundid.scim2.common.bulk;
+
+public abstract class BulkOperation


This class, as well as other related classes, will be filled out in Phase 2. They're included here so that they may be referenced by BulkRequestBuilder.

braveulysses

Thanks, Khalid — this looks like good, conscientious work, and it's great to see bulk operation support landing in the SDK.

braveulysses · 2026-03-13T02:30:41Z

scim2-sdk-client/src/main/java/com/unboundid/scim2/client/ScimService.java

+  @NotNull
+  public BulkRequestBuilder bulkRequest()
+  {
+    return new BulkRequestBuilder(baseTarget.path("Bulk"));


Nit: I realize that this string literal is only used here, but consider defining it in ApiConstants alongside SCHEMAS_ENDPOINT, ME_ENDPOINT, et al.

Thanks Jacob, good call. I've added this.

braveulysses · 2026-03-13T02:43:09Z

scim2-sdk-common/src/main/java/com/unboundid/scim2/common/bulk/BulkResourceMapper.java

+   */
+  @NotNull
+  @SuppressWarnings("unchecked")
+  static <T extends ScimResource> Class<T> get(@NotNull final Set<String> s)


Nit: Consider giving the argument a descriptive name like schemas instead of s.

I'll be honest, I only did this so that the method declaration could fit on one line. It felt harmless since the method is a one-liner and it is not public anyway. But if you feel strongly about it, let me know and I'll change it.

I definitely don't feel strongly about it. 🙂

Updated add() and put() so that the methods are synchronized, offering some level of thread safety for writes to the map that occur during startup.

vyhhuang

These changes look good to me.

selliott512

This is an incomplete list of comments that I thought I'd share what I have for now.

selliott512 · 2026-03-24T22:28:10Z

scim2-sdk-client/src/main/java/com/unboundid/scim2/client/requests/BulkRequestBuilder.java

+   *                        as if the JSON body was too large.
+   */
+  @NotNull
+  protected <C> C invoke(@NotNull final Class<C> cls)


Do you wanted this protected? Many of the other builds just have public.

I set this as protected because there's virtually no reason I can think of that a caller would want anything other than a BulkResponse object returned. However, if they really need it, they could extend this class and achieve that result this way. Making it protected allows for this, even though I think it's unlikely.

selliott512 · 2026-03-24T22:29:03Z

scim2-sdk-client/src/main/java/com/unboundid/scim2/client/requests/BulkRequestBuilder.java

+   * @return  This bulk request builder.
+   */
+  @NotNull
+  public BulkRequestBuilder append(@Nullable final List<BulkOperation> ops)


The other builders have addOperation. Would addOperations be a good name for this method?

I considered this, but the term "operation" felt like it was getting overloaded between "patch operation" and "bulk operation". This will become more noticeable in Phase 2, where there is a bulk operation type for patch requests, so the nomenclature has the potential to become confusing. So I decided to name this as "append" just to avoid confusion. What do you think?

selliott512 · 2026-03-25T18:12:38Z

scim2-sdk-common/src/main/java/com/unboundid/scim2/common/utils/ApiConstants.java

+   * {@link com.unboundid.scim2.common.bulk.BulkOperation BulkOperation}.
+   */
+  @NotNull
+  public static final String BULK_PREFIX = "bulkId:";


You added this, but you don't use it, which I think means callers will need to correlate results to their requests by index. That's probably ok because the caller probably has an ordered list of requests used to build the bulk request, but I just wanted to share my impression of what is happening.

This is mostly placed so that client requests can easily reference another bulk operation without having to hard-code their own prefix. So they will have to correlate it themselves, yes.

selliott512 · 2026-03-25T18:40:48Z

scim2-sdk-common/src/main/java/com/unboundid/scim2/common/bulk/BulkOpType.java

+/**
+ * An enum representing possible bulk operation types.
+ */
+public enum BulkOpType


Is this phase 2? It does not seem to be used, at least internally. If you just want the constants there is Jakarta, but I understand that enums are helpful, and indicate a specific set of allowed value. In any case, if we need this it seems it could be simplified, pretty much:

public enum BulkOpType { POST, PUT, PATCH, DELETE }

But I'm probably missing something.

Great question, yes, this is needed for Phase 2.

Also, it's worth noting that the majority of these changes are placed in scim2-sdk-common since entities like bulk operations are model objects. The only dependency that common has is Jackson, so Jakarta utilities are not available to us in the common module anyway.

kqarryzada requested review from braveulysses, dougbulkley, selliott512 and vyhhuang March 10, 2026 21:06

kqarryzada self-assigned this Mar 10, 2026

pingidentity locked and limited conversation to collaborators Mar 10, 2026

pingidentity unlocked this conversation Mar 10, 2026

kqarryzada commented Mar 10, 2026

View reviewed changes

kqarryzada added 2 commits March 11, 2026 15:41

Add test case for out of order values.

1ce2d43

Fix checkstyle.

71d67ff

braveulysses approved these changes Mar 13, 2026

View reviewed changes

Review feedback and mapper updates.

e58d62b

Updated add() and put() so that the methods are synchronized, offering some level of thread safety for writes to the map that occur during startup.

dougbulkley approved these changes Mar 13, 2026

View reviewed changes

vyhhuang approved these changes Mar 16, 2026

View reviewed changes

selliott512 reviewed Mar 25, 2026

View reviewed changes

kqarryzada merged commit e80a56e into master Mar 27, 2026
6 checks passed

kqarryzada deleted the DS-39451-bulk-operation-support-phase-I branch March 27, 2026 22:11

pingidentity locked and limited conversation to collaborators Mar 27, 2026


		package com.unboundid.scim2.common.bulk;

		public abstract class BulkOperation

Conversation

kqarryzada commented Mar 10, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kqarryzada Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

braveulysses left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vyhhuang left a comment

Choose a reason for hiding this comment

Uh oh!

selliott512 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kqarryzada Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kqarryzada Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

kqarryzada Mar 10, 2026 •

edited

Loading

kqarryzada Mar 25, 2026 •

edited

Loading

kqarryzada Mar 25, 2026 •

edited

Loading