feat: enhance identifier handling with new generated model by Sotatek-DucPhung · Pull Request #64 · cardano-foundation/cf-signify-java

Sotatek-DucPhung · 2025-12-01T12:37:53Z

Introduced IdentifierModelConverter for converting generated KERIA models to domain models.
Added IdentifierPayloadMapper to build request payloads for identifier endpoints.
Updated Identifier class to utilize GeneratedModelMapper for JSON parsing.
Modified IdentifierListResponse to use a list of Identifier objects instead of generic Object.
Implemented KeyStateRecordDeserializer to handle deserialization of KeyStateRecord.
Centralized Jackson configuration in GeneratedModelConfig for better management of generated models.
Updated various tests to reflect changes in identifier handling and ensure consistency.

- Introduced IdentifierModelConverter for converting generated KERIA models to domain models. - Added IdentifierPayloadMapper to build request payloads for identifier endpoints. - Updated Identifier class to utilize GeneratedModelMapper for JSON parsing. - Modified IdentifierListResponse to use a list of Identifier objects instead of generic Object. - Implemented KeyStateRecordDeserializer to handle deserialization of KeyStateRecord. - Centralized Jackson configuration in GeneratedModelConfig for better management of generated models. - Updated various tests to reflect changes in identifier handling and ensure consistency.

src/main/java/org/cardanofoundation/signify/app/config/GeneratedModelMapper.java

iFergal · 2025-12-01T16:01:55Z

src/main/java/org/cardanofoundation/signify/app/aiding/KeyStateRecordDeserializer.java

+        ObjectNode node = mapper.readTree(p);
+
+        coerceToString(node, "kt");
+        coerceToString(node, "nt");


Do we really ever get ints back from the API? I thought it was always strings. (I know the API for creating an identifier accepts both though, which is different)

We hit a parse failure when kt/nt came back as an array (rotation thresholds), so this coerces non-text (array/number) to a string before binding.
If the API is guaranteed to return strings only, I can tighten this to handle only arrays (or drop the coercion and let it fail loudly). Let me know your prefer

Ah yes, but it's an array of strings. I think @Sotatek-Patrick-Vu might be fixing this, or have fixed it. We should return the string array, not a string.

updated in coerceToString method

Right but is it possible to receive a numeric response from the API? I don't think it is (may be a mistake in Patrick's generated models)

@Sotatek-Patrick-Vu could you please take a look for these field ?

We are expecting kt, nt properties are string or array string or array of array string But It seems we cannot generate correct in java

@Sotatek-DucPhung @Sotatek-PhongVu @Sotatek-Patrick-Vu It's also not generated correctly in Signify-TS: https://github.com/WebOfTrust/signify-ts/blob/main/src/types/keria-api-schema.ts#L363

This is referring to the Key State only.

So I think there are missing changes in KERIA to generate this correctly in both Signify-TS and Signify-Java: cardano-foundation/keria#16

After fixing keria and here is the new type in signify-ts:

KeyStateRecord { ... kt: string | string[]; nt: string | string[]; ... }

Indeed @Sotatek-Patrick-Vu if you can fix this PR to remove coerceToString and have proper types that'd be great!

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierPayloadMapper.java

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierModelConverter.java

src/main/java/org/cardanofoundation/signify/app/config/GeneratedModelMapper.java

src/main/java/org/cardanofoundation/signify/app/aiding/Identifier.java

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierPayloadMapper.java

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierModelConverter.java

…ctly

…ds and using direct calls

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierModelConverter.java

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierPayloadMapper.java

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierModelConverter.java

…d node types

…hods for consistency

…onsistency and clarity

…ier-model refactor: replace States with Tier in multiple classes for improved c…

…s and rstates

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierPayloadMapper.java

iFergal · 2025-12-09T17:55:17Z

src/main/java/org/cardanofoundation/signify/app/aiding/KeyStateRecordDeserializer.java

