ReplayToken (Axon Framework 4.11.1 API)

java.lang.Object
- org.axonframework.eventhandling.ReplayToken

All Implemented Interfaces:

Serializable, TrackingToken, WrappedToken
```
public class ReplayToken
extends Object
implements TrackingToken, WrappedToken, Serializable
```
Token keeping track of the position before a reset was triggered. This allows for downstream components to detect messages that are redelivered as part of a replay.

Since:

3.2

Author:

Allard Buijze

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`ReplayToken(TrackingToken tokenAtReset)` Deprecated. Use the `createReplayToken(TrackingToken)` method instead.
`ReplayToken(TrackingToken tokenAtReset, TrackingToken newRedeliveryToken)` Deprecated. Use the `createReplayToken(TrackingToken, TrackingToken)` method instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TrackingToken`	`advancedTo(TrackingToken newToken)` Advance this token to the given `newToken`.
`Object`	`context()` Returns the context that was provided when the token was reset.
`boolean`	`covers(TrackingToken other)` Indicates whether this token covers the `other` token completely.
`static TrackingToken`	`createReplayToken(TrackingToken tokenAtReset)` Creates a new TrackingToken that represents the tail of the stream.
`static TrackingToken`	`createReplayToken(TrackingToken tokenAtReset, TrackingToken startPosition)` Creates a new TrackingToken that represents the given `startPosition` of a stream.
`static TrackingToken`	`createReplayToken(TrackingToken tokenAtReset, TrackingToken startPosition, Object resetContext)` Creates a new TrackingToken that represents the given `startPosition` of a stream.
`boolean`	`equals(Object o)`
`TrackingToken`	`getCurrentToken()` Gets the current token.
`TrackingToken`	`getTokenAtReset()` Gets the token representing the position at which the reset was triggered.
`static OptionalLong`	`getTokenAtReset(TrackingToken trackingToken)` Return the relative position at which a reset was triggered for this Segment.
`int`	`hashCode()`
`static boolean`	`isReplay(Message<?> message)` Indicates whether the given message is "redelivered", as a result of a previous reset.
`static boolean`	`isReplay(TrackingToken trackingToken)` Indicates whether the given `trackingToken` represents a position that is part of a replay.
`TrackingToken`	`lowerBound()` Returns the token representing the current position in the stream.
`TrackingToken`	`lowerBound(TrackingToken other)` Returns a token that represents the lower bound between this and the `other` token.
`OptionalLong`	`position()` Return the estimated relative position this token represents.
`static <T> Optional<T>`	`replayContext(EventMessage<?> message, Class<T> contextClass)` Extracts the context from a `message` of the matching `contextClass`.
`static <T> Optional<T>`	`replayContext(TrackingToken trackingToken, Class<T> contextClass)` Extracts the context from a `message` of the matching `contextClass`.
`String`	`toString()`
`<R extends TrackingToken> Optional<R>`	`unwrap(Class<R> tokenType)` Retrieve a token of given `tokenType` if it is wrapped by this token.
`TrackingToken`	`upperBound()` Returns the token representing the furthest position in the stream described by this token.
`TrackingToken`	`upperBound(TrackingToken other)` Returns the token that represents the furthest possible position in a stream that either this token or the given `other` represents.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.axonframework.eventhandling.WrappedToken
advance, unwrap, unwrapLowerBound, unwrapUpperBound

- Constructor Detail
  - ReplayToken
```
@Deprecated
public ReplayToken(TrackingToken tokenAtReset)
```
    Deprecated. Use the createReplayToken(TrackingToken) method instead.
    
    Initialize a ReplayToken, using the given tokenAtReset to represent the position at which a reset was triggered. The current token is reset to the initial position.
    Using the createReplayToken(TrackingToken) is preferred, as it executes sanity checks on the parameters.
    
    Parameters:
    
    tokenAtReset - The token representing the position at which the reset was triggered.
  - ReplayToken
```
@Deprecated
public ReplayToken(TrackingToken tokenAtReset,
                               TrackingToken newRedeliveryToken)
