generated from SAP/repository-template
-
Notifications
You must be signed in to change notification settings - Fork 149
Added information regarding de-/serialization of custom data types #2465
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
t-bonk
wants to merge
1
commit into
main
Choose a base branch
from
technical-outbox-api-tip-for-unknown-datatypes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -321,6 +321,45 @@ You must ensure that the handler is completing the context, after executing the | |
|
|
||
| [Learn more about event handlers.](./event-handlers/){.learn-more} | ||
|
|
||
| ::: tip Preparing outbox entries with custom data types | ||
|
|
||
| The outbox has no information regarding the structure and the data types that | ||
| shall be serialized and deserialized to and from the outbox. To avoid | ||
| serialization and deserialization errors, the corresponding data objects must | ||
| be transformed using custom outbox handlers: | ||
|
|
||
| ```java | ||
| @Component | ||
| @ServiceName(value = "*", type = OutboxService.class) | ||
| public class DwcOutboxHandler implements EventHandler { | ||
|
|
||
| @On | ||
| void publishedByOutbox(OutboxMessageEventContext context) { | ||
| // Restore DwC context only | ||
| if (Boolean.FALSE.equals(context.getIsInbound())) { | ||
| return; | ||
| } | ||
|
|
||
| // custom deserialization logic | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. a concrete small sample would help |
||
| } | ||
|
|
||
| @Before(event = "*") | ||
| void prepareOutboxMessage(OutboxMessageEventContext context) { | ||
| // prepare outbox message for storage only | ||
| if (Boolean.TRUE.equals(context.getIsInbound())) { | ||
| return; | ||
| } | ||
|
|
||
| // custom serialization logic | ||
| } | ||
| } | ||
|
|
||
| **Don't complete the context in any of those two handlers, otherwise other | ||
| handlers aren't called.** | ||
| ``` | ||
|
|
||
| ::: | ||
|
|
||
| ## Handling Outbox Errors { #handling-outbox-errors } | ||
|
|
||
| The outbox by default retries publishing a message, if an error occurs during processing, until the message has reached the maximum number of attempts. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should better not publish DwC-related examples