+        ObjectNode node = mapper.readTree(p);
+
+        coerceToString(node, "kt");
+        coerceToString(node, "nt");


Still pending a response here!

src/main/java/org/cardanofoundation/signify/core/Manager.java

src/main/java/org/cardanofoundation/signify/cesr/Keeping.java

src/main/java/org/cardanofoundation/signify/app/config/GeneratedModelMapper.java

src/test/java/org/cardanofoundation/signify/app/RegistryTest.java

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierPayloadMapper.java

iFergal · 2025-12-09T19:12:31Z

src/main/java/org/cardanofoundation/signify/app/Contacting.java

Pointer to https://github.com/cardano-foundation/cf-signify-java/pull/59/files#r2604004041

Should be resolved before this PR is merged!

@Sotatek-DucPhung Please check my comment there: #59 (comment)

Those changes MUST be fixed in this PR before merging.

If it will take time to fix those, and we resolve the other comment in this thread first. We could defer fixing these until the next PR

yep, sounds good to me

Sotatek-DucPhung · 2025-12-10T17:52:13Z

@iFergal please take a look again! Thanks

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierController.java

iFergal · 2025-12-17T09:25:02Z

src/main/java/org/cardanofoundation/signify/app/coring/KeyStates.java

+            return Optional.empty();
+        }
+
+        // Note: KERIA can return either a single object or an array


I don't believe this is true:

states = [] for pre in pres: if pre not in agent.hby.kevers: continue kever = agent.hby.kevers[pre] states.append(asdict(kever.state())) rep.status = falcon.HTTP_200 rep.content_type = "application/json" rep.data = json.dumps(states).encode("utf-8")

In fact, this endpoint could just take pre and call .list([pre]) or something

so this keria endpoint return an array right ?

Yep. For both .get and .list it will return a list from the endpoint. If .get, it will be an array of length 1 at most.

(It could be [] if you call .get with an AID that KERIA does not know about (the continue line above))

iFergal · 2025-12-17T09:25:15Z

src/main/java/org/cardanofoundation/signify/app/coring/KeyStates.java

