Package org.axonframework.modelling

Class PropertyBasedEntityIdResolver

java.lang.Object

org.axonframework.modelling.PropertyBasedEntityIdResolver

All Implemented Interfaces:

EntityIdResolver<Object>

public class PropertyBasedEntityIdResolver
extends Object
implements EntityIdResolver<Object>

Implementation of a EntityIdResolver that inspects the payload of a Message for an identifier.

The identifier is resolved by looking for a field or method with the given property name. Methods will automatically be resolved by looking for a method with the name get<Property> or <Property>.

This field or method needs to have or return a non-null value. If a null value is found, a EntityIdResolutionException is thrown. If no member is found at all, a TargetEntityIdMemberMismatchException is thrown.

Since:

5.0.0

Author:

Mitchell Herrijgers

Constructor Summary

Constructors

Constructor	Description
PropertyBasedEntityIdResolver(String property)	Initialize the resolver with the given property name.

Method Summary

Modifier and Type	Method	Description
Object	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

PropertyBasedEntityIdResolver

public PropertyBasedEntityIdResolver(@Nonnull
 String property)

Initialize the resolver with the given property name.

Parameters:

property - The name of the property to resolve the identifier from.

Method Details

resolve

@Nonnull
public Object 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<Object>

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.