```
    Deprecated. Use the createReplayToken(TrackingToken, TrackingToken) method instead.
    
    Initializes a ReplayToken with tokenAtReset which represents the position at which a reset was triggered and the newRedeliveryToken which represents current token.
    Using the createReplayToken(TrackingToken, TrackingToken) is preferred, as it executes sanity checks on the parameters.
    
    Parameters:
    
    tokenAtReset - The token representing the position at which the reset was triggered
    
    newRedeliveryToken - The current token
- Method Detail
  - isReplay
```
public static boolean isReplay(Message<?> message)
```
    Indicates whether the given message is "redelivered", as a result of a previous reset. If true, this means this message has been delivered to this processor before its token was reset.
    
    Parameters:
    
    message - The message to inspect
    
    Returns:
    
    true if the message is a replay
  - createReplayToken
```
public static TrackingToken createReplayToken(TrackingToken tokenAtReset,
                                              @Nullable
                                              TrackingToken startPosition)
```
    Creates a new TrackingToken that represents the given startPosition of a stream. It will be in replay state until the position of the provided tokenAtReset. After that, the tokenAtReset will become the active token and the stream will no longer be considered as replaying.
    
    Parameters:
    
    tokenAtReset - The token present when the reset was triggered
    
    startPosition - The position where the token should be reset to and start replaying from
    
    Returns:
    
    A token that represents a reset to the startPosition until the provided tokenAtReset
  - createReplayToken
```
public static TrackingToken createReplayToken(TrackingToken tokenAtReset,
                                              TrackingToken startPosition,
                                              Object resetContext)
```
    Creates a new TrackingToken that represents the given startPosition of a stream. It will be in replay state until the position of the provided tokenAtReset. After that, the tokenAtReset will become the active token and the stream will no longer be considered as replaying.
    
    Parameters:
    
    tokenAtReset - The token present when the reset was triggered
    
    startPosition - The position where the token should be reset to and start replaying from
    
    resetContext - The context given to the reset, may be null
    
    Returns:
    
    A token that represents a reset to the startPosition until the provided tokenAtReset
  - createReplayToken
```
public static TrackingToken createReplayToken(TrackingToken tokenAtReset)
```
    Creates a new TrackingToken that represents the tail of the stream. It will be in replay state until the position of the provided tokenAtReset. After that, the tokenAtReset will become the active token and the stream will no longer be considered as replaying.
    
    Parameters:
    
    tokenAtReset - The token present when the reset was triggered
    
    Returns:
    
    A token that represents a reset to the tail of the stream
  - replayContext
```
public static <T> Optional<T> replayContext(EventMessage<?> message,
                                            @Nonnull
                                            Class<T> contextClass)
```
    Extracts the context from a message of the matching contextClass.
    Will resolve to an empty Optional if the provided message is not a TrackedEventMessage, doesn't contain a ReplayToken, or the context isn't an instance of the provided contextClass, or there is no context at all.
    
    Type Parameters:
    
    T - The type of the context
    
    Parameters:
    
    message - The message to extract the context from
    
    contextClass - The class the context should match
    
    Returns:
    
    The context, if present in the message
  - isReplay
```
public static boolean isReplay(TrackingToken trackingToken)
```
    Indicates whether the given trackingToken represents a position that is part of a replay.
    
    Parameters:
    
    trackingToken - The token to verify
    
    Returns:
    
    true if the token indicates a replay
  - replayContext
```
public static <T> Optional<T> replayContext(TrackingToken trackingToken,
                                            @Nonnull
                                            Class<T> contextClass)
