JAVA-SDK: Abgleich der API-Methoden
Warum?
Dieses Ticket implementiert Akzeptanzkriterium 6 von #863 (closed).
Akzeptanzkriterien
Die hier aufgelisteten API-Methoden sind anzugleichen.
Client Factory
| Funktion | .NET | Java | Match |
|---|---|---|---|
| Neuer Sender | Client.GetSender(environment, clientId, clientSecret, logger) | ClientFactory.senderClient() ClientFactory.senderClient(config) |
|
| Neuer Subscriber | Client.GetSubscriber(environment, clientId,slientSecret, privateKeyDecryption, privateKeySigning, logger) | ClientFactory.subscriberClient() ClientFactory.subscriberClient(config) |
|
| Neuer Routing Client | Client.GetSender(environment,clientId, logger) | ClientFactory.senderClient() ClientFactory.senderClient(config) |
Submission Payload / Builder
| Funktion | .NET | Java | Match |
|---|---|---|---|
| Neuer Submission Builder | SubmissionBuilder (static) |
SubmissionBuilder.Builder() |
|
| Mit Destination | WithDestination(string destinationId) |
withDestination(final UUID destinationId) |
|
| Mit Attachments (optional) |
WithAttachments(List<Attachment> attachments) WithAttachments(params Attachment[] attachments) WithAttachments(string fileName, string description, string mimeType,FileStream fileStream)
|
withAttachments(final List<File> attachments) withAttachment(final File attachment)
|
|
| Mit XML Fachdaten | WithXmlData(string data) |
withXmlData(final String xmlData) |
|
| Mit JSON Fachdaten | WithJsonData(string data) |
withJsonData(final String jsonData) |
|
| Mit ServiceType | WithServiceType(string serviceName, string leikaKey) |
withServiceType(final String serviceTypeName, final String leikaKey) withServiceType(final String serviceTypeName, final String description, final String leikaKey)
|
|
| Payload bauen | SubmissionBuilder .Build() => SendableSubmission |
SubmissionBuilder.Build() => SubmissionPayload |
Encrypted Submission Payload / Builder
| Funktion | .NET | Java | Match |
|---|---|---|---|
| Neuer Submission Builder | EncryptedSubmissionBuilder (static) |
EncryptedSubmissionBuilder.Builder() |
|
| Mit Destination | WithDestination(string destinationId) |
withDestination(final UUID destinationId) |
|
| Mit Attachments (optional) | WithEncryptedAttachments(Dictionary<string, string> attachments) |
withEncryptedAttachments(final Map<UUID, String> encryptedAttachments) withEncryptedAttachment(final UUID attachmentId, final String encryptedAttachment)
|
|
| Mit Fachdaten | WithEncryptedData(string data) |
withEncryptedData(final String encryptedData) |
|
| Mit Metadaten | WithEncryptedMetaData(string metaData) |
withEncryptedMetadata(final String encryptedMetadata) |
|
| Mit ServiceType | WithServiceType(string serviceName, string leikaKey) |
withServiceType(final String serviceTypeName, final String leikaKey) withServiceType(final String serviceTypeName, final String description, final String leikaKey)
|
|
| Payload bauen | EncryptedSubmissionBuilder .Build() => SendableEncryptedSubmission |
EncryptedSubmissionBuilder.Build() => EncryptedSubmissionPayload |
Sender Client
| Funktion | .NET | Java | Match |
|---|---|---|---|
| Public Key Abruf | Task<string> GetPublicKeyForDestinationAsync(string destinationId) |
Optional<String> getPublicKey(final UUID destinationId) |
|
| Submission Senden | Task<SentSubmission> SendAsync(SendableSubmission submission) |
SentSubmission submit(final SubmissionPayload submissionPayload) |
|
| Verschlüsselte Submission Senden | Task<SentSubmission> SendAsync(SendableEncryptedSubmission submission) |
SentSubmission submit(final EncryptedSubmissionPayload encryptedSubmissionPayload) |
|
| Eventlog Abruf | wurde entfernt | List<EventLogEntry> getEventLog(final UUID caseId, final UUID destinationId) |
wird in java entfernt |
| Status Abruf | --- | EventStatus getStatusForSubmission(final SentSubmission sentSubmission) |
|
| Callback Validierung | wird im subscriber ausgeführt | ValidationResult validateCallback(String hmac, Long timestamp, String httpBody, String callbackSecret) |
Abgleich wo der check sattfinden soll |
Subscriber Client
| Funktion | .NET | Java | Match |
|---|---|---|---|
| Submissions Laden | Task<IEnumerable<SubmissionForPickupDto>> GetAvailableSubmissionsAsync(string? destinationId =null,int skip = 0,int take = 100) |
Set<SubmissionForPickup> getAvailableSubmissions(final UUID destinationId) Set<SubmissionForPickup> getAvailableSubmissions(final UUID destinationId, final int offset, final int limit)
|
|
| Einzelne Submission Laden |
async Task<ISubscriberWithSubmission> RequestSubmissionAsync(SubmissionForPickupDto submission) Task<ISubscriberWithSubmission> RequestSubmissionAsync(string submissionId)
|
ReceivedSubmission requestSubmission(final UUID submissionId) |
|
| Accept Submission | Task AcceptSubmissionAsync(params Problems[] problems) |
receivedSubmission.acceptSubmission() |
wird bei Java auf der ReceivedSubmission ausgeführt |
| Reject Submission | Task RejectSubmissionAsync(params Problems[] problems) |
receivedSubmission.rejectSubmission(List<Problem> problems) |
wird bei Java auf der ReceivedSubmission ausgeführt |
| Callback Validierung | string VerifyCallback(string callbackSecret,long timestamp, string body) |
wird im sender ausgeführt | Abgleich wo der check sattfinden soll |
Routing Client
| Funktion | .NET | Java | Match |
|---|---|---|---|
| Zustellpunkte suchen | Task<List<Route>> FindDestinationsAsync(string leiaKey, string? ags = null,string? ars = null,string? areaId = null, bool skipValidation = false) |
Set<SubmissionForPickup> getAvailableSubmissions(final UUID destinationId) List<Route> findDestinations(final String leikaKey, final String ars, final String ags, final String areaId, final int offset, final int limit)
|
|
| Gebiete suchen | Task<IEnumerable<Area>> GetAreas(string filter, int offset = 0,int limit = 100) |
List<Area> getArea(final String filter, final int offset, final int limit) List<Area> getArea(final List<String> filters, final int offset, final int limit)
|
Edited by Henry Borasch