-        return Optional.of(Utils.fromJson(res.body(), Object.class));
+
+        String body = res.body();
+        if (body == null || body.isBlank()) {


It will always at least return an empty array

iFergal · 2025-12-17T09:29:24Z

src/main/java/org/cardanofoundation/signify/app/aiding/KeyStateRecordDeserializer.java

+        ObjectNode node = mapper.readTree(p);
+
+        coerceToString(node, "kt");
+        coerceToString(node, "nt");


This is incorrect, we are not meant to have strings of JSON arrays. We are meant to have arrays.

Please work with Patrick to get the OpenAPI changes needed to update the generated model and have the correct format.

iFergal · 2025-12-17T09:30:03Z

src/main/java/org/cardanofoundation/signify/app/Contacting.java

@Sotatek-DucPhung Please check my comment there: #59 (comment)

Those changes MUST be fixed in this PR before merging.

…StateRecord

Sotatek-Patrick-Vu · 2026-02-12T09:23:12Z

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierController.java

 import static org.cardanofoundation.signify.core.Httping.parseRangeHeaders;

-public class Identifier {
+public class IdentifierController {


I'm wondering why we need to change this class name?

This class name is defined in Signify itself (not a type from KERIA), so I guess it was renamed to not conflict with the generated Identifier.java. But if we update that, we should be updating the others to be consistent.

However, it's not really a HTTP controller. This is the class used in client.identifiers()

Sotatek-Patrick-Vu · 2026-02-12T09:42:07Z

@iFergal Do you think we need to re-generate models because we changed this in keria? WebOfTrust/keria@262b7ce

iFergal · 2026-02-12T13:54:13Z

@Sotatek-Patrick-Vu imo lets do this:

Re-generate the modals using main, and create a PR against main to update those
Rebase this PR

That way, this PR just shows the changes as a result of updating the type generation config for the plugin, and not mixed with changes from the new KERIA API.

Sotatek-DucPhung added 2 commits December 1, 2025 19:34

chore: remove inline import

446f364

Sotatek-DucPhung requested a review from iFergal December 1, 2025 12:40

iFergal reviewed Dec 1, 2025

View reviewed changes

Sotatek-DucPhung added 6 commits December 2, 2025 16:12

refactor: streamline JSON parsing in Identifier class

3810e9b

refactor: simplify group state handling in IdentifierModelConverter

7e9a244

fix: improve KeyStateRecordDeserializer to handle numeric nodes corre…

babb9ea

…ctly

refactor: use direct method calls for transferable and windexes

678cc85

refactor: simplify IdentifierModelConverter by removing default metho…

5e5f848

…ds and using direct calls

refactor: enforce non-null parameters in IdentifierPayloadMapper

0ab4dd0

iFergal reviewed Dec 2, 2025

View reviewed changes

Sotatek-DucPhung added 4 commits December 3, 2025 15:36

refactor: add nullability annotations to pars

4cca638

refactor: update KeyStateRecordDeserializer to fail fast on unexpecte…

0126fbc

…d node types

refactor: remove unused buildExchangePayload

2b4451d

refactor: replace HabState with Identifier in various classes and met…

c099e48

…hods for consistency

Sotatek-DucPhung force-pushed the feat/enchange-identifier-handling-with-new-generated-model branch from 6666b59 to c099e48 Compare December 3, 2025 11:43

Sotatek-DucPhung and others added 3 commits December 4, 2025 18:10

refactor: replace States with Tier in multiple classes for improved c…

68dd696

…onsistency and clarity

Merge pull request #65 from cardano-foundation/fix/import-generated-t…

1f5c65f

…ier-model refactor: replace States with Tier in multiple classes for improved c…

refactor: update CreateIdentifierArgs to use KeyStateRecord for state…

91ee571

…s and rstates

iFergal reviewed Dec 9, 2025

View reviewed changes

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierPayloadMapper.java Outdated Show resolved Hide resolved

iFergal mentioned this pull request Dec 9, 2025

chore: generate API level classes from KERIA OpenAPI #59

Merged

iFergal reviewed Dec 9, 2025

View reviewed changes

Sotatek-DucPhung added 4 commits December 10, 2025 16:07

chore: remove Payload mapper

45f4e58

chore: use inline builder for Identifier

305e1ae

chore: correct getTier()

cbf3016

chore: remove unused file

d4243dd

Sotatek-DucPhung requested a review from iFergal December 10, 2025 17:46

iFergal reviewed Dec 12, 2025

View reviewed changes

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierController.java Outdated Show resolved Hide resolved

Sotatek-DucPhung added 5 commits December 14, 2025 15:02

chore: use EndrolesAidPostRequest for addEndRole api

50ed3aa

feat: Update KeyStates to user KeyStateRecord

e604625

feat: update KeyStateRecordDeserializer

b00ea03

feat: handle logic KeyStates get method return an array

3970072

feat: add TODO for using generated model request IdentifiersPostRequest

bcffb6a

iFergal reviewed Dec 17, 2025

View reviewed changes

feat: simplify KeyStates response handling to always return first Key…

fc304fe

…StateRecord

Sotatek-Patrick-Vu reviewed Feb 12, 2026

View reviewed changes

Conversation

Sotatek-DucPhung commented Dec 1, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Sotatek-DucPhung Dec 1, 2025 • 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!

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

Sotatek-DucPhung commented Dec 10, 2025

Uh oh!

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!

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!

Sotatek-Patrick-Vu commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iFergal commented Feb 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Sotatek-DucPhung Dec 1, 2025 •

edited

Loading

Sotatek-Patrick-Vu commented Feb 12, 2026 •

edited

Loading