diff --git a/src/main/java/de/ozgcloud/xta/client/model/XtaIdentifier.java b/src/main/java/de/ozgcloud/xta/client/model/XtaIdentifier.java index 8ea86a7eeeaea8640df9f3a9a3fc623d6e98ffd9..0156f132c2c9e13c182e1e42ab38a101d3678d22 100644 --- a/src/main/java/de/ozgcloud/xta/client/model/XtaIdentifier.java +++ b/src/main/java/de/ozgcloud/xta/client/model/XtaIdentifier.java @@ -5,6 +5,27 @@ import jakarta.validation.constraints.NotBlank; import lombok.Builder; +/** + * An XTA party identifier which identifies XTA (reader/author) clients or (sender/receiver) server. + * + * <p> + * This client library only uses client identifiers and assumes an identifier type of {@code xoev}. The client certificate authorizes the use of an + * identifier value as reader/author. Note that name and category may be freely chosen and serve as documentation of the actual value. + * </p> + * + * Example: + * <pre> + * var clientIdentifier = XtaIdentifier.builder() + * .value("gae:dev-environment@ozg-cloud.de") + * .category("Generischer Antragsempfänger") + * .name("OZG-Cloud Dev") + * .build(); + * </pre> + * + * @param name The name of the identifier. <p>This field is optional.</p> + * @param category The category of the identifier. <p>This field is optional.</p> + * @param value The value of the identifier. <p>This field is required.</p> + */ @Builder public record XtaIdentifier( @Nullable String name,