```
    Extracts the context from a message of the matching contextClass.
    Will resolve to an empty Optional if the provided token is not a ReplayToken, or the context isn't an instance of the provided contextClass, or there is no context at all.
    
    Type Parameters:
    
    T - The type of the context
    
    Parameters:
    
    trackingToken - The tracking token to extract the context from
    
    contextClass - The class the context should match
    
    Returns:
    
    The context, if present in the token
  - getTokenAtReset
```
public static OptionalLong getTokenAtReset(TrackingToken trackingToken)
```
    Return the relative position at which a reset was triggered for this Segment. In case a replay finished or no replay is active, an OptionalLong.empty() will be returned.
    
    Returns:
    
    the relative position at which a reset was triggered for this token
  - getTokenAtReset
```
public TrackingToken getTokenAtReset()
```
    Gets the token representing the position at which the reset was triggered.
    
    Returns:
    
    the token representing the position at which the reset was triggered
  - getCurrentToken
```
public TrackingToken getCurrentToken()
```
    Gets the current token.
    
    Returns:
    
    the current token
  - advancedTo
```
public TrackingToken advancedTo(TrackingToken newToken)
```
    Description copied from interface: WrappedToken
    
    Advance this token to the given newToken.
    
    Specified by:
    
    advancedTo in interface WrappedToken
    
    Parameters:
    
    newToken - The token representing the position to advance to
    
    Returns:
    
    a token representing the new position
  - lowerBound
```
public TrackingToken lowerBound(TrackingToken other)
```
    Description copied from interface: TrackingToken
    
    Returns a token that represents the lower bound between this and the other token. Effectively, the returned token will cause messages not received by both this and the other token to be redelivered.
    
    Specified by:
    
    lowerBound in interface TrackingToken
    
    Parameters:
    
    other - The token to compare to this one
    
    Returns:
    
    The token representing the lower bound of the two
  - upperBound
```
public TrackingToken upperBound(TrackingToken other)
```
    Description copied from interface: TrackingToken
    
    Returns the token that represents the furthest possible position in a stream that either this token or the given other represents. Effectively, this means this token will only deliver messages that neither this, nor the other have been received.
    
    Specified by:
    
    upperBound in interface TrackingToken
    
    Parameters:
    
    other - The token to compare this token to
    
    Returns:
    
    a token that represents the furthest position of this or the other stream
  - covers
```
public boolean covers(TrackingToken other)
```
    Description copied from interface: TrackingToken
    
    Indicates whether this token covers the other token completely. That means that this token represents a position in a stream that has received all of the messages that a stream represented by the other token has received.
    Note that this operation is only safe when comparing tokens obtained from messages from the same StreamableMessageSource.
    
    Specified by:
    
    covers in interface TrackingToken
    
    Parameters:
    
    other - The token to compare to this one
    
    Returns:
    
    true if this token covers the other, otherwise false
  - lowerBound
```
public TrackingToken lowerBound()
```
    Description copied from interface: WrappedToken
    
    Returns the token representing the current position in the stream.
    
    Specified by:
    
    lowerBound in interface WrappedToken
    
    Returns:
    
    the token representing the current position in the stream
  - upperBound
```
public TrackingToken upperBound()
```
    Description copied from interface: WrappedToken
    
    Returns the token representing the furthest position in the stream described by this token. This is usually a position that has been (partially) processed before.
    
    Specified by:
    
    upperBound in interface WrappedToken
    
    Returns:
    
    the token representing the furthest position reached in the stream
  - unwrap
```
public <R extends TrackingToken> Optional<R> unwrap(Class<R> tokenType)
```
    Description copied from interface: WrappedToken
    
    Retrieve a token of given tokenType if it is wrapped by this token.
    
    Specified by:
    
    unwrap in interface WrappedToken
    
    Type Parameters:
    
    R - The generic type of the token to unwrap to
    
    Parameters:
    
    tokenType - The type of token to unwrap to
    
    Returns:
    
    an optional with the unwrapped token, if found
  - context
```
@Nullable
public Object context()
```
    Returns the context that was provided when the token was reset.
    
    Returns:
    
    The context, null if none was provided during reset.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - position
```
public OptionalLong position()
```
    Description copied from interface: TrackingToken
    
    Return the estimated relative position this token represents. In case no estimation can be given an OptionalLong.empty() will be returned.
    
    Specified by:
    
    position in interface TrackingToken
    
    Returns:
    
    the estimated relative position of this token

Class ReplayToken

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.axonframework.eventhandling.WrappedToken

Constructor Detail

ReplayToken

ReplayToken

Method Detail

isReplay

createReplayToken

createReplayToken

createReplayToken

replayContext

isReplay

replayContext

getTokenAtReset

getTokenAtReset

getCurrentToken

advancedTo

lowerBound

upperBound

covers

lowerBound

upperBound

unwrap

context

equals

hashCode

toString

position