Package org.axonframework.modelling.entity.annotation

Class AnnotatedEntityIdResolver<ID>

java.lang.Object

org.axonframework.modelling.entity.annotation.AnnotatedEntityIdResolver<ID>

Type Parameters:

ID - The type of the identifier to resolve.

All Implemented Interfaces:

DescribableComponent, EntityIdResolver<ID>

public class AnnotatedEntityIdResolver<ID>
extends Object
implements EntityIdResolver<ID>, DescribableComponent

Implementation of the EntityIdResolver that converts the payload through the configured MessageConverter then takes the expected representation of the message handler from the AnnotatedEntityMetamodel.

It will then use the delegate EntityIdResolver to resolve the id, defaulting to the AnnotationBasedEntityIdResolver.

Since:

5.0.0

Author:

Mitchell Herrijgers

Constructor Summary

Constructors

Constructor	Description
AnnotatedEntityIdResolver(AnnotatedEntityMetamodel<?> metamodel, Class<ID> idType, MessageConverter converter, EntityIdResolver<ID> delegate)	Constructs an AnnotatedEntityMetamodelEntityIdResolver for the provided AnnotatedEntityMetamodel.

Method Summary

Modifier and Type	Method	Description
void	describeTo(ComponentDescriptor descriptor)	Describe the properties of this DescribableComponent with the given descriptor.
ID	resolve(Message message, ProcessingContext context)	Resolve the id of the entity from the given message and context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AnnotatedEntityIdResolver

public AnnotatedEntityIdResolver(@Nonnull
 AnnotatedEntityMetamodel<?> metamodel,
 @Nonnull
 Class<ID> idType,
 @Nonnull
 MessageConverter converter,
 @Nonnull
 EntityIdResolver<ID> delegate)

Constructs an AnnotatedEntityMetamodelEntityIdResolver for the provided AnnotatedEntityMetamodel.

Parameters:

metamodel - The metamodel that dictates the expected representation of the message.

idType - The type of the id that will be resolved.

converter - The MessageConverter to use.

delegate - The EntityIdResolver to use on the message after conversion.

Method Details

resolve

@Nonnull
public ID resolve(@Nonnull
 Message message,
 @Nonnull
 ProcessingContext context)
           throws EntityIdResolutionException

Description copied from interface: EntityIdResolver

Resolve the id of the entity from the given message and context.

Specified by:

resolve in interface EntityIdResolver<ID>

Parameters:

message - The message to resolve the id from.

context - The context in which the message is processed.

Returns:

The id of the entity.

Throws:

EntityIdResolutionException - When the id could not be resolved.

describeTo

public void describeTo(@Nonnull
 ComponentDescriptor descriptor)

Description copied from interface: DescribableComponent

Describe the properties of this DescribableComponent with the given descriptor.

Components should call the appropriate describeProperty methods on the descriptor to register their properties. The descriptor is responsible for determining how these properties are formatted and structured in the final output.

Best Practices: As a general rule, all relevant fields of a DescribableComponent implementation should be described in this method. However, developers have discretion to include only the fields that make sense in the context. Not every field may be meaningful for description purposes, especially internal implementation details. Furthermore, components might want to expose different information based on their current state. The final decision on what properties to include lies with the person implementing the describeTo method, who should focus on providing information that is useful for understanding the component's configuration and state.

Example implementation:

 public void describeTo(ComponentDescriptor descriptor) {
     descriptor.describeProperty("name", this.name);
     descriptor.describeProperty("enabled", this.enabled);
     descriptor.describeProperty("configuration", this.configuration); // A nested component
     descriptor.describeProperty("handlers", this.eventHandlers);      // A collection
 }
 

Specified by:

describeTo in interface DescribableComponent

Parameters:

descriptor - The component descriptor to describe this DescribableComponentn its properties in.