Package org.axonframework.messaging.eventhandling.processing.streaming.token.store

Interface LegacyTokenTypeMapper

All Known Implementing Classes:
MultiSourceLegacyTokenTypeMapper
@Internal @Deprecated(since="5.2.0", forRemoval=true) public interface LegacyTokenTypeMapper
Deprecated, for removal: This API element is subject to removal in a future version.
Temporary bridge for reading Axon Framework 4 token stores after upgrading. Scheduled for removal in 5.5.0, once existing stores have migrated to the Axon Framework 5 token class names.
Internal hook for Axon Framework modules that ship their own TrackingToken, so they can register that token's Axon Framework 4 to Axon Framework 5 class name mapping with LegacyTokenTypes. This keeps a token store written by Axon Framework 4 readable after upgrading.

This is not an application extension point. It exists only so framework modules can add their own tokens to the migration mapping. The token stores discover the implementations with ServiceLoader, registered in a META-INF/services/org.axonframework.messaging.eventhandling.processing.streaming.token.store.LegacyTokenTypeMapper file.

Marked Internal for the same reason as LegacyTokenTypes. It is a migration bridge, and the set of mapped names may change between releases.

Since:
5.2.0
Author:
Laura Devriendt

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Class<? extends TrackingToken>>
    mappings()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns Axon Framework 4 token class names mapped to their current Axon Framework 5 classes, keyed by the fully qualified class name as stored in the token type column.

  • Method Details

    • mappings

      Map<String,Class<? extends TrackingToken>> mappings()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns Axon Framework 4 token class names mapped to their current Axon Framework 5 classes, keyed by the fully qualified class name as stored in the token type column. Must not return null. If a key is already mapped by Axon Framework, the built-in mapping is kept and the contributed one is ignored.
      Returns:
      the Axon Framework 4 token class names mapped to their current Axon Framework 5 classes, never null