Skip to content
Snippets Groups Projects
Commit 6dec2a70 authored by Jan Zickermann's avatar Jan Zickermann
Browse files

OZG-6891 xta-identifier: Add java-doc

parent 092674ee
Branches
Tags
No related merge requests found
...@@ -5,6 +5,27 @@ import jakarta.validation.constraints.NotBlank; ...@@ -5,6 +5,27 @@ import jakarta.validation.constraints.NotBlank;
import lombok.Builder; 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 @Builder
public record XtaIdentifier( public record XtaIdentifier(
@Nullable String name, @Nullable String name,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment